javax.swing.text

Interface MutableAttributeSet

All Superinterfaces:

AttributeSet

All Known Subinterfaces:

Style

All 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

Nested Class Summary

Nested classes/interfaces inherited from interface javax.swing.text.AttributeSet

AttributeSet.CharacterAttribute, AttributeSet.ColorAttribute, AttributeSet.FontAttribute, AttributeSet.ParagraphAttribute

Field Summary

Fields inherited from interface javax.swing.text.AttributeSet

NameAttribute, ResolveAttribute

Method Summary

Methods

Modifier and Type	Method and Description
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(AttributeSet attributes) Removes attributes from this set if they are found in the given set.
void	removeAttributes(Enumeration<?> names) Removes the attributes listed in names.
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 Detail

addAttribute

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

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

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

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

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

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.