Package org.apache.pivot.wtk.text

Class TextNode

java.lang.Object

org.apache.pivot.wtk.text.Node

org.apache.pivot.wtk.text.TextNode

public final class TextNode
extends Node

Node representing a sequence of characters.

Constructor Summary

Constructors

Constructor	Description
TextNode()
TextNode(java.lang.String text)
TextNode(TextNode textNode)

Method Summary

Modifier and Type	Method	Description
void	appendText(java.lang.CharSequence text)
Node	duplicate(boolean recursive)	Creates a copy of this node.
char	getCharacterAt(int index)
int	getCharacterCount()
java.lang.CharSequence	getCharacters()
java.lang.CharSequence	getCharacters(int start, int end)
java.lang.CharSequence	getCharacters(CharSpan charSpan)
java.lang.CharSequence	getCharacters(Span range)
Node	getRange(int offset, int characterCount)	Returns a range from the node.
java.lang.String	getSubstring(int start, int end)
java.lang.String	getSubstring(CharSpan charSpan)
java.lang.String	getSubstring(Span range)
java.lang.String	getText()
java.lang.String	getText(int beginIndex, int endIndex)
java.lang.String	getText(CharSpan charSpan)
java.lang.String	getText(Span span)
ListenerList<TextNodeListener>	getTextNodeListeners()
void	insertRange(Node range, int offset)	Inserts a range into the node.
void	insertText(java.lang.CharSequence text, int index)
Node	removeRange(int offset, int characterCount)	Removes a range from the node.
void	removeText(int index, int count)
void	setText(java.lang.String text)
java.lang.String	toString()

Methods inherited from class org.apache.pivot.wtk.text.Node

getDocumentOffset, getDocumentSpan, getNodeListeners, getOffset, getParagraph, getParent, getUserData, nodeInserted, nodesRemoved, rangeInserted, rangeRemoved, replaceRange, setOffset, setParent, setUserData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TextNode

public TextNode()

TextNode

public TextNode(TextNode textNode)

TextNode

public TextNode(java.lang.String text)

Method Detail

getText

public java.lang.String getText()

getText

public java.lang.String getText(int beginIndex,
                                int endIndex)

getText

public java.lang.String getText(Span span)

getText

public java.lang.String getText(CharSpan charSpan)

setText

public void setText(java.lang.String text)

appendText

public void appendText(java.lang.CharSequence text)

insertText

public void insertText(java.lang.CharSequence text,
                       int index)

Parameters:

text - The new text to insert into this node.

index - Starting index into this node for the insertion.

removeText

public void removeText(int index,
                       int count)

Parameters:

index - Index into this node.

count - Count of characters to remove.

getSubstring

public java.lang.String getSubstring(Span range)

getSubstring

public java.lang.String getSubstring(int start,
                                     int end)

getSubstring

public java.lang.String getSubstring(CharSpan charSpan)

getCharacters

public java.lang.CharSequence getCharacters()

Specified by:

getCharacters in class Node

Returns:

The character sequence in this node.

getCharacters

public java.lang.CharSequence getCharacters(int start,
                                            int end)

getCharacters

public java.lang.CharSequence getCharacters(Span range)

getCharacters

public java.lang.CharSequence getCharacters(CharSpan charSpan)

getCharacterAt

public char getCharacterAt(int index)

Specified by:

getCharacterAt in class Node

Parameters:

index - Offset relative to this node.

Returns:

The character at the given offset.

getCharacterCount

public int getCharacterCount()

Specified by:

getCharacterCount in class Node

Returns:

The number of characters in this node.

insertRange

public void insertRange(Node range,
                        int offset)

Description copied from class: Node

Inserts a range into the node. Note that the contents of the range, rather than the range itself, is added to the node.

Specified by:

insertRange in class Node

Parameters:

offset - Offset into this text node.

range - The node containing the text to insert.

removeRange

public Node removeRange(int offset,
                        int characterCount)

Description copied from class: Node

Removes a range from the node.

Specified by:

removeRange in class Node

Parameters:

offset - Offset relative to this node.

characterCount - Count of characters to remove.

Returns:

The removed range. This will be a copy of the node structure relative to this node.

getRange

public Node getRange(int offset,
                     int characterCount)

Description copied from class: Node

Returns a range from the node.

Specified by:

getRange in class Node

Parameters:

offset - Offset relative to this node.

characterCount - Count of characters to get.

Returns:

A node containing a copy of the node structure spanning the given range, relative to this node.

duplicate

public Node duplicate(boolean recursive)

Description copied from class: Node

Creates a copy of this node.

Specified by:

duplicate in class Node

Parameters:

recursive - Whether to duplicate the children also.

Returns:

A copy of the current node.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getTextNodeListeners

public ListenerList<TextNodeListener> getTextNodeListeners()