org.apache.pivot.wtk.text
Class Element

java.lang.Object
  org.apache.pivot.wtk.text.Node
      org.apache.pivot.wtk.text.Element

All Implemented Interfaces:

Iterable<Node>, org.apache.pivot.collections.Sequence<Node>

Direct Known Subclasses:

Block, List.Item, TextSpan

public abstract class Element
extends Node
implements org.apache.pivot.collections.Sequence<Node>, Iterable<Node>

Abstract base class for elements.

TODO Add style properties.

TODO Add style class property.

Nested Class Summary

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

org.apache.pivot.collections.Sequence.Tree<T>

Constructor Summary

Element()

Element(Element element, boolean recursive)

Method Summary

int	add(Node node)
void	dumpOffsets()
abstract Element	duplicate(boolean recursive) Creates a copy of this node.
Node	get(int index)
Color	getBackgroundColor() Gets the currently background color, or null if no color is background.
char	getCharacterAt(int offset) Returns the character at the given offset.
int	getCharacterCount() Returns the number of characters in this node.
Node	getDescendantAt(int offset) Determines the descendant node at a given offset.
org.apache.pivot.util.ListenerList<ElementListener>	getElementListeners()
Font	getFont()
Color	getForegroundColor() Gets the currently foreground color, or null if no color is foreground.
int	getLength()
int	getNodeAt(int offset) Determines the index of the child node at a given offset.
org.apache.pivot.collections.Sequence<Integer>	getPathAt(int offset) Determines the path of the descendant node at a given offset.
Element	getRange(int offset, int characterCount) Returns a range from the node.
int	indexOf(Node node)
void	insert(Node node, int index)
void	insertRange(Node range, int offset) Inserts a range into the node.
boolean	isStrikethrough()
boolean	isUnderline()
Iterator<Node>	iterator()
protected void	rangeInserted(int offset, int characterCount) Called to notify a node that a range has been inserted.
protected void	rangeRemoved(int offset, int characterCount) Called to notify a node that a range has been removed.
org.apache.pivot.collections.Sequence<Node>	remove(int index, int count)
int	remove(Node node)
Node	removeRange(int offset, int characterCount) Removes a range from the node.
void	setBackgroundColor(Color backgroundColor) Sets the currently background color.
void	setBackgroundColor(String backgroundColor) Sets the currently background color.
void	setFont(Font font)
void	setFont(String font)
void	setForegroundColor(Color foregroundColor) Sets the currently foreground color.
void	setForegroundColor(String foregroundColor) Sets the currently foreground color.
void	setStrikethrough(boolean strikethrough)
void	setUnderline(boolean underline)
Node	update(int index, Node node)

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

getDocumentOffset, getNodeListeners, getOffset, getParent, nodeInserted, nodesRemoved, replaceRange, setOffset, setParent

Methods inherited from class java.lang.Object

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

Constructor Detail

Element

public Element()

Element

public Element(Element element,
               boolean recursive)

Method Detail

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

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

Returns:

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

getRange

public Element getRange(int offset,
                        int characterCount)

Description copied from class: Node

Returns a range from the node.

Specified by:

getRange in class Node

Returns:

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

duplicate

public abstract Element duplicate(boolean recursive)

Description copied from class: Node

Creates a copy of this node.

Specified by:

duplicate in class Node

getCharacterAt

public char getCharacterAt(int offset)

Description copied from class: Node

Returns the character at the given offset.

Specified by:

getCharacterAt in class Node

getCharacterCount

public int getCharacterCount()

Description copied from class: Node

Returns the number of characters in this node.

Specified by:

getCharacterCount in class Node

add

public int add(Node node)

Specified by:

add in interface org.apache.pivot.collections.Sequence<Node>

insert

public void insert(Node node,
                   int index)

Specified by:

insert in interface org.apache.pivot.collections.Sequence<Node>

update

public Node update(int index,
                   Node node)

Specified by:

update in interface org.apache.pivot.collections.Sequence<Node>

remove

public int remove(Node node)

Specified by:

remove in interface org.apache.pivot.collections.Sequence<Node>

remove

public org.apache.pivot.collections.Sequence<Node> remove(int index,
                                                          int count)

Specified by:

remove in interface org.apache.pivot.collections.Sequence<Node>

get

public Node get(int index)

Specified by:

get in interface org.apache.pivot.collections.Sequence<Node>

indexOf

public int indexOf(Node node)

Specified by:

indexOf in interface org.apache.pivot.collections.Sequence<Node>

getLength

public int getLength()

Specified by:

getLength in interface org.apache.pivot.collections.Sequence<Node>

getNodeAt

public int getNodeAt(int offset)

Determines the index of the child node at a given offset.

Parameters:

offset -

Returns:

The index of the child node at the given offset.

getPathAt

public org.apache.pivot.collections.Sequence<Integer> getPathAt(int offset)

Determines the path of the descendant node at a given offset.

Parameters:

offset -

Returns:

The path to the descendant node at the given offset.

getDescendantAt

public Node getDescendantAt(int offset)

Determines the descendant node at a given offset.

Parameters:

offset -

Returns:

The descendant node at the given offset.

rangeInserted

protected void rangeInserted(int offset,
                             int characterCount)

Description copied from class: Node

Called to notify a node that a range has been inserted.

Overrides:

rangeInserted in class Node

rangeRemoved

protected void rangeRemoved(int offset,
                            int characterCount)

Description copied from class: Node

Called to notify a node that a range has been removed.

Overrides:

rangeRemoved in class Node

iterator

public Iterator<Node> iterator()

Specified by:

iterator in interface Iterable<Node>

dumpOffsets

public void dumpOffsets()

getFont

public Font getFont()

setFont

public void setFont(Font font)

setFont

public final void setFont(String font)

getForegroundColor

public Color getForegroundColor()

Gets the currently foreground color, or null if no color is foreground.

setForegroundColor

public void setForegroundColor(Color foregroundColor)

Sets the currently foreground color.

Parameters:

foregroundColor - The foreground color, or null to specify no selection

setForegroundColor

public void setForegroundColor(String foregroundColor)

Sets the currently foreground color.

Parameters:

foregroundColor - The foreground color

getBackgroundColor

public Color getBackgroundColor()

Gets the currently background color, or null if no color is background.

setBackgroundColor

public void setBackgroundColor(Color backgroundColor)

Sets the currently background color.

Parameters:

backgroundColor - The background color, or null to specify no selection

setBackgroundColor

public void setBackgroundColor(String backgroundColor)

Sets the currently background color.

Parameters:

backgroundColor - The background color

isUnderline

public boolean isUnderline()

setUnderline

public void setUnderline(boolean underline)

isStrikethrough

public boolean isStrikethrough()

setStrikethrough

public void setStrikethrough(boolean strikethrough)

getElementListeners

public org.apache.pivot.util.ListenerList<ElementListener> getElementListeners()