AbstractDocument.AttributeContext (Java 2 Platform SE 5.0) (original) (raw)

javax.swing.text

Interface AbstractDocument.AttributeContext

All Known Implementing Classes:

Enclosing class:

public static interface AbstractDocument.AttributeContext

An interface that can be used to allow MutableAttributeSet implementations to use pluggable attribute compression techniques. Each mutation of the attribute set can be used to exchange a previous AttributeSet instance with another, preserving the possibility of the AttributeSet remaining immutable. An implementation is provided by the StyleContext class. The Element implementations provided by this class use this interface to provide their MutableAttributeSet implementations, so that different AttributeSet compression techniques can be employed. The method getAttributeContext should be implemented to return the object responsible for implementing the desired compression technique.

See Also:

StyleContext

Method Summary
AttributeSet	[addAttribute](../../../javax/swing/text/AbstractDocument.AttributeContext.html#addAttribute%28javax.swing.text.AttributeSet, java.lang.Object, java.lang.Object%29)(AttributeSet old,Object name,Object value) Adds an attribute to the given set, and returns the new representative set.
AttributeSet	[addAttributes](../../../javax/swing/text/AbstractDocument.AttributeContext.html#addAttributes%28javax.swing.text.AttributeSet, javax.swing.text.AttributeSet%29)(AttributeSet old,AttributeSet attr) Adds a set of attributes to the element.
AttributeSet	getEmptySet() Fetches an empty AttributeSet.
void	reclaim(AttributeSet a) Reclaims an attribute set.
AttributeSet	[removeAttribute](../../../javax/swing/text/AbstractDocument.AttributeContext.html#removeAttribute%28javax.swing.text.AttributeSet, java.lang.Object%29)(AttributeSet old,Object name) Removes an attribute from the set.
AttributeSet	[removeAttributes](../../../javax/swing/text/AbstractDocument.AttributeContext.html#removeAttributes%28javax.swing.text.AttributeSet, javax.swing.text.AttributeSet%29)(AttributeSet old,AttributeSet attrs) Removes a set of attributes for the element.
AttributeSet	[removeAttributes](../../../javax/swing/text/AbstractDocument.AttributeContext.html#removeAttributes%28javax.swing.text.AttributeSet, java.util.Enumeration%29)(AttributeSet old,Enumeration<?> names) Removes a set of attributes for the element.

Method Detail

addAttribute

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

Adds an attribute to the given set, and returns the new representative set.

Parameters:

old - the old attribute set

name - the non-null attribute name

value - the attribute value

Returns:

the updated attribute set

See Also:

[MutableAttributeSet.addAttribute(java.lang.Object, java.lang.Object)](../../../javax/swing/text/MutableAttributeSet.html#addAttribute%28java.lang.Object, java.lang.Object%29)

addAttributes

AttributeSet addAttributes(AttributeSet old, AttributeSet attr)

Adds a set of attributes to the element.

Parameters:

old - the old attribute set

attr - the attributes to add

Returns:

the updated attribute set

See Also:

[MutableAttributeSet.addAttribute(java.lang.Object, java.lang.Object)](../../../javax/swing/text/MutableAttributeSet.html#addAttribute%28java.lang.Object, java.lang.Object%29)

removeAttribute

AttributeSet removeAttribute(AttributeSet old, Object name)

Removes an attribute from the set.

Parameters:

old - the old attribute set

name - the non-null attribute name

Returns:

the updated attribute set

removeAttributes

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

Removes a set of attributes for the element.

Parameters:

old - the old attribute set

names - the attribute names

Returns:

the updated attribute set

removeAttributes

AttributeSet removeAttributes(AttributeSet old, AttributeSet attrs)

Removes a set of attributes for the element.

Parameters:

old - the old attribute set

attrs - the attributes

Returns:

the updated attribute set

getEmptySet

AttributeSet getEmptySet()

Fetches an empty AttributeSet.

Returns:

the attribute set

reclaim

void reclaim(AttributeSet a)

Reclaims an attribute set. This is a way for a MutableAttributeSet to mark that it no longer need a particular immutable set. This is only necessary in 1.1 where there are no weak references. A 1.1 implementation would call this in its finalize method.

Parameters:

a - the attribute set to reclaim

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.