Package org.apache.pivot.wtk.text

Class ComponentNode

java.lang.Object

org.apache.pivot.wtk.text.Node

org.apache.pivot.wtk.text.ComponentNode

public class ComponentNode
extends Node

Node representing a live Pivot component to be inserted into a TextPane.

Constructor Summary

Constructors

Constructor	Description
ComponentNode()
ComponentNode(Component component)
ComponentNode(ComponentNode componentNode)

Method Summary

Modifier and Type	Method	Description
Node	duplicate(boolean recursive)	Creates a copy of this node.
char	getCharacterAt(int offset)
int	getCharacterCount()
java.lang.CharSequence	getCharacters()
java.lang.CharSequence	getCharacters(int start, int end)
java.lang.CharSequence	getCharacters(CharSpan charSpan)
java.lang.CharSequence	getCharacters(Component comp)
java.lang.CharSequence	getCharacters(Span range)
Component	getComponent()
ListenerList<ComponentNodeListener>	getComponentNodeListeners()
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()
void	insertRange(Node range, int offset)	Inserts a range into the node.
Node	removeRange(int offset, int span)	Removes a range from the node.
void	setComponent(Component component)

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, toString, wait, wait, wait

Constructor Detail

ComponentNode

public ComponentNode()

ComponentNode

public ComponentNode(ComponentNode componentNode)

ComponentNode

public ComponentNode(Component component)

Method Detail

getComponent

public Component getComponent()

setComponent

public void setComponent(Component component)

getText

public java.lang.String getText()

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(Component comp)

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(Span range)

getCharacters

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

getCharacters

public java.lang.CharSequence getCharacters(CharSpan charSpan)

getCharacterAt

public char getCharacterAt(int offset)

Specified by:

getCharacterAt in class Node

Parameters:

offset - 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

@UnsupportedOperation
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:

range - The node containing the text to insert.

offset - Offset relative to this node.

removeRange

@UnsupportedOperation
public Node removeRange(int offset,
                        int span)

Description copied from class: Node

Removes a range from the node.

Specified by:

removeRange in class Node

Parameters:

offset - Offset relative to this node.

span - 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.

getComponentNodeListeners

public ListenerList<ComponentNodeListener> getComponentNodeListeners()