javax.swing.text

Interface AttributeSet

All Known Subinterfaces:

MutableAttributeSet, Style

All Known Implementing Classes:

AbstractDocument.AbstractElement, AbstractDocument.BranchElement, AbstractDocument.LeafElement, DefaultStyledDocument.SectionElement, HTMLDocument.BlockElement, HTMLDocument.RunElement, SimpleAttributeSet, StyleContext.NamedStyle, StyleContext.SmallAttributeSet

public interface AttributeSet

A set of attributes. An attribute has a key and a value. They typically describe features of a piece of text that make up its graphical representation. An AttributeSet may have a resolving parent, that is another AttributeSet that is searched for attribute keys that are not stored locally in this AttributeSet.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AttributeSet.CharacterAttribute Used as keys to identify character-run attributes.
static interface	AttributeSet.ColorAttribute Used as keys to identify color attributes.
static interface	AttributeSet.FontAttribute Used as keys to identify font attributes.
static interface	AttributeSet.ParagraphAttribute Used as keys to identify paragraph level attributes.

Field Summary

Fields

Modifier and Type	Field and Description
static Object	NameAttribute Key of the attribute that is used to describe the name of an AttributeSet.
static Object	ResolveAttribute Key of the attribute that is used to identify the resolving parent of an AttributeSet.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsAttribute(Object name, Object value) Returns true if this AttributeSet contains an attribute with the specified name and value, false otherwise.
boolean	containsAttributes(AttributeSet attributes) Returns true of this AttributeSet contains all of the specified attributes.
AttributeSet	copyAttributes() Creates and returns a copy of this AttributeSet.
Object	getAttribute(Object key) Returns the attribute with the specified key or null if no such attribute is defined in this AttributeSet and its resolving parents.
int	getAttributeCount() Returns the number of attributes that are stored locally in this AttributeSet.
Enumeration<?>	getAttributeNames() Returns the names of the attributes that are stored in this AttributeSet.
AttributeSet	getResolveParent() Returns the resolving parent of this AttributeSet.
boolean	isDefined(Object attrName) Returns true if an attribute with the specified name is defined locally in this AttributeSet, without resolving through the resolving parents.
boolean	isEqual(AttributeSet attr) Returns true if all of the attributes in attr are equal to the attributes in this AttributeSet, false otherwise.

Field Detail

NameAttribute

static final Object NameAttribute

Key of the attribute that is used to describe the name of an AttributeSet.

ResolveAttribute

static final Object ResolveAttribute

Key of the attribute that is used to identify the resolving parent of an AttributeSet.

Method Detail

containsAttribute

boolean containsAttribute(Object name,
                        Object value)

Returns true if this AttributeSet contains an attribute with the specified name and value, false otherwise.

Parameters:

name - the name of the requested attribute

value - the value of the requested attribute

Returns:

true if this AttributeSet contains an attribute with the specified name and value, false otherwise

containsAttributes

boolean containsAttributes(AttributeSet attributes)

Returns true of this AttributeSet contains all of the specified attributes.

Parameters:

attributes - the requested attributes

Returns:

true of this AttributeSet contains all of the specified attributes

copyAttributes

AttributeSet copyAttributes()

Creates and returns a copy of this AttributeSet.

Returns:

a copy of this AttributeSet

getAttribute

Object getAttribute(Object key)

Returns the attribute with the specified key or null if no such attribute is defined in this AttributeSet and its resolving parents.

Parameters:

key - the key of the attribute that is looked up

Returns:

the attribute with the specified key or null if no such attribute is defined in this AttributeSet and its resolving parents

getAttributeCount

int getAttributeCount()

Returns the number of attributes that are stored locally in this AttributeSet.

Returns:

the number of attributes that are stored locally in this AttributeSet

getAttributeNames

Enumeration<?> getAttributeNames()

Returns the names of the attributes that are stored in this AttributeSet.

Returns:

the names of the attributes that are stored in this AttributeSet

getResolveParent

AttributeSet getResolveParent()

Returns the resolving parent of this AttributeSet. If a key is not stored locally, then a getAttribute(Object) request is resolved up in the resolving parent of this AttributeSet.

Returns:

the resolving parent of this AttributeSet

isDefined

boolean isDefined(Object attrName)

Returns true if an attribute with the specified name is defined locally in this AttributeSet, without resolving through the resolving parents.

Returns:

true if an attribute with the specified name is defined locally in this AttributeSet

isEqual

boolean isEqual(AttributeSet attr)

Returns true if all of the attributes in attr are equal to the attributes in this AttributeSet, false otherwise.

Parameters:

attr - the attributes to be compared to this

Returns:

true if all of the attributes in attr are equal to the attributes in this AttributeSet, false otherwise