javax.swing.text
Interface AttributeSet

All Known Subinterfaces:
MutableAttributeSet sample code for javax.swing.text.MutableAttributeSet definition code for javax.swing.text.MutableAttributeSet , Style sample code for javax.swing.text.Style definition code for javax.swing.text.Style
All Known Implementing Classes:
AbstractDocument.AbstractElement sample code for javax.swing.text.AbstractDocument.AbstractElement definition code for javax.swing.text.AbstractDocument.AbstractElement , AbstractDocument.BranchElement sample code for javax.swing.text.AbstractDocument.BranchElement definition code for javax.swing.text.AbstractDocument.BranchElement , AbstractDocument.LeafElement sample code for javax.swing.text.AbstractDocument.LeafElement definition code for javax.swing.text.AbstractDocument.LeafElement , DefaultStyledDocument.SectionElement sample code for javax.swing.text.DefaultStyledDocument.SectionElement definition code for javax.swing.text.DefaultStyledDocument.SectionElement , HTMLDocument.BlockElement sample code for javax.swing.text.html.HTMLDocument.BlockElement definition code for javax.swing.text.html.HTMLDocument.BlockElement , HTMLDocument.RunElement sample code for javax.swing.text.html.HTMLDocument.RunElement definition code for javax.swing.text.html.HTMLDocument.RunElement , SimpleAttributeSet sample code for javax.swing.text.SimpleAttributeSet definition code for javax.swing.text.SimpleAttributeSet , StyleContext.NamedStyle sample code for javax.swing.text.StyleContext.NamedStyle definition code for javax.swing.text.StyleContext.NamedStyle , StyleContext.SmallAttributeSet sample code for javax.swing.text.StyleContext.SmallAttributeSet definition code for javax.swing.text.StyleContext.SmallAttributeSet

public interface AttributeSet

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.

See Also:
MutableAttributeSet sample code for javax.swing.text.MutableAttributeSet definition code for javax.swing.text.MutableAttributeSet

Nested Class Summary
static interface AttributeSet.CharacterAttribute sample code for javax.swing.text.AttributeSet.CharacterAttribute definition code for javax.swing.text.AttributeSet.CharacterAttribute
          This interface is the type signature that is expected to be present on any attribute key that contributes to character level presentation.
static interface AttributeSet.ColorAttribute sample code for javax.swing.text.AttributeSet.ColorAttribute definition code for javax.swing.text.AttributeSet.ColorAttribute
          This interface is the type signature that is expected to be present on any attribute key that contributes to presentation of color.
static interface AttributeSet.FontAttribute sample code for javax.swing.text.AttributeSet.FontAttribute definition code for javax.swing.text.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.
static interface AttributeSet.ParagraphAttribute sample code for javax.swing.text.AttributeSet.ParagraphAttribute definition code for javax.swing.text.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
static Object sample code for java.lang.Object definition code for java.lang.Object NameAttribute sample code for javax.swing.text.AttributeSet.NameAttribute definition code for javax.swing.text.AttributeSet.NameAttribute
          Attribute name used to name the collection of attributes.
static Object sample code for java.lang.Object definition code for java.lang.Object ResolveAttribute sample code for javax.swing.text.AttributeSet.ResolveAttribute definition code for javax.swing.text.AttributeSet.ResolveAttribute
          Attribute name used to identify the resolving parent set of attributes, if one is defined.
 
Method Summary
 boolean containsAttribute sample code for javax.swing.text.AttributeSet.containsAttribute(java.lang.Object, java.lang.Object) definition code for javax.swing.text.AttributeSet.containsAttribute(java.lang.Object, java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  name, Object sample code for java.lang.Object definition code for java.lang.Object  value)
          Returns true if this set contains this attribute with an equal value.
 boolean containsAttributes sample code for javax.swing.text.AttributeSet.containsAttributes(javax.swing.text.AttributeSet) definition code for javax.swing.text.AttributeSet.containsAttributes(javax.swing.text.AttributeSet) (AttributeSet sample code for javax.swing.text.AttributeSet definition code for javax.swing.text.AttributeSet  attributes)
          Returns true if this set contains all the attributes with equal values.
 AttributeSet sample code for javax.swing.text.AttributeSet definition code for javax.swing.text.AttributeSet copyAttributes sample code for javax.swing.text.AttributeSet.copyAttributes() definition code for javax.swing.text.AttributeSet.copyAttributes() ()
          Returns an attribute set that is guaranteed not to change over time.
 Object sample code for java.lang.Object definition code for java.lang.Object getAttribute sample code for javax.swing.text.AttributeSet.getAttribute(java.lang.Object) definition code for javax.swing.text.AttributeSet.getAttribute(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  key)
          Fetches the value of the given attribute.
 int getAttributeCount sample code for javax.swing.text.AttributeSet.getAttributeCount() definition code for javax.swing.text.AttributeSet.getAttributeCount() ()
          Returns the number of attributes contained in this set.
 Enumeration sample code for java.util.Enumeration definition code for java.util.Enumeration <?> getAttributeNames sample code for javax.swing.text.AttributeSet.getAttributeNames() definition code for javax.swing.text.AttributeSet.getAttributeNames() ()
          Returns an enumeration over the names of the attributes in the set.
 AttributeSet sample code for javax.swing.text.AttributeSet definition code for javax.swing.text.AttributeSet getResolveParent sample code for javax.swing.text.AttributeSet.getResolveParent() definition code for javax.swing.text.AttributeSet.getResolveParent() ()
          Gets the resolving parent.
 boolean isDefined sample code for javax.swing.text.AttributeSet.isDefined(java.lang.Object) definition code for javax.swing.text.AttributeSet.isDefined(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  attrName)
          Checks whether the named attribute has a value specified in the set without resolving through another attribute set.
 boolean isEqual sample code for javax.swing.text.AttributeSet.isEqual(javax.swing.text.AttributeSet) definition code for javax.swing.text.AttributeSet.isEqual(javax.swing.text.AttributeSet) (AttributeSet sample code for javax.swing.text.AttributeSet definition code for javax.swing.text.AttributeSet  attr)
          Determines if the two attribute sets are equivalent.
 

Field Detail

NameAttribute sample code for javax.swing.text.AttributeSet.NameAttribute

static final Object sample code for java.lang.Object definition code for java.lang.Object  NameAttribute
Attribute name used to name the collection of attributes.


ResolveAttribute sample code for javax.swing.text.AttributeSet.ResolveAttribute

static final Object sample code for java.lang.Object definition code for java.lang.Object  ResolveAttribute
Attribute name used to identify the resolving parent set of attributes, if one is defined.

Method Detail

getAttributeCount sample code for javax.swing.text.AttributeSet.getAttributeCount() definition code for javax.swing.text.AttributeSet.getAttributeCount()

int getAttributeCount()
Returns the number of attributes contained in this set.

Returns:
the number of attributes >= 0

isDefined sample code for javax.swing.text.AttributeSet.isDefined(java.lang.Object) definition code for javax.swing.text.AttributeSet.isDefined(java.lang.Object)

boolean isDefined(Object sample code for java.lang.Object definition code for java.lang.Object  attrName)
Checks whether the named attribute has a value specified in the set without resolving through another attribute set.

Parameters:
attrName - the attribute name
Returns:
true if the attribute has a value specified

isEqual sample code for javax.swing.text.AttributeSet.isEqual(javax.swing.text.AttributeSet) definition code for javax.swing.text.AttributeSet.isEqual(javax.swing.text.AttributeSet)

boolean isEqual(AttributeSet sample code for javax.swing.text.AttributeSet definition code for javax.swing.text.AttributeSet  attr)
Determines if the two attribute sets are equivalent.

Parameters:
attr - an attribute set
Returns:
true if the sets are equivalent

copyAttributes sample code for javax.swing.text.AttributeSet.copyAttributes() definition code for javax.swing.text.AttributeSet.copyAttributes()

AttributeSet sample code for javax.swing.text.AttributeSet definition code for javax.swing.text.AttributeSet  copyAttributes()
Returns an attribute set that is guaranteed not to change over time.

Returns:
a copy of the attribute set

getAttribute sample code for javax.swing.text.AttributeSet.getAttribute(java.lang.Object) definition code for javax.swing.text.AttributeSet.getAttribute(java.lang.Object)

Object sample code for java.lang.Object definition code for java.lang.Object  getAttribute(Object sample code for java.lang.Object definition code for java.lang.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.

Parameters:
key - the non-null key of the attribute binding
Returns:
the value

getAttributeNames sample code for javax.swing.text.AttributeSet.getAttributeNames() definition code for javax.swing.text.AttributeSet.getAttributeNames()

Enumeration sample code for java.util.Enumeration definition code for java.util.Enumeration <?> getAttributeNames()
Returns an enumeration over the names of the attributes in the set. The values of the Enumeration may be anything and are not constrained to a particular Object type. The set does not include the resolving parent, if one is defined.

Returns:
the names

containsAttribute sample code for javax.swing.text.AttributeSet.containsAttribute(java.lang.Object, java.lang.Object) definition code for javax.swing.text.AttributeSet.containsAttribute(java.lang.Object, java.lang.Object)

boolean containsAttribute(Object sample code for java.lang.Object definition code for java.lang.Object  name,
                          Object sample code for java.lang.Object definition code for java.lang.Object  value)
Returns true if this set contains this attribute with an equal value.

Parameters:
name - the non-null attribute name
value - the value
Returns:
true if the set contains the attribute with an equal value

containsAttributes sample code for javax.swing.text.AttributeSet.containsAttributes(javax.swing.text.AttributeSet) definition code for javax.swing.text.AttributeSet.containsAttributes(javax.swing.text.AttributeSet)

boolean containsAttributes(AttributeSet sample code for javax.swing.text.AttributeSet definition code for javax.swing.text.AttributeSet  attributes)
Returns true if this set contains all the attributes with equal values.

Parameters:
attributes - the set of attributes to check against
Returns:
true if this set contains all the attributes with equal values

getResolveParent sample code for javax.swing.text.AttributeSet.getResolveParent() definition code for javax.swing.text.AttributeSet.getResolveParent()

AttributeSet sample code for javax.swing.text.AttributeSet definition code for javax.swing.text.AttributeSet  getResolveParent()
Gets the resolving parent.

Returns:
the parent