public class RangeImpl
extends java.lang.Object
implements org.w3c.dom.ranges.Range
Please see the API documentation for the interface classes and use the interfaces in your client programs.
| Constructor and Description |
|---|
RangeImpl(DocumentImpl document)
The constructor.
|
| Modifier and Type | Method and Description |
|---|---|
org.w3c.dom.DocumentFragment |
cloneContents()
Duplicates the contents of a Range
|
org.w3c.dom.ranges.Range |
cloneRange()
Produces a new Range whose boundary-points are equal to the
boundary-points of the Range.
|
void |
collapse(boolean toStart)
Collapse a Range onto one of its boundary-points
|
short |
compareBoundaryPoints(short how,
org.w3c.dom.ranges.Range sourceRange)
Compare the boundary-points of two Ranges in a document.
|
void |
deleteContents()
Removes the contents of a Range from the containing document or
document fragment without returning a reference to the removed
content.
|
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.
|
org.w3c.dom.DocumentFragment |
extractContents()
Moves the contents of a Range from the containing document or document
fragment to a new DocumentFragment.
|
boolean |
getCollapsed()
TRUE if the Range is collapsed
|
org.w3c.dom.Node |
getCommonAncestorContainer()
The deepest common ancestor container of the Range's two
boundary-points.
|
org.w3c.dom.Node |
getEndContainer()
Node within which the Range ends
|
int |
getEndOffset()
Offset within the ending node of the Range.
|
org.w3c.dom.Node |
getStartContainer()
Node within which the Range begins
|
int |
getStartOffset()
Offset within the starting node of the Range.
|
void |
insertedNodeFromDOM(org.w3c.dom.Node node)
This function is called from the DOM.
|
void |
insertNode(org.w3c.dom.Node newNode)
Inserts a node into the Document or DocumentFragment at the start of
the Range.
|
void |
selectNode(org.w3c.dom.Node refNode)
Select a node and its contents
|
void |
selectNodeContents(org.w3c.dom.Node refNode)
Select the contents within a node
|
void |
setEnd(org.w3c.dom.Node refNode,
int offset)
Sets the attributes describing the end of a Range.
|
void |
setEndAfter(org.w3c.dom.Node refNode)
Sets the end of a Range to be after a node
|
void |
setEndBefore(org.w3c.dom.Node refNode)
Sets the end position to be before a node.
|
void |
setStart(org.w3c.dom.Node refNode,
int offset)
Sets the attributes describing the start of the Range.
|
void |
setStartAfter(org.w3c.dom.Node refNode)
Sets the start position to be after a node
|
void |
setStartBefore(org.w3c.dom.Node refNode)
Sets the start position to be before a node
|
void |
surroundContents(org.w3c.dom.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.
|
java.lang.String |
toString()
Returns the contents of a Range as a string.
|
public RangeImpl(DocumentImpl document)
public org.w3c.dom.Node getStartContainer()
org.w3c.dom.ranges.RangegetStartContainer in interface org.w3c.dom.ranges.Rangepublic int getStartOffset()
org.w3c.dom.ranges.RangegetStartOffset in interface org.w3c.dom.ranges.Rangepublic org.w3c.dom.Node getEndContainer()
org.w3c.dom.ranges.RangegetEndContainer in interface org.w3c.dom.ranges.Rangepublic int getEndOffset()
org.w3c.dom.ranges.RangegetEndOffset in interface org.w3c.dom.ranges.Rangepublic boolean getCollapsed()
org.w3c.dom.ranges.RangegetCollapsed in interface org.w3c.dom.ranges.Rangepublic org.w3c.dom.Node getCommonAncestorContainer()
org.w3c.dom.ranges.RangegetCommonAncestorContainer in interface org.w3c.dom.ranges.Rangepublic void setStart(org.w3c.dom.Node refNode,
int offset)
throws org.w3c.dom.ranges.RangeException,
org.w3c.dom.DOMException
org.w3c.dom.ranges.RangesetStart in interface org.w3c.dom.ranges.RangerefNode - The refNode value. This parameter must be
different from null.offset - The startOffset value.org.w3c.dom.ranges.RangeException - INVALID_NODE_TYPE_ERR: Raised if refNode or an ancestor
of refNode is an Entity, Notation, or DocumentType
node.org.w3c.dom.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.
detach() has already
been invoked on this object.
refNode was created
from a different document than the one that created this range.public void setEnd(org.w3c.dom.Node refNode,
int offset)
throws org.w3c.dom.ranges.RangeException,
org.w3c.dom.DOMException
org.w3c.dom.ranges.RangesetEnd in interface org.w3c.dom.ranges.RangerefNode - The refNode value. This parameter must be
different from null.offset - The endOffset value.org.w3c.dom.ranges.RangeException - INVALID_NODE_TYPE_ERR: Raised if refNode or an ancestor
of refNode is an Entity, Notation, or DocumentType
node.org.w3c.dom.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.
detach() has already
been invoked on this object.
refNode was created
from a different document than the one that created this range.public void setStartBefore(org.w3c.dom.Node refNode)
throws org.w3c.dom.ranges.RangeException
org.w3c.dom.ranges.RangesetStartBefore in interface org.w3c.dom.ranges.RangerefNode - Range starts before refNodeorg.w3c.dom.ranges.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.public void setStartAfter(org.w3c.dom.Node refNode)
throws org.w3c.dom.ranges.RangeException
org.w3c.dom.ranges.RangesetStartAfter in interface org.w3c.dom.ranges.RangerefNode - Range starts after refNodeorg.w3c.dom.ranges.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.public void setEndBefore(org.w3c.dom.Node refNode)
throws org.w3c.dom.ranges.RangeException
org.w3c.dom.ranges.RangesetEndBefore in interface org.w3c.dom.ranges.RangerefNode - Range ends before refNodeorg.w3c.dom.ranges.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.public void setEndAfter(org.w3c.dom.Node refNode)
throws org.w3c.dom.ranges.RangeException
org.w3c.dom.ranges.RangesetEndAfter in interface org.w3c.dom.ranges.RangerefNode - Range ends after refNode.org.w3c.dom.ranges.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.public void collapse(boolean toStart)
org.w3c.dom.ranges.Rangecollapse in interface org.w3c.dom.ranges.RangetoStart - If TRUE, collapses the Range onto its start; if FALSE,
collapses it onto its end.public void selectNode(org.w3c.dom.Node refNode)
throws org.w3c.dom.ranges.RangeException
org.w3c.dom.ranges.RangeselectNode in interface org.w3c.dom.ranges.RangerefNode - The node to select.org.w3c.dom.ranges.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.public void selectNodeContents(org.w3c.dom.Node refNode)
throws org.w3c.dom.ranges.RangeException
org.w3c.dom.ranges.RangeselectNodeContents in interface org.w3c.dom.ranges.RangerefNode - Node to select fromorg.w3c.dom.ranges.RangeException - INVALID_NODE_TYPE_ERR: Raised if refNode or an ancestor
of refNode is an Entity, Notation or DocumentType node.public short compareBoundaryPoints(short how,
org.w3c.dom.ranges.Range sourceRange)
throws org.w3c.dom.DOMException
org.w3c.dom.ranges.RangecompareBoundaryPoints in interface org.w3c.dom.ranges.Rangehow - A code representing the type of comparison, as defined
above.sourceRange - The Range on which this current
Range is compared to.sourceRange.org.w3c.dom.DOMException - WRONG_DOCUMENT_ERR: Raised if the two Ranges are not in the same
Document or DocumentFragment.
detach() has already
been invoked on this object.public void deleteContents()
throws org.w3c.dom.DOMException
org.w3c.dom.ranges.RangedeleteContents in interface org.w3c.dom.ranges.Rangeorg.w3c.dom.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.
detach() has already
been invoked on this object.public org.w3c.dom.DocumentFragment extractContents()
throws org.w3c.dom.DOMException
org.w3c.dom.ranges.RangeextractContents in interface org.w3c.dom.ranges.Rangeorg.w3c.dom.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.
detach() has already
been invoked on this object.public org.w3c.dom.DocumentFragment cloneContents()
throws org.w3c.dom.DOMException
org.w3c.dom.ranges.RangecloneContents in interface org.w3c.dom.ranges.Rangeorg.w3c.dom.DOMException - HIERARCHY_REQUEST_ERR: Raised if a DocumentType node would be
extracted into the new DocumentFragment.
detach() has already
been invoked on this object.public void insertNode(org.w3c.dom.Node newNode)
throws org.w3c.dom.DOMException,
org.w3c.dom.ranges.RangeException
org.w3c.dom.ranges.RangeinsertNode in interface org.w3c.dom.ranges.RangenewNode - The node to insert at the start of the Rangeorg.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if an ancestor container of the
start of the Range is read-only.
newNode and the
container of the start of the Range were not created from the same
document.
newNode or if newNode is an ancestor of
the container.
detach() has already
been invoked on this object.org.w3c.dom.ranges.RangeException - INVALID_NODE_TYPE_ERR: Raised if newNode is an Attr,
Entity, Notation, or Document node.public void surroundContents(org.w3c.dom.Node newParent)
throws org.w3c.dom.DOMException,
org.w3c.dom.ranges.RangeException
org.w3c.dom.ranges.RangesurroundContents in interface org.w3c.dom.ranges.RangenewParent - The node to surround the contents with.org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if an ancestor container of
either boundary-point of the Range is read-only.
newParent and the
container of the start of the Range were not created from the same
document.
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.
detach() has already
been invoked on this object.org.w3c.dom.ranges.RangeException - BAD_BOUNDARYPOINTS_ERR: Raised if the Range partially selects a
non-text node.
node is an Attr,
Entity, DocumentType, Notation, Document, or DocumentFragment node.public org.w3c.dom.ranges.Range cloneRange()
org.w3c.dom.ranges.RangecloneRange in interface org.w3c.dom.ranges.Rangepublic java.lang.String toString()
org.w3c.dom.ranges.RangetoString in interface org.w3c.dom.ranges.RangetoString in class java.lang.Objectpublic void detach()
org.w3c.dom.ranges.RangeDOMException being thrown with an
error code of INVALID_STATE_ERR.detach in interface org.w3c.dom.ranges.Rangepublic void insertedNodeFromDOM(org.w3c.dom.Node node)
Copyright © 1999-2010 The Apache Software Foundation. All Rights Reserved.