All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.sun.java.swing.text.AttributeSet

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, AttributeCharacterIterator

Variable Index

o NameAttribute
Attribute name used to name the collection of attributes.
o ResolveAttribute
Attribute name used to identifiy the resolving parent set of attributes, if one is defined.

Method Index

o containsAttribute(Object, Object)
Returns true if this set contains this attribute with an equal value.
o containsAttributes(AttributeSet)
Returns true if this set contains all the attributes with equal values.
o copyAttributes()
Returns an attribute set that is guaranteed not to change over time.
o getAttribute(Object)
Fetches the value of the given attribute.
o getAttributeCount()
Returns the number of attributes contained in this set.
o getAttributeNames()
Returns an enumeration over the names of the attributes in the set.
o getResolveParent()
Gets the resolving parent.
o isDefined(Object)
Checks whether the named attribute has a value specified in the set without resolving through another attribute set.
o isEqual(AttributeSet)
Determines if the two attribute sets are equivalent.

Variables

o NameAttribute 
 public static final Object NameAttribute
Attribute name used to name the collection of attributes.

o ResolveAttribute 
 public static final Object ResolveAttribute
Attribute name used to identifiy the resolving parent set of attributes, if one is defined.

Methods

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

Returns:
the number of attributes >= 0
o isDefined 
 public abstract boolean isDefined(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
o isEqual 
 public abstract boolean isEqual(AttributeSet attr)
Determines if the two attribute sets are equivalent.

Parameters:
attr - an attribute set
Returns:
true if the sets are equivalent
o copyAttributes 
 public abstract AttributeSet copyAttributes()
Returns an attribute set that is guaranteed not to change over time.

Returns:
a copy of the attribute set
o getAttribute 
 public abstract 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.

Parameters:
key - the non-null key of the attribute binding
Returns:
the value
o getAttributeNames 
 public abstract Enumeration getAttributeNames()
Returns an enumeration over the names of the attributes in the set. The elements of the enumeration are all Strings. The set does not include the resolving parent, if one is defined.

Returns:
the names
o containsAttribute 
 public abstract boolean containsAttribute(Object name,
                                           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
o containsAttributes 
 public abstract boolean containsAttributes(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
o getResolveParent 
 public abstract AttributeSet getResolveParent()
Gets the resolving parent.

Returns:
the parent 
All Packages  Class Hierarchy  This Package  Previous  Next  Index