| java.lang.Object
 com.ibm.richtext.styledtext.MConstText
com.ibm.richtext.styledtext.MText
com.ibm.richtext.styledtext.StyledText
| StyledText | | final public class StyledText extends MText implements Externalizable(Code) | | This class is an implementation of MText, a modifyable, styled text
storage model. Additionally, it supports persistance through the
Externalizable interface.
See Also: MText |
| Constructor Summary | |
| public | StyledText()
Create an empty text object. | | public | StyledText(int capacity)
Create an empty text object ready to hold at least capacity chars. | | public | StyledText(String string, AttributeMap initialStyle)
Create a text object with the characters in the string,
in the given style. | | public | StyledText(MConstText source)
Create a text object from the given source. | | public | StyledText(MConstText source, int srcStart, int srcLimit)
Create a text object from a subrange of the given source. |
| Method Summary | |
| public void | append(MConstText srcText)
Append the contents of srcText (both characters and styles) to the
end of this MText. | | public char | at(int pos)
Return the character at offset pos. | | public AttributeMap | characterStyleAt(int pos)
Return the style applied to the character at offset pos. | | public int | characterStyleLimit(int pos)
Return the index after the last character in the character style run
containing pos. | | public int | characterStyleStart(int pos)
Return the index of the first character in the character style run
containing pos. | | public void | compress()
Minimize the amount of memory used by the MText object. | | public CharacterIterator | createCharacterIterator(int start, int limit)
Create a CharacterIterator over the range [start, limit). | | public int | damagedRangeLimit()
Return the limit of the damaged range. | | public int | damagedRangeStart()
Return the start of the damaged range. | | public MConstText | extract(int start, int limit)
Create an MConstText containing the characters and styles in the range
[start, limit). | | public void | extractChars(int start, int limit, char[] dst, int dstStart)
Copy the characters in the range [start, limit)
into the array dst, beginning at dstStart.
Parameters:
start - offset of first character which will be copied into the array
Parameters:
limit - offset immediately after the last character which will be copied into the array
Parameters:
dst - array in which to copy characters. | | public MText | extractWritable(int start, int limit)
Create an MText containing the characters and styles in the range
[start, limit). | | public int | getTimeStamp()
Return the current time stamp. | | public void | insert(int pos, MConstText srcText)
Insert the contents of srcText (both characters and styles) into this
MText at the position specified by pos. | | public int | length()
Return the length of the MConstText object. | | public void | modifyCharacterStyles(int start, int limit, StyleModifier modifier)
Invoke the given modifier on all character styles from start to limit. | | public void | modifyParagraphStyles(int start, int limit, StyleModifier modifier)
Invoke the given modifier on all paragraph styles in paragraphs
containing characters in the range [start, limit). | | public int | paragraphLimit(int pos)
Return the limit of the paragraph containing the character at offset pos. | | public int | paragraphStart(int pos)
Return the start of the paragraph containing the character at offset pos. | | public AttributeMap | paragraphStyleAt(int pos)
Return the paragraph style applied to the paragraph containing offset pos. | | public void | readExternal(ObjectInput in)
| | public void | remove(int start, int limit)
Delete the specified range of characters (and styles). | | public void | remove()
Delete all characters and styles. | | public void | removeCharacterStyles()
Set the style of all characters in the MText object to
AttributeMap.EMPTY_ATTRIBUTE_MAP. | | public void | replace(int start, int limit, MConstText text, int srcStart, int srcLimit)
Replace the characters and styles in the range [start, limit) with the characters
and styles in srcText in the range [srcStart, srcLimit). | | public void | replace(int start, int limit, MConstText text)
Replace the characters and styles in the range [start, limit) with the characters
and styles in srcText. | | public void | replace(int start, int limit, char[] srcChars, int srcStart, int srcLimit, AttributeMap charsStyle)
Replace the characters in the range [start, limit) with the characters
in srcChars in the range [srcStart, srcLimit). | | public void | replace(int start, int limit, char srcChar, AttributeMap charStyle)
Replace the characters in the range [start, limit) with the character srcChar.
The new character takes on the style charStyle
Parameters:
start - the offset at which the replace operation begins
Parameters:
limit - the offset at which the replace operation ends. | | public void | replaceAll(MConstText srcText)
Replace the entire contents of this MText (both characters and styles) with
the contents of srcText. | | public void | resetDamagedRange()
Reset the damaged range to an empty interval, and begin accumulating the damaged
range. | | public String | toString()
| | public void | writeExternal(ObjectOutput out)
|
| StyledText | | public StyledText()(Code) | | Create an empty text object.
|
| StyledText | | public StyledText(int capacity)(Code) | | Create an empty text object ready to hold at least capacity chars.
Parameters:
capacity - the minimum capacity of the internal text buffer |
| StyledText | | public StyledText(String string, AttributeMap initialStyle)(Code) | | Create a text object with the characters in the string,
in the given style.
Parameters:
string - the initial contents
Parameters:
initialStyle - the style of the initial text |
| StyledText | | public StyledText(MConstText source)(Code) | | Create a text object from the given source.
Parameters:
source - the text to copy |
| StyledText | | public StyledText(MConstText source, int srcStart, int srcLimit)(Code) | | Create a text object from a subrange of the given source.
Parameters:
source - the text to copy from
Parameters:
srcStart - the index of the first character to copy
Parameters:
srcLimit - the index after the last character to copy |
| append | | public void append(MConstText srcText)(Code) | | Append the contents of srcText (both characters and styles) to the
end of this MText.
Parameters:
srcText - The text to append. |
| at | | public char at(int pos)(Code) | | Return the character at offset pos.
Parameters:
pos - a valid offset into the text the character at offset pos |
| characterStyleAt | | public AttributeMap characterStyleAt(int pos)(Code) | | Return the style applied to the character at offset pos.
Parameters:
pos - a valid offset into the text the style at offset pos |
| characterStyleLimit | | public int characterStyleLimit(int pos)(Code) | | Return the index after the last character in the character style run
containing pos. All characters in a style run have the same character
style.
the style at offset pos |
| characterStyleStart | | public int characterStyleStart(int pos)(Code) | | Return the index of the first character in the character style run
containing pos. All characters in a style run have the same character
style.
the style at offset pos |
| compress | | public void compress()(Code) | | Minimize the amount of memory used by the MText object.
|
| createCharacterIterator | | public CharacterIterator createCharacterIterator(int start, int limit)(Code) | | Create a CharacterIterator over the range [start, limit).
Parameters:
start - the beginning of the iterator's range
Parameters:
limit - the limit of the iterator's range a valid CharacterIterator over the specified range
See Also: java.text.CharacterIterator |
| extract | | public MConstText extract(int start, int limit)(Code) | | Create an MConstText containing the characters and styles in the range
[start, limit).
Parameters:
start - offset of first character in the new text
Parameters:
limit - offset immediately after the last character in the new text an MConstText object containing the characters and styles in the given range |
| extractChars | | public void extractChars(int start, int limit, char[] dst, int dstStart)(Code) | | Copy the characters in the range [start, limit)
into the array dst, beginning at dstStart.
Parameters:
start - offset of first character which will be copied into the array
Parameters:
limit - offset immediately after the last character which will be copied into the array
Parameters:
dst - array in which to copy characters. The length of dst must be at least(dstStart + limit - start). |
| extractWritable | | public MText extractWritable(int start, int limit)(Code) | | Create an MText containing the characters and styles in the range
[start, limit).
Parameters:
start - offset of first character in the new text
Parameters:
limit - offset immediately after the last character in the new text an MConstText object containing the characters and styles in the given range |
| getTimeStamp | | public int getTimeStamp()(Code) | | Return the current time stamp. The time stamp is
incremented whenever the contents of the MConstText changes.
the current paragraph style time stamp |
| insert | | public void insert(int pos, MConstText srcText)(Code) | | Insert the contents of srcText (both characters and styles) into this
MText at the position specified by pos.
Parameters:
pos - The character offset where the new text is to be inserted.
Parameters:
srcText - The text to insert. |
| length | | public int length()(Code) | | Return the length of the MConstText object. The length is the number of characters in the text.
the length of the MConstText object |
| modifyCharacterStyles | | public void modifyCharacterStyles(int start, int limit, StyleModifier modifier)(Code) | | Invoke the given modifier on all character styles from start to limit.
Parameters:
modifier - the modifier to apply to the range.
Parameters:
start - the start of the range of text to modify.
Parameters:
limit - the limit of the range of text to modify. |
| modifyParagraphStyles | | public void modifyParagraphStyles(int start, int limit, StyleModifier modifier)(Code) | | Invoke the given modifier on all paragraph styles in paragraphs
containing characters in the range [start, limit).
Parameters:
modifier - the modifier to apply to the range.
Parameters:
start - the start of the range of text to modify.
Parameters:
limit - the limit of the range of text to modify. |
| paragraphLimit | | public int paragraphLimit(int pos)(Code) | | Return the limit of the paragraph containing the character at offset pos.
Parameters:
pos - a valid offset into the text the limit of the paragraph containing the character at offset pos |
| paragraphStart | | public int paragraphStart(int pos)(Code) | | Return the start of the paragraph containing the character at offset pos.
Parameters:
pos - a valid offset into the text the start of the paragraph containing the character at offset pos |
| paragraphStyleAt | | public AttributeMap paragraphStyleAt(int pos)(Code) | | Return the paragraph style applied to the paragraph containing offset pos.
Parameters:
pos - a valid offset into the text the paragraph style in effect at pos |
| remove | | public void remove(int start, int limit)(Code) | | Delete the specified range of characters (and styles).
Parameters:
start - Offset of the first character to delete.
Parameters:
limit - Offset of the first character after the range to delete. |
| remove | | public void remove()(Code) | | Delete all characters and styles. Always increments time stamp.
|
| removeCharacterStyles | | public void removeCharacterStyles()(Code) | | Set the style of all characters in the MText object to
AttributeMap.EMPTY_ATTRIBUTE_MAP.
|
| replace | | public void replace(int start, int limit, MConstText text, int srcStart, int srcLimit)(Code) | | Replace the characters and styles in the range [start, limit) with the characters
and styles in srcText in the range [srcStart, srcLimit). srcText is not
modified.
Parameters:
start - the offset at which the replace operation begins
Parameters:
limit - the offset at which the replace operation ends. The character and style atlimit is not modified.
Parameters:
text - the source for the new characters and styles
Parameters:
srcStart - the offset into srcText where new characters and styles will be obtained
Parameters:
srcLimit - the offset into srcText where the new characters and styles end |
| replace | | public void replace(int start, int limit, MConstText text)(Code) | | Replace the characters and styles in the range [start, limit) with the characters
and styles in srcText. srcText is not
modified.
Parameters:
start - the offset at which the replace operation begins
Parameters:
limit - the offset at which the replace operation ends. The character and style atlimit is not modified.
Parameters:
text - the source for the new characters and styles |
| replace | | public void replace(int start, int limit, char[] srcChars, int srcStart, int srcLimit, AttributeMap charsStyle)(Code) | | Replace the characters in the range [start, limit) with the characters
in srcChars in the range [srcStart, srcLimit). New characters take on the style
charsStyle.
srcChars is not modified.
Parameters:
start - the offset at which the replace operation begins
Parameters:
limit - the offset at which the replace operation ends. The character atlimit is not modified.
Parameters:
srcChars - the source for the new characters
Parameters:
srcStart - the offset into srcChars where new characters will be obtained
Parameters:
srcLimit - the offset into srcChars where the new characters end
Parameters:
charsStyle - the style of the new characters |
| replace | | public void replace(int start, int limit, char srcChar, AttributeMap charStyle)(Code) | | Replace the characters in the range [start, limit) with the character srcChar.
The new character takes on the style charStyle
Parameters:
start - the offset at which the replace operation begins
Parameters:
limit - the offset at which the replace operation ends. The character atlimit is not modified.
Parameters:
srcChar - the new character
Parameters:
charStyle - the style of the new character |
| replaceAll | | public void replaceAll(MConstText srcText)(Code) | | Replace the entire contents of this MText (both characters and styles) with
the contents of srcText.
Parameters:
srcText - the source for the new characters and styles |
| resetDamagedRange | | public void resetDamagedRange()(Code) | | Reset the damaged range to an empty interval, and begin accumulating the damaged
range. The damaged range includes every index where a character, character style,
or paragraph style has changed.
See Also: StyledText.damagedRangeStart
See Also: StyledText.damagedRangeLimit |
| Methods inherited from com.ibm.richtext.styledtext.MText | abstract public void append(MConstText srcText)(Code)(Java Doc)
abstract public void compress()(Code)(Java Doc)
abstract public MText extractWritable(int start, int limit)(Code)(Java Doc)
abstract public void insert(int pos, MConstText srcText)(Code)(Java Doc)
abstract public void modifyCharacterStyles(int start, int limit, StyleModifier modifier)(Code)(Java Doc)
abstract public void modifyParagraphStyles(int start, int limit, StyleModifier modifier)(Code)(Java Doc)
abstract public void remove(int start, int limit)(Code)(Java Doc)
abstract public void remove()(Code)(Java Doc)
abstract public void removeCharacterStyles()(Code)(Java Doc)
abstract public void replace(int start, int limit, MConstText srcText, int srcStart, int srcLimit)(Code)(Java Doc)
abstract public void replace(int start, int limit, MConstText text)(Code)(Java Doc)
abstract public void replace(int start, int limit, char[] srcChars, int srcStart, int srcLimit, AttributeMap charsStyle)(Code)(Java Doc)
abstract public void replace(int start, int limit, char srcChar, AttributeMap charStyle)(Code)(Java Doc)
abstract public void replaceAll(MConstText srcText)(Code)(Java Doc)
abstract public void resetDamagedRange()(Code)(Java Doc)
|
|
|