| org.w3c.dom.ranges.Range
All known Subclasses: org.apache.xerces.dom.RangeImpl,
| Field Summary | |
| final public static short | END_TO_END
Compare end boundary-point of sourceRange to end
boundary-point of Range on which compareBoundaryPoints
is invoked. | | final public static short | END_TO_START
Compare end boundary-point of sourceRange to start
boundary-point of Range on which compareBoundaryPoints
is invoked. | | final public static short | START_TO_END
Compare start boundary-point of sourceRange to end
boundary-point of Range on which compareBoundaryPoints
is invoked. | | final public static short | START_TO_START
Compare start boundary-point of sourceRange to start
boundary-point of Range on which compareBoundaryPoints
is invoked. |
| Method Summary | |
| public DocumentFragment | cloneContents()
| | public Range | cloneRange()
Produces a new Range whose boundary-points are equal to the
boundary-points of the Range. | | public void | collapse(boolean toStart)
Collapse a Range onto one of its boundary-points
Parameters:
toStart - If TRUE, collapses the Range onto its start; if FALSE, collapses it onto its end. | | public short | compareBoundaryPoints(short how, Range sourceRange)
Compare the boundary-points of two Ranges in a document.
Parameters:
how - A code representing the type of comparison, as defined above.
Parameters:
sourceRange - The Range on which this current Range is compared to. | | public void | deleteContents()
Removes the contents of a Range from the containing document or
document fragment without returning a reference to the removed
content. | | public void | detach()
Called to indicate that the Range is no longer in use and that the
implementation may relinquish any resources associated with this
Range. | | public DocumentFragment | extractContents()
Moves the contents of a Range from the containing document or document
fragment to a new DocumentFragment. | | public boolean | getCollapsed()
| | public Node | getCommonAncestorContainer()
The deepest common ancestor container of the Range's two
boundary-points. | | public Node | getEndContainer()
| | public int | getEndOffset()
Offset within the ending node of the Range. | | public Node | getStartContainer()
| | public int | getStartOffset()
Offset within the starting node of the Range. | | public void | insertNode(Node newNode)
Inserts a node into the Document or DocumentFragment at the start of
the Range. | | public void | selectNode(Node refNode)
Select a node and its contents
Parameters:
refNode - The node to select. | | public void | selectNodeContents(Node refNode)
| | public void | setEnd(Node refNode, int offset)
Sets the attributes describing the end of a Range.
Parameters:
refNode - The refNode value. | | public void | setEndAfter(Node refNode)
Sets the end of a Range to be after a node
Parameters:
refNode - Range ends after refNode. | | public void | setEndBefore(Node refNode)
Sets the end position to be before a node. | | public void | setStart(Node refNode, int offset)
Sets the attributes describing the start of the Range. | | public void | setStartAfter(Node refNode)
| | public void | setStartBefore(Node refNode)
| | public void | surroundContents(Node newParent)
Reparents the contents of the Range to the given node and inserts the
node at the position of the start of the Range. | | public String | toString()
Returns the contents of a Range as a string. |
| END_TO_END | | final public static short END_TO_END(Code) | | Compare end boundary-point of sourceRange to end
boundary-point of Range on which compareBoundaryPoints
is invoked.
|
| END_TO_START | | final public static short END_TO_START(Code) | | Compare end boundary-point of sourceRange to start
boundary-point of Range on which compareBoundaryPoints
is invoked.
|
| START_TO_END | | final public static short START_TO_END(Code) | | Compare start boundary-point of sourceRange to end
boundary-point of Range on which compareBoundaryPoints
is invoked.
|
| START_TO_START | | final public static short START_TO_START(Code) | | Compare start boundary-point of sourceRange to start
boundary-point of Range on which compareBoundaryPoints
is invoked.
|
| cloneContents | | public DocumentFragment cloneContents() throws DOMException(Code) | | Duplicates the contents of a Range
A DocumentFragment that contains content equivalent to this Range.
exception:
DOMException - HIERARCHY_REQUEST_ERR: Raised if a DocumentType node would be extracted into the new DocumentFragment.
INVALID_STATE_ERR: Raised if detach() has already been invoked on this object. |
| cloneRange | | public Range cloneRange() throws DOMException(Code) | | Produces a new Range whose boundary-points are equal to the
boundary-points of the Range.
The duplicated Range.
exception:
DOMException - INVALID_STATE_ERR: Raised if detach() has already been invoked on this object. |
| collapse | | public void collapse(boolean toStart) throws DOMException(Code) | | Collapse a Range onto one of its boundary-points
Parameters:
toStart - If TRUE, collapses the Range onto its start; if FALSE, collapses it onto its end.
exception:
DOMException - INVALID_STATE_ERR: Raised if detach() has already been invoked on this object. |
| compareBoundaryPoints | | public short compareBoundaryPoints(short how, Range sourceRange) throws DOMException(Code) | | Compare the boundary-points of two Ranges in a document.
Parameters:
how - A code representing the type of comparison, as defined above.
Parameters:
sourceRange - The Range on which this current Range is compared to. -1, 0 or 1 depending on whether the corresponding boundary-point of the Range is respectively before, equal to, or after the corresponding boundary-point of sourceRange.
exception:
DOMException - WRONG_DOCUMENT_ERR: Raised if the two Ranges are not in the same Document or DocumentFragment.
INVALID_STATE_ERR: Raised if detach() has already been invoked on this object. |
| deleteContents | | public void deleteContents() throws DOMException(Code) | | Removes the contents of a Range from the containing document or
document fragment without returning a reference to the removed
content.
exception:
DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if any portion of the content of the Range is read-only or any of the nodes that contain any of the content of the Range are read-only.
INVALID_STATE_ERR: Raised if detach() has already been invoked on this object. |
| detach | | public void detach() throws DOMException(Code) | | Called to indicate that the Range is no longer in use and that the
implementation may relinquish any resources associated with this
Range. Subsequent calls to any methods or attribute getters on this
Range will result in a DOMException being thrown with an
error code of INVALID_STATE_ERR.
exception:
DOMException - INVALID_STATE_ERR: Raised if detach() has already been invoked on this object. |
| extractContents | | public DocumentFragment extractContents() throws DOMException(Code) | | Moves the contents of a Range from the containing document or document
fragment to a new DocumentFragment.
A DocumentFragment containing the extracted contents.
exception:
DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if any portion of the content of the Range is read-only or any of the nodes which contain any of the content of the Range are read-only.
HIERARCHY_REQUEST_ERR: Raised if a DocumentType node would be extracted into the new DocumentFragment.
INVALID_STATE_ERR: Raised if detach() has already been invoked on this object. |
| getCollapsed | | public boolean getCollapsed() throws DOMException(Code) | | TRUE if the Range is collapsed
exception:
DOMException - INVALID_STATE_ERR: Raised if detach() has already been invoked on this object. |
| getCommonAncestorContainer | | public Node getCommonAncestorContainer() throws DOMException(Code) | | The deepest common ancestor container of the Range's two
boundary-points.
exception:
DOMException - INVALID_STATE_ERR: Raised if detach() has already been invoked on this object. |
| getEndContainer | | public Node getEndContainer() throws DOMException(Code) | | Node within which the Range ends
exception:
DOMException - INVALID_STATE_ERR: Raised if detach() has already been invoked on this object. |
| getEndOffset | | public int getEndOffset() throws DOMException(Code) | | Offset within the ending node of the Range.
exception:
DOMException - INVALID_STATE_ERR: Raised if detach() has already been invoked on this object. |
| getStartContainer | | public Node getStartContainer() throws DOMException(Code) | | Node within which the Range begins
exception:
DOMException - INVALID_STATE_ERR: Raised if detach() has already been invoked on this object. |
| getStartOffset | | public int getStartOffset() throws DOMException(Code) | | Offset within the starting node of the Range.
exception:
DOMException - INVALID_STATE_ERR: Raised if detach() has already been invoked on this object. |
| insertNode | | public void insertNode(Node newNode) throws DOMException, RangeException(Code) | | Inserts a node into the Document or DocumentFragment at the start of
the Range. If the container is a Text node, this will be split at the
start of the Range (as if the Text node's splitText method was
performed at the insertion point) and the insertion will occur
between the two resulting Text nodes. Adjacent Text nodes will not be
automatically merged. If the node to be inserted is a
DocumentFragment node, the children will be inserted rather than the
DocumentFragment node itself.
Parameters:
newNode - The node to insert at the start of the Range
exception:
DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if an ancestor container of the start of the Range is read-only.
WRONG_DOCUMENT_ERR: Raised if newNode and the container of the start of the Range were not created from the same document.
HIERARCHY_REQUEST_ERR: Raised if the container of the start of the Range is of a type that does not allow children of the type of newNode or if newNode is an ancestor of the container.
INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.
exception:
RangeException - INVALID_NODE_TYPE_ERR: Raised if newNode is an Attr, Entity, Notation, or Document node. |
| selectNode | | public void selectNode(Node refNode) throws RangeException, DOMException(Code) | | Select a node and its contents
Parameters:
refNode - The node to select.
exception:
RangeException - INVALID_NODE_TYPE_ERR: Raised if an ancestor of refNode is an Entity, Notation or DocumentType node or if refNode is a Document, DocumentFragment, Attr, Entity, or Notation node.
exception:
DOMException - INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.
WRONG_DOCUMENT_ERR: Raised if refNode was created from a different document than the one that created this range. |
| selectNodeContents | | public void selectNodeContents(Node refNode) throws RangeException, DOMException(Code) | | Select the contents within a node
Parameters:
refNode - Node to select from
exception:
RangeException - INVALID_NODE_TYPE_ERR: Raised if refNode or an ancestor of refNode is an Entity, Notation or DocumentType node.
exception:
DOMException - INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.
WRONG_DOCUMENT_ERR: Raised if refNode was created from a different document than the one that created this range. |
| setEnd | | public void setEnd(Node refNode, int offset) throws RangeException, DOMException(Code) | | Sets the attributes describing the end of a Range.
Parameters:
refNode - The refNode value. This parameter must be different from null.
Parameters:
offset - The endOffset value.
exception:
RangeException - INVALID_NODE_TYPE_ERR: Raised if refNode or an ancestor of refNode is an Entity, Notation, or DocumentType node.
exception:
DOMException - INDEX_SIZE_ERR: Raised if offset is negative or greater than the number of child units in refNode. Child units are 16-bit units if refNode is a type of CharacterData node (e.g., a Text or Comment node) or a ProcessingInstruction node. Child units are Nodes in all other cases.
INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.
WRONG_DOCUMENT_ERR: Raised if refNode was created from a different document than the one that created this range. |
| setEndAfter | | public void setEndAfter(Node refNode) throws RangeException, DOMException(Code) | | Sets the end of a Range to be after a node
Parameters:
refNode - Range ends after refNode.
exception:
RangeException - INVALID_NODE_TYPE_ERR: Raised if the root container of refNode is not an Attr, Document or DocumentFragment node or if refNode is a Document, DocumentFragment, Attr, Entity, or Notation node.
exception:
DOMException - INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.
WRONG_DOCUMENT_ERR: Raised if refNode was created from a different document than the one that created this range. |
| setEndBefore | | public void setEndBefore(Node refNode) throws RangeException, DOMException(Code) | | Sets the end position to be before a node.
Parameters:
refNode - Range ends before refNode
exception:
RangeException - INVALID_NODE_TYPE_ERR: Raised if the root container of refNode is not an Attr, Document, or DocumentFragment node or if refNode is a Document, DocumentFragment, Attr, Entity, or Notation node.
exception:
DOMException - INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.
WRONG_DOCUMENT_ERR: Raised if refNode was created from a different document than the one that created this range. |
| setStart | | public void setStart(Node refNode, int offset) throws RangeException, DOMException(Code) | | Sets the attributes describing the start of the Range.
Parameters:
refNode - The refNode value. This parameter must be different from null.
Parameters:
offset - The startOffset value.
exception:
RangeException - INVALID_NODE_TYPE_ERR: Raised if refNode or an ancestor of refNode is an Entity, Notation, or DocumentType node.
exception:
DOMException - INDEX_SIZE_ERR: Raised if offset is negative or greater than the number of child units in refNode. Child units are 16-bit units if refNode is a type of CharacterData node (e.g., a Text or Comment node) or a ProcessingInstruction node. Child units are Nodes in all other cases.
INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.
WRONG_DOCUMENT_ERR: Raised if refNode was created from a different document than the one that created this range. |
| setStartAfter | | public void setStartAfter(Node refNode) throws RangeException, DOMException(Code) | | Sets the start position to be after a node
Parameters:
refNode - Range starts after refNode
exception:
RangeException - INVALID_NODE_TYPE_ERR: Raised if the root container of refNode is not an Attr, Document, or DocumentFragment node or if refNode is a Document, DocumentFragment, Attr, Entity, or Notation node.
exception:
DOMException - INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.
WRONG_DOCUMENT_ERR: Raised if refNode was created from a different document than the one that created this range. |
| setStartBefore | | public void setStartBefore(Node refNode) throws RangeException, DOMException(Code) | | Sets the start position to be before a node
Parameters:
refNode - Range starts before refNode
exception:
RangeException - INVALID_NODE_TYPE_ERR: Raised if the root container of refNode is not an Attr, Document, or DocumentFragment node or if refNode is a Document, DocumentFragment, Attr, Entity, or Notation node.
exception:
DOMException - INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.
WRONG_DOCUMENT_ERR: Raised if refNode was created from a different document than the one that created this range. |
| surroundContents | | public void surroundContents(Node newParent) throws DOMException, RangeException(Code) | | Reparents the contents of the Range to the given node and inserts the
node at the position of the start of the Range.
Parameters:
newParent - The node to surround the contents with.
exception:
DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if an ancestor container of either boundary-point of the Range is read-only.
WRONG_DOCUMENT_ERR: Raised if newParent and the container of the start of the Range were not created from the same document.
HIERARCHY_REQUEST_ERR: Raised if the container of the start of the Range is of a type that does not allow children of the type of newParent or if newParent is an ancestor of the container or if node would end up with a child node of a type not allowed by the type of node.
INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.
exception:
RangeException - BAD_BOUNDARYPOINTS_ERR: Raised if the Range partially selects a non-text node.
INVALID_NODE_TYPE_ERR: Raised if node is an Attr, Entity, DocumentType, Notation, Document, or DocumentFragment node. |
| toString | | public String toString() throws DOMException(Code) | | Returns the contents of a Range as a string. This string contains only
the data characters, not any markup.
The contents of the Range.
exception:
DOMException - INVALID_STATE_ERR: Raised if detach() has already been invoked on this object. |
|
|