javax.swing.text

Interface AbstractDocument.AttributeContext

Known Implementing Classes:
StyleContext, StyleSheet

public static interface AbstractDocument.AttributeContext

Defines a set of methods for managing text attributes for one or more Documents. Replicating AttributeSets 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 AttributeSet that contains the attributes of old plus the new attribute specified by name and value.
AttributeSet
addAttributes(AttributeSet old, AttributeSet attributes)
Returns an AttributeSet that contains the attributes of old plus the new attributes in attributes.
AttributeSet
getEmptySet()
Returns an empty 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 AttributeSet that has the attribute with the specified name removed from old.
AttributeSet
removeAttributes(AttributeSet old, Enumeration names)
Removes all attributes specified by names from old and returns the resulting AttributeSet.
AttributeSet
removeAttributes(AttributeSet old, AttributeSet attributes)
Removes all attributes in attributes from old and returns the resulting AttributeSet.

Method Details

addAttribute

public AttributeSet addAttribute(AttributeSet old,
                                 Object name,
                                 Object value)
Returns an 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 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 AttributeSet that contains the attributes of old plus the new attributes in attributes

getEmptySet

public AttributeSet getEmptySet()
Returns an empty AttributeSet.
Returns:
an empty 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 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,
                                     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

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

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