javax.swing.text

Interface AttributeSet

Known Subinterfaces:
MutableAttributeSet, Style
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

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

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

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 Details

NameAttribute

public static final Object NameAttribute
Key of the attribute that is used to describe the name of an AttributeSet.

ResolveAttribute

public static final Object ResolveAttribute
Key of the attribute that is used to identify the resolving parent of an AttributeSet.

Method Details

containsAttribute

public 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

public 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

public AttributeSet copyAttributes()
Creates and returns a copy of this AttributeSet.
Returns:
a copy of this AttributeSet

getAttribute

public 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

public 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

public 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

public 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

public 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

public 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

AttributeSet.java -- Copyright (C) 2002, 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.