Home » openjdk-7 » java » text » [javadoc | source]
java.text
public class: AttributedString [javadoc | source]
java.lang.Object
   java.text.AttributedString
An AttributedString holds text and related attribute information. It may be used as the actual data storage in some cases where a text reader wants to access attributed text through the AttributedCharacterIterator interface.

An attribute is a key/value pair, identified by the key. No two attributes on a given character can have the same key.

The values for an attribute are immutable, or must not be mutated by clients or storage. They are always passed by reference, and not cloned.

Field Summary
 String text     
 int runArraySize     
 int runCount     
 int[] runStarts     
 Vector[] runAttributes     
 Vector[] runAttributeValues     
Constructor:
 AttributedString(AttributedCharacterIterator[] iterators) 
    Constructs an AttributedString instance with the given AttributedCharacterIterators.
    Parameters:
    iterators - AttributedCharacterIterators to construct AttributedString from.
    Throws:
    NullPointerException - if iterators is null
 public AttributedString(String text) 
    Constructs an AttributedString instance with the given text.
    Parameters:
    text - The text for this attributed string.
    Throws:
    NullPointerException - if text is null.
    exception: NullPointerException - if text is null.
 public AttributedString(AttributedCharacterIterator text) 
    Constructs an AttributedString instance with the given attributed text represented by AttributedCharacterIterator.
    Parameters:
    text - The text for this attributed string.
    Throws:
    NullPointerException - if text is null.
    exception: NullPointerException - if text is null.
 public AttributedString(String text,
    Map<Attribute, ?> attributes) 
    Constructs an AttributedString instance with the given text and attributes.
    Parameters:
    text - The text for this attributed string.
    attributes - The attributes that apply to the entire string.
    Throws:
    NullPointerException - if text or attributes is null.
    IllegalArgumentException - if the text has length 0 and the attributes parameter is not an empty Map (attributes cannot be applied to a 0-length range).
    exception: NullPointerException - if text or attributes is null.
    exception: IllegalArgumentException - if the text has length 0 and the attributes parameter is not an empty Map (attributes cannot be applied to a 0-length range).
 public AttributedString(AttributedCharacterIterator text,
    int beginIndex,
    int endIndex) 
    Constructs an AttributedString instance with the subrange of the given attributed text represented by AttributedCharacterIterator. If the given range produces an empty text, all attributes will be discarded. Note that any attributes wrapped by an Annotation object are discarded for a subrange of the original attribute range.
    Parameters:
    text - The text for this attributed string.
    beginIndex - Index of the first character of the range.
    endIndex - Index of the character following the last character of the range.
    Throws:
    NullPointerException - if text is null.
    IllegalArgumentException - if the subrange given by beginIndex and endIndex is out of the text range.
    Also see:
    java.text.Annotation
    exception: NullPointerException - if text is null.
    exception: IllegalArgumentException - if the subrange given by beginIndex and endIndex is out of the text range.
 public AttributedString(AttributedCharacterIterator text,
    int beginIndex,
    int endIndex,
    Attribute[] attributes) 
    Constructs an AttributedString instance with the subrange of the given attributed text represented by AttributedCharacterIterator. Only attributes that match the given attributes will be incorporated into the instance. If the given range produces an empty text, all attributes will be discarded. Note that any attributes wrapped by an Annotation object are discarded for a subrange of the original attribute range.
    Parameters:
    text - The text for this attributed string.
    beginIndex - Index of the first character of the range.
    endIndex - Index of the character following the last character of the range.
    attributes - Specifies attributes to be extracted from the text. If null is specified, all available attributes will be used.
    Throws:
    NullPointerException - if text is null.
    IllegalArgumentException - if the subrange given by beginIndex and endIndex is out of the text range.
    Also see:
    java.text.Annotation
    exception: NullPointerException - if text is null.
    exception: IllegalArgumentException - if the subrange given by beginIndex and endIndex is out of the text range.
Method from java.text.AttributedString Summary:
addAttribute,   addAttribute,   addAttributes,   getIterator,   getIterator,   getIterator,   length
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.text.AttributedString Detail:
 public  void addAttribute(Attribute attribute,
    Object value) 
    Adds an attribute to the entire string.
 public  void addAttribute(Attribute attribute,
    Object value,
    int beginIndex,
    int endIndex) 
    Adds an attribute to a subrange of the string.
 public  void addAttributes(Map<Attribute, ?> attributes,
    int beginIndex,
    int endIndex) 
    Adds a set of attributes to a subrange of the string.
 public AttributedCharacterIterator getIterator() 
    Creates an AttributedCharacterIterator instance that provides access to the entire contents of this string.
 public AttributedCharacterIterator getIterator(Attribute[] attributes) 
    Creates an AttributedCharacterIterator instance that provides access to selected contents of this string. Information about attributes not listed in attributes that the implementor may have need not be made accessible through the iterator. If the list is null, all available attribute information should be made accessible.
 public AttributedCharacterIterator getIterator(Attribute[] attributes,
    int beginIndex,
    int endIndex) 
    Creates an AttributedCharacterIterator instance that provides access to selected contents of this string. Information about attributes not listed in attributes that the implementor may have need not be made accessible through the iterator. If the list is null, all available attribute information should be made accessible.
 int length()