|
||||||||
PREV CLASS NEXT CLASS | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
See also the Document Object Model (DOM) Level 2 Traversal and Range Specification.
Field Summary | |
static short |
END_TO_END
Compare end boundary-point of sourceRange to end boundary-point of Range on
which compareBoundaryPoints is invoked. |
static short |
END_TO_START
Compare end boundary-point of sourceRange to start boundary-point of Range on
which compareBoundaryPoints is invoked. |
static short |
START_TO_END
Compare start boundary-point of sourceRange to end boundary-point of Range on
which compareBoundaryPoints is invoked. |
static short |
START_TO_START
Compare start boundary-point of sourceRange to start boundary-point of Range on
which compareBoundaryPoints is invoked. |
Method Summary | |
DocumentFragment |
cloneContents()
Duplicates the contents of a Range |
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, 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. |
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 |
Node |
getCommonAncestorContainer()
The deepest common ancestor container of the Range's two boundary-points. |
Node |
getEndContainer()
Node within which the Range ends |
int |
getEndOffset()
Offset within the ending node of the Range. |
Node |
getStartContainer()
Node within which the Range begins |
int |
getStartOffset()
Offset within the starting node of the Range. |
void |
insertNode(Node newNode) Inserts a node into the Document or DocumentFragment at the start of the Range. |
void |
selectNode(Node refNode) Select a node and its contents |
void |
selectNodeContents(Node refNode) Select the contents within a node |
void |
setEnd(Node refNode,
int offset) Sets the attributes describing the end of a Range. |
void |
setEndAfter(Node refNode) Sets the end of a Range to be after a node |
void |
setEndBefore(Node refNode) Sets the end position to be before a node. |
void |
setStart(Node refNode,
int offset) Sets the attributes describing the start of the Range. |
void |
setStartAfter(Node refNode) Sets the start position to be after a node |
void |
setStartBefore(Node refNode) Sets the start position to be before a node |
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. |
java.lang.String |
toString()
Returns the contents of a Range as a string. |
Field Detail |
public static final short START_TO_START
sourceRange
to start
boundary-point of Range on which compareBoundaryPoints
is
invoked.public static final short START_TO_END
sourceRange
to end
boundary-point of Range on which compareBoundaryPoints
is
invoked.public static final short END_TO_END
sourceRange
to end
boundary-point of Range on which compareBoundaryPoints
is
invoked.public static final short END_TO_START
sourceRange
to start
boundary-point of Range on which compareBoundaryPoints
is
invoked.Method Detail |
public Node getStartContainer() throws DOMException
detach()
has already been invoked on
this object.public int getStartOffset() throws DOMException
detach()
has already been invoked on
this object.public Node getEndContainer() throws DOMException
detach()
has already been invoked on
this object.public int getEndOffset() throws DOMException
detach()
has already been invoked on
this object.public boolean getCollapsed() throws DOMException
detach()
has already been invoked on
this object.public Node getCommonAncestorContainer() throws DOMException
detach()
has already been invoked on
this object.public void setStart(Node refNode, int offset) throws RangeException, DOMException
refNode
- The refNode
value. This parameter must
be different from null
.offset
- The startOffset
value.refNode
or an ancestor of
refNode
is an Entity, Notation, or DocumentType node.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(Node refNode, int offset) throws RangeException, DOMException
refNode
- The refNode
value. This parameter must
be different from null
.offset
- The endOffset
value.refNode
or an ancestor of
refNode
is an Entity, Notation, or DocumentType node.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(Node refNode) throws RangeException, DOMException
refNode
- Range starts before refNode
refNode
is
not an Attr, Document, or DocumentFragment node or if refNode
is a
Document, DocumentFragment, Attr, Entity, or Notation node.detach()
has already been invoked on
this object.refNode
was created from a different
document than the one that created this range.public void setStartAfter(Node refNode) throws RangeException, DOMException
refNode
- Range starts after refNode
refNode
is
not an Attr, Document, or DocumentFragment node or if refNode
is a
Document, DocumentFragment, Attr, Entity, or Notation node.detach()
has already been invoked on
this object.refNode
was created from a different
document than the one that created this range.public void setEndBefore(Node refNode) throws RangeException, DOMException
refNode
- Range ends before refNode
refNode
is
not an Attr, Document, or DocumentFragment node or if refNode
is a
Document, DocumentFragment, Attr, Entity, or Notation node.detach()
has already been invoked on
this object.refNode
was created from a different
document than the one that created this range.public void setEndAfter(Node refNode) throws RangeException, DOMException
refNode
- Range ends after refNode
.refNode
is
not an Attr, Document or DocumentFragment node or if refNode
is a
Document, DocumentFragment, Attr, Entity, or Notation node.detach()
has already been invoked on
this object.refNode
was created from a different
document than the one that created this range.public void collapse(boolean toStart) throws DOMException
toStart
- If TRUE, collapses the Range onto its start; if
FALSE, collapses it onto its end.detach()
has already been invoked on
this object.public void selectNode(Node refNode) throws RangeException, DOMException
refNode
- The node to select.refNode
is an
Entity, Notation or DocumentType node or if refNode
is a Document,
DocumentFragment, Attr, Entity, or Notation node.detach()
has already been invoked on
this object.refNode
was created from a different
document than the one that created this range.public void selectNodeContents(Node refNode) throws RangeException, DOMException
refNode
- Node to select fromrefNode
or an ancestor of
refNode
is an Entity, Notation or DocumentType node.detach()
has already been invoked on
this object.refNode
was created from a different
document than the one that created this range.public short compareBoundaryPoints(short how, Range sourceRange) throws DOMException
how
- A code representing the type of comparison, as defined
above.sourceRange
- The Range
on which this current
Range
is compared to.sourceRange
.detach()
has already been invoked on
this object.public void deleteContents() throws DOMException
detach()
has already been invoked on
this object.public DocumentFragment extractContents() throws DOMException
detach()
has already been invoked on
this object.public DocumentFragment cloneContents() throws DOMException
detach()
has already been invoked on
this object.public void insertNode(Node newNode) throws DOMException, RangeException
newNode
- The node to insert at the start of the RangenewNode
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.newNode
is an Attr, Entity,
Notation, or Document node.public void surroundContents(Node newParent) throws DOMException, RangeException
newParent
- The node to surround the contents with.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.node
is an Attr, Entity,
DocumentType, Notation, Document, or DocumentFragment node.public Range cloneRange() throws DOMException
detach()
has already been invoked on
this object.public java.lang.String toString() throws DOMException
detach()
has already been invoked on
this object.public void detach() throws DOMException
DOMException
being thrown with an error code of
INVALID_STATE_ERR
.detach()
has already been invoked on
this object.
|
||||||||
PREV CLASS NEXT CLASS | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2000 W3C® (MIT, INRIA, Keio), All Rights Reserved. W3C liability, trademark, document useand software licensing rules apply. Your interactions with this site are in accordance with our public and Member privacy statements.