Table 15-24 summarizes the methods of available through Range interface.
Table 15-24 Summary of Range Methods; Dom Package
Function | Summary |
---|---|
CompareBoundaryPoints
|
|
cloneContent
|
|
cloneRange
|
|
deleteContents
|
|
detach
|
Invalidate the range. |
extractContent
|
|
getCollapsed
|
Check if the range is collapsed. |
getCommonAncestorContainer
|
Get the deepest common ancestor node. |
getEndContainer
|
Get end container node. |
getEndOffset
|
Get offset of the end point. |
getStartContainer
|
Get start container node. |
getStartOffset
|
Get offset of the start point. |
insertNode
|
|
selectNodeContent
|
|
selectNode
|
|
setEnd
|
Set end point. |
setEndAfter
|
|
setEndBefore
|
|
setStart
|
Set start point. |
setStartAfter
|
|
setStartBefore
|
|
surroundContents
|
|
toString
|
|
Compares boundary points.
CompareHowCode compareBoundaryPoints( unsigned short how, Range< Node>* sourceRange) throw (DOMException);
Parameter | Description |
---|---|
how |
how to compare |
sourceRange |
range of comparison |
(CompareHowCode)
result of comparison
Makes a clone of the node, including its children.
Node* cloneContents() throw (DOMException);
(Node*)
subtree cloned
Clones a range of nodes.
Range< Node>* cloneRange();
(Range< Node>*)
new cloned range
Deletes contents of the node.
void deleteContents() throw (DOMException);
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();
Extract the node.
Node* extractContents() throw (DOMException);
(Node*)
subtree extracted
Checks if the range is collapsed.
boolean getCollapsed() const;
(boolean)
TRUE
if the range is collapsed, FALSE
otherwise
Get the deepest common ancestor of the node.
Node* getCommonAncestorContainer() const;
(Node*)
common ancestor node
Gets the container node.
Node* getEndContainer() const;
(Node*)
end container node
Get offset of the end point.
long getEndOffset() const;
(long)
offset
Get start container node.
Node* getStartContainer() const;
(Node*)
start container node
Get offset of the start point.
long getStartOffset() const;
(long)
offset
Inserts a node.
void insertNode( NodeRef< Node>& newNode) throw (RangeException, DOMException);
Parameter | Description |
---|---|
newNode |
inserted node |
Selects node content by its reference.
void selectNodeContent( NodeRef< Node>& refNode) throw (RangeException);
Parameter | Description |
---|---|
refNode |
reference node |
Selects a node.
void selectNode( NodeRef< Node>& refNode) throw (RangeException);
Parameter | Description |
---|---|
refNode |
reference node |
Sets an end point.
void setEnd( NodeRef< Node>& refNode, long offset) throw (RangeException, DOMException);
Parameter | Description |
---|---|
refNode |
reference node |
offset |
offset |
Sets the end pointer after a specified node.
void setEndAfter( NodeRef< Node>& refNode) throw (RangeException);
Parameter | Description |
---|---|
refNode |
reference node |
Set the end before a specified node.
void setEndBefore( NodeRef< Node>& refNode) throw (RangeException);
Parameter | Description |
---|---|
refNode |
reference node |
Sets start point.
void setStart( NodeRef< Node>& refNode, long offset) throw (RangeException, DOMException);
Parameter | Description |
---|---|
refNode |
reference node |
offset |
offset |
Sets start pointer after a specified node.
void setStartAfter( NodeRef< Node>& refNode) throw (RangeException);
Parameter | Description |
---|---|
refNode |
reference node |
Sets start pointer before a specified node.
void setStartBefore( NodeRef< Node>& refNode) throw (RangeException);
Parameter | Description |
---|---|
refNode |
reference node |
Makes a node into a child of the specified node.
void surroundContents( NodeRef< Node>& newParent) throw (RangeException, DOMException);
Parameter | Description |
---|---|
newParent |
parent node |
Converts an item into a string.
oratext* toString();
(oratext*)
string representation of the range