org.mozilla.webclient
Interface Selection

public interface Selection

Selection is more like a DOM Range object which represents a portion of a document or a document fragment. This is described as all of the content between two boundary points, the start and end containers. A selection is define by the following properties: startContainer, endContainer, startOffset, endOffset and the text representation of the selection.

• startContainer: This property is a reference to a Node within the document or document fragment. The start of the range is contained within this node and the boundary point is determined by the startOffset property.
• endContainer: This property is a reference to a Node within the document or document fragment. The end of the range is contained within this node and the boundary point is determined by the endOffset property.
• startOffset: This property has one of two meanings, depending upon the type of node that the startContainer references. If the startContainer is a Text node, Comment node or a CDATASection node then this offset represents the number of characters from the beginning of the node to where the boundary point lies. Any other type of node and it represents the child node index number that the boundary point lies BEFORE. If the offset is equal to the number of child nodes then the boundary point lies after the last child node.
• endOffset: This property has one of two meanings, depending upon the type of node that the endContainer references. If the endContainer is a Text node, Comment node or a CDATASection node then this offset represents the number of characters from the beginning of the node to where the boundary point lies. Any other type of node and it represents the child node index number that the boundary point lies BEFORE. If the offset is equal to the number of child nodes then the boundary point lies after the last child node.

Author:

daepark@apmindsf.com

Method Summary

org.w3c.dom.Node	getEndContainer() Get the Node that contains the end of this selection.
int	getEndOffset() Get the offset to which the selection ends within the endContainer.
org.w3c.dom.Node	getStartContainer() Get the Node that contains the start of this selection.
int	getStartOffset() Get the offset to which the selection starts within the startContainer.
void	init(java.lang.String selection, org.w3c.dom.Node startContainer, org.w3c.dom.Node endContainer, int startOffset, int endOffset) Initialize this Selection object.
boolean	isValid() Test if the selection properties have been set.
java.lang.String	toString() Get the text representation of this Selection object.

Method Detail

init

void init(java.lang.String selection,
          org.w3c.dom.Node startContainer,
          org.w3c.dom.Node endContainer,
          int startOffset,
          int endOffset)

Initialize this Selection object.

Parameters:

selection - the text representation of this selection

startContainer - the start of this selection is contained within this node

endContainer - the end of this selection is contained within this node

startOffset - the offset to which the selection starts within the startContainer

endOffset - the offset to which the selection ends within the endContainer

See Also:

isValid()

toString

java.lang.String toString()

Get the text representation of this Selection object.

Overrides:

toString in class java.lang.Object

getStartContainer

org.w3c.dom.Node getStartContainer()

Get the Node that contains the start of this selection.

getEndContainer

org.w3c.dom.Node getEndContainer()

Get the Node that contains the end of this selection.

getStartOffset

int getStartOffset()

Get the offset to which the selection starts within the startContainer.

getEndOffset

int getEndOffset()

Get the offset to which the selection ends within the endContainer.

isValid

boolean isValid()

Test if the selection properties have been set.