javax.swing.text

Interface MutableAttributeSet

All Superinterfaces:
AttributeSet
Known Subinterfaces:
Style
Known Implementing Classes:
AbstractDocument.AbstractElement, AbstractDocument.BranchElement, AbstractDocument.LeafElement, DefaultStyledDocument.SectionElement, HTMLDocument.BlockElement, HTMLDocument.RunElement, SimpleAttributeSet, StyleContext.NamedStyle

public interface MutableAttributeSet
extends AttributeSet

An AttributeSet that supports modification of the stored attributes.
Since:
1.2

Fields inherited from interface javax.swing.text.AttributeSet

NameAttribute, ResolveAttribute

Method Summary

void
addAttribute(Object name, Object value)
Adds an attribute with the given name and value to the set.
void
addAttributes(AttributeSet attributes)
Adds all the attributes from attributes to this set.
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 attributes)
Removes attributes from this set if they are found in the given set.
void
setResolveParent(AttributeSet parent)
Sets the reolving parent for this set.

Methods inherited from interface javax.swing.text.AttributeSet

containsAttribute, containsAttributes, copyAttributes, getAttribute, getAttributeCount, getAttributeNames, getResolveParent, isDefined, isEqual

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.
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 attributes)
Adds all the attributes from attributes to this set.
Parameters:
attributes - the set of attributes to add (null not permitted).
Throws:
NullPointerException - if attributes is null.

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.
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.
Parameters:
names - the attribute names (null not permitted).
Throws:
NullPointerException - if names is null or contains any null values.

removeAttributes

public void removeAttributes(AttributeSet attributes)
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.
Parameters:
attributes - the attributes (null not permitted).

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.
Parameters:
parent - the parent attribute set (null not permitted).
Throws:
NullPointerException - if parent is null.

MutableAttributeSet.java -- Copyright (C) 2002, 2004, 2006 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.