javax.swing.text

Class StyleContext.NamedStyle

Enclosing Class:
StyleContext
Implemented Interfaces:
AttributeSet, MutableAttributeSet, Serializable, Style

public class StyleContext.NamedStyle
extends Object
implements Serializable, Style

See Also:
Serialized Form

Field Summary

protected ChangeEvent
changeEvent
protected EventListenerList
listenerList

Fields inherited from interface javax.swing.text.AttributeSet

NameAttribute, ResolveAttribute

Constructor Summary

NamedStyle()
The basic constructor.
NamedStyle(String name, Style parent)
NamedStyle(Style parent)

Method Summary

void
addAttribute(Object name, Object value)
Adds an attribute with the given name and value to the set.
void
addAttributes(AttributeSet attr)
Adds all the attributes from attributes to this set.
void
addChangeListener(ChangeListener l)
Adds a ChangeListener object to the style.
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 attrs)
Returns true of this AttributeSet contains all of the specified attributes.
AttributeSet
copyAttributes()
Creates and returns a copy of this AttributeSet.
extends EventListener> T[] getListeners(Class listenerType)
protected void
fireStateChanged()
Object
getAttribute(Object attrName)
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.
ChangeListener[]
getChangeListeners()
String
getName()
Returns the name of the style.
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.
void
removeAttribute(Object name)
Removes the attribute with the specified name, if this attribute is defined.
void
removeAttributes(Enumeration names)
Removes the attributes listed in names.
void
removeAttributes(AttributeSet attrs)
Removes attributes from this set if they are found in the given set.
void
removeChangeListener(ChangeListener l)
Removes a ChangeListener from to the style.
void
setName(String n)
void
setResolveParent(AttributeSet parent)
Sets the reolving parent for this set.
String
toString()
Convert this Object to a human-readable String.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

changeEvent

protected ChangeEvent changeEvent

listenerList

protected EventListenerList listenerList

Constructor Details

NamedStyle

public NamedStyle()
The basic constructor. Object is special, because it has no superclass, so there is no call to super().

NamedStyle

public NamedStyle(String name,
                  Style parent)

NamedStyle

public NamedStyle(Style parent)

Method Details

addAttribute

public void addAttribute(Object name,
                         Object value)
Adds an attribute with the given name and value to the set. If the set already contains an attribute with the given name, the attribute value is updated.
Specified by:
addAttribute in interface MutableAttributeSet
Parameters:
name - the attribute name (null not permitted).
value - the value (null not permitted).
Throws:
NullPointerException - if either argument is null.

addAttributes

public void addAttributes(AttributeSet attr)
Adds all the attributes from attributes to this set.
Specified by:
addAttributes in interface MutableAttributeSet
Parameters:
Throws:
NullPointerException - if attributes is null.

addChangeListener

public void addChangeListener(ChangeListener l)
Adds a ChangeListener object to the style.
Specified by:
addChangeListener in interface Style
Parameters:

containsAttribute

public boolean containsAttribute(Object name,
                                 Object value)
Returns true if this AttributeSet contains an attribute with the specified name and value, false otherwise.
Specified by:
containsAttribute in interface AttributeSet
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 attrs)
Returns true of this AttributeSet contains all of the specified attributes.
Specified by:
containsAttributes in interface AttributeSet
Parameters:
Returns:
true of this AttributeSet contains all of the specified attributes

copyAttributes

public AttributeSet copyAttributes()
Creates and returns a copy of this AttributeSet.
Specified by:
copyAttributes in interface AttributeSet
Returns:
a copy of this AttributeSet

extends EventListener> T[] getListeners

public extends EventListener> T[] getListeners(Class listenerType)

fireStateChanged

protected void fireStateChanged()

getAttribute

public Object getAttribute(Object attrName)
Returns the attribute with the specified key or null if no such attribute is defined in this AttributeSet and its resolving parents.
Specified by:
getAttribute in interface AttributeSet
Parameters:
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.
Specified by:
getAttributeCount in interface 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.
Specified by:
getAttributeNames in interface AttributeSet
Returns:
the names of the attributes that are stored in this AttributeSet

getChangeListeners

public ChangeListener[] getChangeListeners()

getName

public String getName()
Returns the name of the style.
Specified by:
getName in interface Style
Returns:
the name

getResolveParent

public AttributeSet getResolveParent()
Returns the resolving parent of this AttributeSet. If a key is not stored locally, then a AttributeSet.getAttribute(Object) request is resolved up in the resolving parent of this AttributeSet.
Specified by:
getResolveParent in interface 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.
Specified by:
isDefined in interface AttributeSet
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.
Specified by:
isEqual in interface AttributeSet
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

removeAttribute

public void removeAttribute(Object name)
Removes the attribute with the specified name, if this attribute is defined. This method will only remove an attribute from this set, not from the resolving parent.
Specified by:
removeAttribute in interface MutableAttributeSet
Parameters:
name - the attribute name (null not permitted).
Throws:
NullPointerException - if name is null.

removeAttributes

public void removeAttributes(Enumeration names)
Removes the attributes listed in names.
Specified by:
removeAttributes in interface MutableAttributeSet
Parameters:
names - the attribute names (null not permitted).
Throws:
NullPointerException - if names is null or contains any null values.

removeAttributes

public void removeAttributes(AttributeSet attrs)
Removes attributes from this set if they are found in the given set. Only attributes whose key AND value are removed. Removes attributes only from this set, not from the resolving parent. Since the resolving parent is stored as an attribute, if attributes has the same resolving parent as this set, the parent will be removed from this set.
Specified by:
removeAttributes in interface MutableAttributeSet
Parameters:

removeChangeListener

public void removeChangeListener(ChangeListener l)
Removes a ChangeListener from to the style.
Specified by:
removeChangeListener in interface Style
Parameters:

setName

public void setName(String n)

setResolveParent

public void setResolveParent(AttributeSet parent)
Sets the reolving parent for this set. When looking up an attribute, if it is not found in this set, then the resolving parent is also used for the lookup.
Specified by:
setResolveParent in interface MutableAttributeSet
Parameters:
parent - the parent attribute set (null not permitted).
Throws:
NullPointerException - if parent is null.

toString

public String toString()
Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() and such.

It is typical, but not required, to ensure that this method never completes abruptly with a RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

Overrides:
toString in interface Object
Returns:
the String representing this Object, which may be null

StyleContext.java -- Copyright (C) 2004 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.