Package org.apache.pivot.wtk.text

Class TextSpan

java.lang.Object

org.apache.pivot.wtk.text.Node

org.apache.pivot.wtk.text.Element

org.apache.pivot.wtk.text.TextSpan

All Implemented Interfaces:

java.lang.Iterable<Node>, Sequence<Node>

public class TextSpan
extends Element

Element representing an inline range of styled characters.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.pivot.collections.Sequence

Sequence.Tree<T>

Constructor Summary

Constructors

Constructor	Description
TextSpan()
TextSpan(java.lang.String text)
TextSpan(TextSpan span, boolean recursive)

Method Summary

Modifier and Type	Method	Description
int	add(java.lang.String text)
TextSpan	duplicate(boolean recursive)	Creates a copy of this node.
TextSpan	getRange(int offset, int characterCount)	Returns a range from the node.
void	insert(Node node, int index)	Inserts an item into the sequence at a specific index.

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

add, get, getBackgroundColor, getCharacterAt, getCharacterCount, getCharacters, getDescendantAt, getElementListeners, getFont, getForegroundColor, getLength, getNodeAt, getPathAt, getText, indexOf, insertRange, isStrikethrough, isUnderline, iterator, rangeInserted, rangeRemoved, remove, remove, removeRange, setBackgroundColor, setBackgroundColor, setFont, setFont, setFont, setForegroundColor, setForegroundColor, setStrikethrough, setUnderline, update

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.apache.pivot.collections.Sequence

addAll, addAll

Constructor Detail

TextSpan

public TextSpan()

TextSpan

public TextSpan(TextSpan span,
                boolean recursive)

TextSpan

public TextSpan(java.lang.String text)

Method Detail

add

public int add(java.lang.String text)

insert

public void insert(Node node,
                   int index)

Description copied from interface: Sequence

Inserts an item into the sequence at a specific index.

Specified by:

insert in interface Sequence<Node>

Overrides:

insert in class Element

Parameters:

node - The item to be added to the sequence.

index - The index at which the item should be inserted. Must be a value between 0 and getLength().

duplicate

public TextSpan duplicate(boolean recursive)

Description copied from class: Node

Creates a copy of this node.

Specified by:

duplicate in class Element

Parameters:

recursive - Whether to duplicate the children also.

Returns:

A copy of the current node.

getRange

public TextSpan getRange(int offset,
                         int characterCount)

Description copied from class: Node

Returns a range from the node.

Overrides:

getRange in class Element

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.