java.text
Class AttributedString

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.text.AttributedString

public class AttributedString
extends Object sample code for java.lang.Object definition code for java.lang.Object

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.

Since:
1.2
See Also:
AttributedCharacterIterator sample code for java.text.AttributedCharacterIterator definition code for java.text.AttributedCharacterIterator , Annotation sample code for java.text.Annotation definition code for java.text.Annotation

Constructor Summary
AttributedString sample code for java.text.AttributedString.AttributedString(java.text.AttributedCharacterIterator) definition code for java.text.AttributedString.AttributedString(java.text.AttributedCharacterIterator) (AttributedCharacterIterator sample code for java.text.AttributedCharacterIterator definition code for java.text.AttributedCharacterIterator  text)
          Constructs an AttributedString instance with the given attributed text represented by AttributedCharacterIterator.
AttributedString sample code for java.text.AttributedString.AttributedString(java.text.AttributedCharacterIterator, int, int) definition code for java.text.AttributedString.AttributedString(java.text.AttributedCharacterIterator, int, int) (AttributedCharacterIterator sample code for java.text.AttributedCharacterIterator definition code for java.text.AttributedCharacterIterator  text, int beginIndex, int endIndex)
          Constructs an AttributedString instance with the subrange of the given attributed text represented by AttributedCharacterIterator.
AttributedString sample code for java.text.AttributedString.AttributedString(java.text.AttributedCharacterIterator, int, int, java.text.AttributedCharacterIterator.Attribute[]) definition code for java.text.AttributedString.AttributedString(java.text.AttributedCharacterIterator, int, int, java.text.AttributedCharacterIterator.Attribute[]) (AttributedCharacterIterator sample code for java.text.AttributedCharacterIterator definition code for java.text.AttributedCharacterIterator  text, int beginIndex, int endIndex, AttributedCharacterIterator.Attribute sample code for java.text.AttributedCharacterIterator.Attribute definition code for java.text.AttributedCharacterIterator.Attribute [] attributes)
          Constructs an AttributedString instance with the subrange of the given attributed text represented by AttributedCharacterIterator.
AttributedString sample code for java.text.AttributedString.AttributedString(java.lang.String) definition code for java.text.AttributedString.AttributedString(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  text)
          Constructs an AttributedString instance with the given text.
AttributedString sample code for java.text.AttributedString.AttributedString(java.lang.String, java.util.Map) definition code for java.text.AttributedString.AttributedString(java.lang.String, java.util.Map) (String sample code for java.lang.String definition code for java.lang.String  text, Map sample code for java.util.Map definition code for java.util.Map <? extends AttributedCharacterIterator.Attribute sample code for java.text.AttributedCharacterIterator.Attribute definition code for java.text.AttributedCharacterIterator.Attribute ,?> attributes)
          Constructs an AttributedString instance with the given text and attributes.
 
Method Summary
 void addAttribute sample code for java.text.AttributedString.addAttribute(java.text.AttributedCharacterIterator.Attribute, java.lang.Object) definition code for java.text.AttributedString.addAttribute(java.text.AttributedCharacterIterator.Attribute, java.lang.Object) (AttributedCharacterIterator.Attribute sample code for java.text.AttributedCharacterIterator.Attribute definition code for java.text.AttributedCharacterIterator.Attribute  attribute, Object sample code for java.lang.Object definition code for java.lang.Object  value)
          Adds an attribute to the entire string.
 void addAttribute sample code for java.text.AttributedString.addAttribute(java.text.AttributedCharacterIterator.Attribute, java.lang.Object, int, int) definition code for java.text.AttributedString.addAttribute(java.text.AttributedCharacterIterator.Attribute, java.lang.Object, int, int) (AttributedCharacterIterator.Attribute sample code for java.text.AttributedCharacterIterator.Attribute definition code for java.text.AttributedCharacterIterator.Attribute  attribute, Object sample code for java.lang.Object definition code for java.lang.Object  value, int beginIndex, int endIndex)
          Adds an attribute to a subrange of the string.
 void addAttributes sample code for java.text.AttributedString.addAttributes(java.util.Map, int, int) definition code for java.text.AttributedString.addAttributes(java.util.Map, int, int) (Map sample code for java.util.Map definition code for java.util.Map <? extends AttributedCharacterIterator.Attribute sample code for java.text.AttributedCharacterIterator.Attribute definition code for java.text.AttributedCharacterIterator.Attribute ,?> attributes, int beginIndex, int endIndex)
          Adds a set of attributes to a subrange of the string.
 AttributedCharacterIterator sample code for java.text.AttributedCharacterIterator definition code for java.text.AttributedCharacterIterator getIterator sample code for java.text.AttributedString.getIterator() definition code for java.text.AttributedString.getIterator() ()
          Creates an AttributedCharacterIterator instance that provides access to the entire contents of this string.
 AttributedCharacterIterator sample code for java.text.AttributedCharacterIterator definition code for java.text.AttributedCharacterIterator getIterator sample code for java.text.AttributedString.getIterator(java.text.AttributedCharacterIterator.Attribute[]) definition code for java.text.AttributedString.getIterator(java.text.AttributedCharacterIterator.Attribute[]) (AttributedCharacterIterator.Attribute sample code for java.text.AttributedCharacterIterator.Attribute definition code for java.text.AttributedCharacterIterator.Attribute [] attributes)
          Creates an AttributedCharacterIterator instance that provides access to selected contents of this string.
 AttributedCharacterIterator sample code for java.text.AttributedCharacterIterator definition code for java.text.AttributedCharacterIterator getIterator sample code for java.text.AttributedString.getIterator(java.text.AttributedCharacterIterator.Attribute[], int, int) definition code for java.text.AttributedString.getIterator(java.text.AttributedCharacterIterator.Attribute[], int, int) (AttributedCharacterIterator.Attribute sample code for java.text.AttributedCharacterIterator.Attribute definition code for java.text.AttributedCharacterIterator.Attribute [] attributes, int beginIndex, int endIndex)
          Creates an AttributedCharacterIterator instance that provides access to selected contents of this string.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

AttributedString sample code for java.text.AttributedString(java.lang.String) definition code for java.text.AttributedString(java.lang.String)

public AttributedString(String sample code for java.lang.String definition code for java.lang.String  text)
Constructs an AttributedString instance with the given text.

Parameters:
text - The text for this attributed string.

AttributedString sample code for java.text.AttributedString(java.lang.String, java.util.Map<? extends java.text.AttributedCharacterIterator.Attribute, ?>) definition code for java.text.AttributedString(java.lang.String, java.util.Map<? extends java.text.AttributedCharacterIterator.Attribute, ?>)

public AttributedString(String sample code for java.lang.String definition code for java.lang.String  text,
                        Map sample code for java.util.Map definition code for java.util.Map <? extends AttributedCharacterIterator.Attribute sample code for java.text.AttributedCharacterIterator.Attribute definition code for java.text.AttributedCharacterIterator.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:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.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).

AttributedString sample code for java.text.AttributedString(java.text.AttributedCharacterIterator) definition code for java.text.AttributedString(java.text.AttributedCharacterIterator)

public AttributedString(AttributedCharacterIterator sample code for java.text.AttributedCharacterIterator definition code for java.text.AttributedCharacterIterator  text)
Constructs an AttributedString instance with the given attributed text represented by AttributedCharacterIterator.

Parameters:
text - The text for this attributed string.

AttributedString sample code for java.text.AttributedString(java.text.AttributedCharacterIterator, int, int) definition code for java.text.AttributedString(java.text.AttributedCharacterIterator, int, int)

public AttributedString(AttributedCharacterIterator sample code for java.text.AttributedCharacterIterator definition code for java.text.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:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if the subrange given by beginIndex and endIndex is out of the text range.
See Also:
Annotation sample code for java.text.Annotation definition code for java.text.Annotation

AttributedString sample code for java.text.AttributedString(java.text.AttributedCharacterIterator, int, int, java.text.AttributedCharacterIterator.Attribute[]) definition code for java.text.AttributedString(java.text.AttributedCharacterIterator, int, int, java.text.AttributedCharacterIterator.Attribute[])

public AttributedString(AttributedCharacterIterator sample code for java.text.AttributedCharacterIterator definition code for java.text.AttributedCharacterIterator  text,
                        int beginIndex,
                        int endIndex,
                        AttributedCharacterIterator.Attribute sample code for java.text.AttributedCharacterIterator.Attribute definition code for java.text.AttributedCharacterIterator.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:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if the subrange given by beginIndex and endIndex is out of the text range.
See Also:
Annotation sample code for java.text.Annotation definition code for java.text.Annotation
Method Detail

addAttribute sample code for java.text.AttributedString.addAttribute(java.text.AttributedCharacterIterator.Attribute, java.lang.Object) definition code for java.text.AttributedString.addAttribute(java.text.AttributedCharacterIterator.Attribute, java.lang.Object)

public void addAttribute(AttributedCharacterIterator.Attribute sample code for java.text.AttributedCharacterIterator.Attribute definition code for java.text.AttributedCharacterIterator.Attribute  attribute,
                         Object sample code for java.lang.Object definition code for java.lang.Object  value)
Adds an attribute to the entire string.

Parameters:
attribute - the attribute key
value - the value of the attribute; may be null
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if the AttributedString has length 0 (attributes cannot be applied to a 0-length range).

addAttribute sample code for java.text.AttributedString.addAttribute(java.text.AttributedCharacterIterator.Attribute, java.lang.Object, int, int) definition code for java.text.AttributedString.addAttribute(java.text.AttributedCharacterIterator.Attribute, java.lang.Object, int, int)

public void addAttribute(AttributedCharacterIterator.Attribute sample code for java.text.AttributedCharacterIterator.Attribute definition code for java.text.AttributedCharacterIterator.Attribute  attribute,
                         Object sample code for java.lang.Object definition code for java.lang.Object  value,
                         int beginIndex,
                         int endIndex)
Adds an attribute to a subrange of the string.

Parameters:
attribute - the attribute key
value - The value of the attribute. May be null.
beginIndex - Index of the first character of the range.
endIndex - Index of the character following the last character of the range.
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if beginIndex is less then 0, endIndex is greater than the length of the string, or beginIndex and endIndex together don't define a non-empty subrange of the string.

addAttributes sample code for java.text.AttributedString.addAttributes(java.util.Map<? extends java.text.AttributedCharacterIterator.Attribute, ?>, int, int) definition code for java.text.AttributedString.addAttributes(java.util.Map<? extends java.text.AttributedCharacterIterator.Attribute, ?>, int, int)

public void addAttributes(Map sample code for java.util.Map definition code for java.util.Map <? extends AttributedCharacterIterator.Attribute sample code for java.text.AttributedCharacterIterator.Attribute definition code for java.text.AttributedCharacterIterator.Attribute ,?> attributes,
                          int beginIndex,
                          int endIndex)
Adds a set of attributes to a subrange of the string.

Parameters:
attributes - The attributes to be added to the string.
beginIndex - Index of the first character of the range.
endIndex - Index of the character following the last character of the range.
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if beginIndex is less then 0, endIndex is greater than the length of the string, or beginIndex and endIndex together don't define a non-empty subrange of the string and the attributes parameter is not an empty Map.

getIterator sample code for java.text.AttributedString.getIterator() definition code for java.text.AttributedString.getIterator()

public AttributedCharacterIterator sample code for java.text.AttributedCharacterIterator definition code for java.text.AttributedCharacterIterator  getIterator()
Creates an AttributedCharacterIterator instance that provides access to the entire contents of this string.

Returns:
An iterator providing access to the text and its attributes.

getIterator sample code for java.text.AttributedString.getIterator(java.text.AttributedCharacterIterator.Attribute[]) definition code for java.text.AttributedString.getIterator(java.text.AttributedCharacterIterator.Attribute[])

public AttributedCharacterIterator sample code for java.text.AttributedCharacterIterator definition code for java.text.AttributedCharacterIterator  getIterator(AttributedCharacterIterator.Attribute sample code for java.text.AttributedCharacterIterator.Attribute definition code for java.text.AttributedCharacterIterator.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.

Parameters:
attributes - a list of attributes that the client is interested in
Returns:
an iterator providing access to the text and its attributes

getIterator sample code for java.text.AttributedString.getIterator(java.text.AttributedCharacterIterator.Attribute[], int, int) definition code for java.text.AttributedString.getIterator(java.text.AttributedCharacterIterator.Attribute[], int, int)

public AttributedCharacterIterator sample code for java.text.AttributedCharacterIterator definition code for java.text.AttributedCharacterIterator  getIterator(AttributedCharacterIterator.Attribute sample code for java.text.AttributedCharacterIterator.Attribute definition code for java.text.AttributedCharacterIterator.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.

Parameters:
attributes - a list of attributes that the client is interested in
beginIndex - the index of the first character
endIndex - the index of the character following the last character
Returns:
an iterator providing access to the text and its attributes
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if beginIndex is less then 0, endIndex is greater than the length of the string, or beginIndex is greater than endIndex.