com.salesforce.omakase.ast.atrule

Class FontDescriptor

java.lang.Object

com.salesforce.omakase.ast.AbstractSyntax

com.salesforce.omakase.ast.collection.AbstractGroupable<FontFaceBlock,FontDescriptor>

com.salesforce.omakase.ast.atrule.FontDescriptor

All Implemented Interfaces:

Groupable<FontFaceBlock,FontDescriptor>, Named, Syntax, Broadcastable, Writable

public final class FontDescriptor
extends AbstractGroupable<FontFaceBlock,FontDescriptor>
implements Named

Represents one of the FontFaceBlock font-descriptors (src, font-weight, font-style, etc...).

See Also:

FontFaceBlock, FontFacePlugin

Constructor Summary

Constructors

Constructor and Description
FontDescriptor(Declaration source) Creates a new FontDescriptor instance using the given Declarations PropertyName and PropertyValue, as well as comments.
FontDescriptor(PropertyName propertyName, PropertyValue propertyValue) Creates a new FontDescriptor instance with the given property name and value.

Method Summary

Modifier and Type	Method and Description
FontDescriptor	copy() For implementations: do not copy comments or orphaned comments, instead be sure to call AbstractSyntax.copiedFrom(Syntax) on the new copy.
boolean	isProperty(Property property) Gets whether this FontDescriptor has the given Property name.
boolean	isProperty(String property) Gets whether this FontDescriptor has the given property name.
boolean	isWritable() Returns whether this unit should actually be written.
String	name() Gets the name of this object.
void	propagateBroadcast(Broadcaster broadcaster, Status status) Broadcasts or rebroadcasts all child units using the given Broadcaster.
PropertyName	propertyName() Gets the property name.
PropertyValue	propertyValue() Gets the property value.
FontDescriptor	propertyValue(PropertyValue propertyValue) Sets a new property value.
FontDescriptor	propertyValue(Term singleTerm) Sets a new property value.
protected FontDescriptor	self() Should return "this".
void	write(StyleWriter writer, StyleAppendable appendable) Outputs this Writable's string representation.
boolean	writesOwnComments() Specifies whether this object will handle writing its own comments, instead of the automatic behavior of the StyleWriter.

Methods inherited from class com.salesforce.omakase.ast.collection.AbstractGroupable

append, destroy, group, group, isDestroyed, isFirst, isLast, next, parent, prepend, previous, replaceWith, unlink

Methods inherited from class com.salesforce.omakase.ast.AbstractSyntax

annotate, annotateUnlessPresent, annotation, annotations, column, comment, comment, comments, comments, comments, copiedFrom, equals, hasAnnotation, hasAnnotation, hashCode, hasSourcePosition, id, line, orphanedComments, orphanedComments, orphanedComments, shouldBreakBroadcast, status, status, toString, toString, writesOwnOrphanedComments

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.salesforce.omakase.ast.Syntax

annotate, annotateUnlessPresent, annotation, annotations, column, comment, comment, comments, comments, comments, hasAnnotation, hasAnnotation, hasSourcePosition, id, line, orphanedComments, orphanedComments, orphanedComments, toString, writesOwnOrphanedComments

Methods inherited from interface com.salesforce.omakase.broadcast.Broadcastable

shouldBreakBroadcast, status, status

Constructor Detail

FontDescriptor

public FontDescriptor(PropertyName propertyName,
                      PropertyValue propertyValue)

Creates a new FontDescriptor instance with the given property name and value.

Parameters:

propertyName - The name of this font-descriptor.

propertyValue - The value of this font-descriptor.

FontDescriptor

public FontDescriptor(Declaration source)

Creates a new FontDescriptor instance using the given Declarations PropertyName and PropertyValue, as well as comments.

Note that this will result in refinement of the Declaration if not already done so.

Parameters:

source - The source Declaration

Method Detail

propertyName

public PropertyName propertyName()

Gets the property name.

Returns:

The property name.

isProperty

public boolean isProperty(String property)

Gets whether this FontDescriptor has the given property name. Prefer to use isProperty(Property) instead.

Example:

 if (descriptor.isProperty("font-family") {...}
 

Parameters:

property - Name of the property.

Returns:

True if this FontDescriptor has the given property name.

isProperty

public boolean isProperty(Property property)

Gets whether this FontDescriptor has the given Property name.

Example:

 if (descriptor.isProperty(Property.FONT_FAMILY)) {...}
 

Parameters:

property - The Property.

Returns:

True of this FontDescriptor has the given property name.

name

public String name()

Description copied from interface: Named

Gets the name of this object.

Specified by:

name in interface Named

Returns:

The name.

propertyValue

public FontDescriptor propertyValue(Term singleTerm)

Sets a new property value.

Parameters:

singleTerm - The single Term.

Returns:

this, for chaining.

propertyValue

public FontDescriptor propertyValue(PropertyValue propertyValue)

Sets a new property value.

Parameters:

propertyValue - The new property value.

Returns:

this, for chaining.

propertyValue

public PropertyValue propertyValue()

Gets the property value.

Returns:

The property value.

propagateBroadcast

public void propagateBroadcast(Broadcaster broadcaster,
                               Status status)

Description copied from interface: Broadcastable

Broadcasts or rebroadcasts all child units using the given Broadcaster.

The broadcast will only occur for a unit if its Status matches the given Status.

Implementers should call this on child units and SyntaxCollections first, then use the broadcaster to broadcast itself. All of this should be wrapped in a check to ensure the Status matches.

Specified by:

propagateBroadcast in interface Broadcastable

Overrides:

propagateBroadcast in class AbstractSyntax

Parameters:

broadcaster - Use this Broadcaster to broadcast all unbroadcasted child units.

status - Broadcast units that have this status.

self

protected FontDescriptor self()

Description copied from class: AbstractGroupable

Should return "this". This is needed for property type access in the AbstractGroupable class.

Specified by:

self in class AbstractGroupable<FontFaceBlock,FontDescriptor>

Returns:

"this".

writesOwnComments

public boolean writesOwnComments()

Description copied from interface: Syntax

Specifies whether this object will handle writing its own comments, instead of the automatic behavior of the StyleWriter.

If returning true, be sure to check StyleWriter#shouldWriteAllComments() to determine if comments should actually be written out or not. The StyleWriter#appendComments(Iterable, StyleAppendable) utility method contains this logic and is the preferable way to handle it.

Specified by:

writesOwnComments in interface Syntax

Overrides:

writesOwnComments in class AbstractSyntax

Returns:

True if this object writes its own comments.

isWritable

public boolean isWritable()

Description copied from interface: Writable

Returns whether this unit should actually be written.

Usually this should just return true, however some units that are detachable or otherwise potentially invalid should first check their state and respond appropriately.

Specified by:

isWritable in interface Writable

Overrides:

isWritable in class AbstractGroupable<FontFaceBlock,FontDescriptor>

Returns:

True if the unit should be written.

write

public void write(StyleWriter writer,
                  StyleAppendable appendable)
           throws IOException

Description copied from interface: Writable

Outputs this Writable's string representation.

Important notes for implementation:

Do not use the StyleWriter in an attempt to write direct content (Strings, chars, etc...). Use the StyleAppendable.

The StyleWriter should be used to make decisions based on writer settings (e.g., compressed vs. verbose output mode), as well as for writing inner or child Writables. Do not call the this method method directly on inner or child Writables! That would bypass any overrides that are set on the StyleWriter. Use StyleWriter.writeInner(Writable, StyleAppendable) instead.

Specified by:

write in interface Writable

Parameters:

writer - Writer to use for output settings and for writing inner Writables.

appendable - Append direct content to this StyleAppendable.

Throws:

IOException - If an I/O error occurs.

copy

public FontDescriptor copy()

Description copied from class: AbstractSyntax

For implementations: do not copy comments or orphaned comments, instead be sure to call AbstractSyntax.copiedFrom(Syntax) on the new copy.

Specified by:

copy in interface Syntax

Specified by:

copy in class AbstractSyntax

Returns:

The new instance.