javax.swing.text: public interface: AttributeSet

javax.swing.text
public interface: AttributeSet [javadoc | source]

All Known Implementing Classes:
BidiElement, TaggedAttributeSet, MockAttributeSet, ResolvedStyle, LeafElement, BidiRootElement, SimpleAttributeSet, SmallAttributeSet, ViewAttributeSet, Style, NamedStyle, MutableAttributeSet, MuxingAttributeSet, LargeConversionSet, EmptyAttributeSet, BranchElement, AbstractElement

A collection of unique attributes. This is a read-only, immutable interface. An attribute is basically a key and a value assigned to the key. The collection may represent something like a style run, a logical style, etc. These are generally used to describe features that will contribute to some graphical representation such as a font. The set of possible keys is unbounded and can be anything. Typically View implementations will respond to attribute definitions and render something to represent the attributes.

Attributes can potentially resolve in a hierarchy. If a key doesn't resolve locally, and a resolving parent exists, the key will be resolved through the parent.

Also see:

MutableAttributeSet

author: Timothy - Prinzing

Nested Class Summary:
public interface	AttributeSet.FontAttribute	This interface is the type signature that is expected to be present on any attribute key that contributes to the determination of what font to use to render some text. This is not considered to be a closed set, the definition can change across version of the platform and can be amended by additional user added entries that correspond to logical settings that are specific to some type of content.
public interface	AttributeSet.ColorAttribute	This interface is the type signature that is expected to be present on any attribute key that contributes to presentation of color.
public interface	AttributeSet.CharacterAttribute	This interface is the type signature that is expected to be present on any attribute key that contributes to character level presentation. This would be any attribute that applies to a so-called run of style.
public interface	AttributeSet.ParagraphAttribute	This interface is the type signature that is expected to be present on any attribute key that contributes to the paragraph level presentation.

Field Summary
public static final Object	NameAttribute	Attribute name used to name the collection of attributes.
public static final Object	ResolveAttribute	Attribute name used to identify the resolving parent set of attributes, if one is defined.

Method from javax.swing.text.AttributeSet Summary:
containsAttribute, containsAttributes, copyAttributes, getAttribute, getAttributeCount, getAttributeNames, getResolveParent, isDefined, isEqual

Method from javax.swing.text.AttributeSet Detail:
public boolean containsAttribute(Object name, Object value) Returns {@code true} if this set defines an attribute with the same name and an equal value. If such an attribute is not found locally, it is searched through in the resolving parent hierarchy.
public boolean containsAttributes(AttributeSet attributes) Returns {@code true} if this set defines all the attributes from the given set with equal values. If an attribute is not found locally, it is searched through in the resolving parent hierarchy.
public AttributeSet copyAttributes() Returns an attribute set that is guaranteed not to change over time.
public Object getAttribute(Object key) Fetches the value of the given attribute. If the value is not found locally, the search is continued upward through the resolving parent (if one exists) until the value is either found or there are no more parents. If the value is not found, null is returned.
public int getAttributeCount() Returns the number of attributes that are defined locally in this set. Attributes that are defined in the parent set are not included.
public Enumeration getAttributeNames() Returns an enumeration over the names of the attributes that are defined locally in the set. Names of attributes defined in the resolving parent, if any, are not included. The values of the `Enumeration` may be anything and are not constrained to a particular `Object` type. This method never returns {@code null}. For a set with no attributes, it returns an empty {@code Enumeration}.
public AttributeSet getResolveParent() Gets the resolving parent.
public boolean isDefined(Object attrName) Checks whether the named attribute has a value specified in the set without resolving through another attribute set.
public boolean isEqual(AttributeSet attr) Determines if the two attribute sets are equivalent.