Range Interface

Table 15-24 summarizes the methods of available through Range interface.

CompareBoundaryPoints

Compares boundary points.

CompareHowCode compareBoundaryPoints( 
   unsigned short how,
   Range< Node>* sourceRange)
throw (DOMException);

how

sourceRange

(CompareHowCode) result of comparison

cloneContent

Makes a clone of the node, including its children.

Node* cloneContents() throw (DOMException);

(Node*) subtree cloned

cloneRange

Clones a range of nodes.

Range< Node>* cloneRange();

(Range< Node>*) new cloned range

deleteContents

Deletes contents of the node.

void deleteContents() throw (DOMException);

detach

Invalidates the range. It is not recommended to use this method since it leaves the object in invalid state. The preferable way is to call the destructor.

void detach();

extractContent

Extract the node.

Node* extractContents() throw (DOMException);

(Node*) subtree extracted

getCollapsed

Checks if the range is collapsed.

boolean getCollapsed() const;

(boolean) TRUE if the range is collapsed, FALSE otherwise

getCommonAncestorContainer

Get the deepest common ancestor of the node.

Node* getCommonAncestorContainer() const;

(Node*) common ancestor node

getEndContainer

Gets the container node.

Node* getEndContainer() const;

(Node*) end container node

getEndOffset

Get offset of the end point.

long getEndOffset() const;

(long) offset

getStartContainer

Get start container node.

Node* getStartContainer() const;

(Node*) start container node

getStartOffset

Get offset of the start point.

long getStartOffset() const;

(long) offset

insertNode

Inserts a node.

void insertNode( 
   NodeRef< Node>& newNode)
throw (RangeException, DOMException);

newNode

selectNodeContent

Selects node content by its reference.

void selectNodeContent( 
   NodeRef< Node>& refNode)
throw (RangeException);

refNode

selectNode

Selects a node.

void selectNode( 
   NodeRef< Node>& refNode)
throw (RangeException);

refNode

setEnd

Sets an end point.

void setEnd( 
   NodeRef< Node>& refNode, 
   long offset)
throw (RangeException, DOMException);

refNode

offset

setEndAfter

Sets the end pointer after a specified node.

void setEndAfter( 
   NodeRef< Node>& refNode)
throw (RangeException);

refNode

setEndBefore

Set the end before a specified node.

void setEndBefore( 
   NodeRef< Node>& refNode)
throw (RangeException);

refNode

setStart

Sets start point.

void setStart( 
   NodeRef< Node>& refNode, 
   long offset)
throw (RangeException, DOMException);

refNode

offset

setStartAfter

Sets start pointer after a specified node.

void setStartAfter( 
   NodeRef< Node>& refNode)
throw (RangeException);

refNode

setStartBefore

Sets start pointer before a specified node.

void setStartBefore( 
   NodeRef< Node>& refNode)
throw (RangeException);

refNode

surroundContents

Makes a node into a child of the specified node.

void surroundContents( 
   NodeRef< Node>& newParent)
throw (RangeException, DOMException);

newParent

toString

Converts an item into a string.

oratext* toString();

(oratext*) string representation of the range