All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface java.awt.swing.text.AttributeSet

public interface AttributeSet
extends Cloneable
A collection of unique attributes. This is a read-only, immutable interface. Attributes are basically name-value pairs that potentially resolve in a hierarchy. If a name doesn't resolve locally, and a resolving parent exists, the name will be resolved through the parent.

See Also:
MutableAttributeSet, AttributeCharacterIterator

Variable Index

o NameAttribute
Attribute name used to name the collection of attributes.
o Reserved
Reserved character used as the start of all well known attribute names.
o ResolveAttribute
Attribute name used to identifiy the resolving parent set of attributes, if one is defined.

Method Index

o containsAttribute(String, 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()
Copies an attribute set.
o getAttribute(String)
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(String)
Checks whether the named attribute has a value specified in the set without resolving through another attribute set.
o isEmpty()
Returns true if the set is empty.
o isEqual(AttributeSet)
Determines if the two attribute sets are equivalent.

Variables

o Reserved 
public static final String Reserved
Reserved character used as the start of all well known attribute names. The reserved character allows general attributes to be safely added without conflict with the well known attribute names.

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

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

Methods

o isEmpty 
public abstract boolean isEmpty()
Returns true if the set is empty.

Returns:
true if the set is empty else false
o getAttributeCount 
public abstract int getAttributeCount()
Returns the number of attributes contained in this set.

Returns:
the number of attributes
o isDefined 
public abstract boolean isDefined(String 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()
Copies an attribute set.

Returns:
a copy of the attribute set
o getAttribute 
public abstract Object getAttribute(String attrName)
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:
attrName - the name of the attribute
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(String name,
                                          Object value)
Returns true if this set contains this attribute with an equal value.

Parameters:
name - the 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
Submit a bug or feature