javax.swing.text

Interface AbstractDocument.AttributeContext

public interface AbstractDocument.AttributeContext

Defines a set of methods for managing text attributes for one or more Documents. Replicating {@link AttributeSet}s throughout a Document can be very expensive. Implementations of this interface are intended to provide intelligent management of AttributeSets, eliminating costly duplication.

See Also: StyleContext

Method Summary
AttributeSet	addAttribute(AttributeSet old, Object name, Object value) Returns an {@link AttributeSet} that contains the attributes of `old` plus the new attribute specified by `name` and `value`.
AttributeSet	addAttributes(AttributeSet old, AttributeSet attributes) Returns an {@link AttributeSet} that contains the attributes of `old` plus the new attributes in `attributes`.
AttributeSet	getEmptySet() Returns an empty {@link AttributeSet}.
void	reclaim(AttributeSet attributes) Called to indicate that the attributes in `attributes` are no longer used.
AttributeSet	removeAttribute(AttributeSet old, Object name) Returns a {@link AttributeSet} that has the attribute with the specified `name` removed from `old`.
AttributeSet	removeAttributes(AttributeSet old, AttributeSet attributes) Removes all attributes in `attributes` from `old` and returns the resulting `AttributeSet`.
AttributeSet	removeAttributes(AttributeSet old, Enumeration<?> names) Removes all attributes specified by `names` from `old` and returns the resulting `AttributeSet`.

Method Detail

addAttribute

public AttributeSet addAttribute(AttributeSet old, Object name, Object value)

Returns an {@link AttributeSet} that contains the attributes of old plus the new attribute specified by name and value.

Parameters: old the attribute set to be merged with the new attribute name the name of the attribute to be added value the value of the attribute to be added

Returns: the old attributes plus the new attribute

addAttributes

public AttributeSet addAttributes(AttributeSet old, AttributeSet attributes)

Returns an {@link AttributeSet} that contains the attributes of old plus the new attributes in attributes.

Parameters: old the set of attributes where to add the new attributes attributes the attributes to be added

Returns: an {@link AttributeSet} that contains the attributes of old plus the new attributes in attributes

getEmptySet

public AttributeSet getEmptySet()

Returns an empty {@link AttributeSet}.

Returns: an empty {@link AttributeSet}

reclaim

public void reclaim(AttributeSet attributes)

Called to indicate that the attributes in attributes are no longer used.

Parameters: attributes the attributes are no longer used

removeAttribute

public AttributeSet removeAttribute(AttributeSet old, Object name)

Returns a {@link AttributeSet} that has the attribute with the specified name removed from old.

Parameters: old the attribute set from which an attribute is removed name the name of the attribute to be removed

Returns: the attributes of old minus the attribute specified by name

removeAttributes

public AttributeSet removeAttributes(AttributeSet old, AttributeSet attributes)

Removes all attributes in attributes from old and returns the resulting AttributeSet.

Parameters: old the set of attributes from which to remove attributes attributes the attributes to be removed from old

Returns: the attributes of old minus the attributes in attributes

removeAttributes

public AttributeSet removeAttributes(AttributeSet old, Enumeration<?> names)

Removes all attributes specified by names from old and returns the resulting AttributeSet.

Parameters: old the set of attributes from which to remove attributes names the names of the attributes to be removed from old

Returns: the attributes of old minus the attributes in attributes