class Range Full name DOM::Range Definition #include <dom2_range.h> List of all Methods

Annotated List Files Globals Hierarchy Index

Public Types

• enum CompareHow {START_TO_START = 0, START_TO_END = 1, END_TO_END = 2, END_TO_START = 3 }

Public Methods

•  Range ()
•  Range (const Document rootContainer)
•  Range (const Range &other)
•  Range (const Node startContainer, const long startOffset, const Node endContainer, const long endOffset)
• Range &  operator = (const Range &other)
• ~ Range ()
• Node  startContainer () const
• long  startOffset () const
• Node  endContainer () const
• long  endOffset () const
• bool  collapsed () const
• Node  commonAncestorContainer ()
• void  setStart ( const Node &refNode, long offset )
• void  setEnd ( const Node &refNode, long offset )
• void  setStartBefore ( const Node &refNode )
• void  setStartAfter ( const Node &refNode )
• void  setEndBefore ( const Node &refNode )
• void  setEndAfter ( const Node &refNode )
• void  collapse ( bool toStart )
• void  selectNode ( const Node &refNode )
• void  selectNodeContents ( const Node &refNode )
• short  compareBoundaryPoints ( CompareHow how, const Range &sourceRange )
• bool  boundaryPointsValid ( )
• void  deleteContents ( )
• DocumentFragment  extractContents ( )
• DocumentFragment  cloneContents ( )
• void  insertNode ( const Node &newNode )
• void  surroundContents ( const Node &newParent )
• Range  cloneRange ( )
• DOMString  toString ( )
• DOMString  toHTML ( )
• void  detach ( )
• bool  isDetached () const
• RangeImpl * handle () const
• bool  isNull () const

Protected Methods

•  Range (RangeImpl *i)

Protected Members

• RangeImpl *impl

[const]

Node within which the range begins

[const]

Offset within the starting node of the range.

[const]

Node within which the range ends

[const]

Offset within the ending node of the range.

[const]

TRUE if the range is collapsed

Gets the common ancestor container of the range's two end-points. Also sets it.

Sets the attributes describing the start of the range.

INVALID_NODE_TYPE_ERR: Raised if <code> refNode </code> or an ancestor of <code> refNode </code> is an Attr, Entity, Notation, or DocumentType node.

If an offset is out-of-bounds, should it just be fixed up or should an exception be raised.

Parameters:

refNode	The <code> refNode </code> value. This parameter must be different from <code> null </code> .
offset	The <code> startOffset </code> value.

Throws: RangeException, NULL_NODE_ERR:, Raised, if, <code>, refNode, </code>, is, <code>, null, </code>, .

Sets the attributes describing the end of a range.

INVALID_NODE_TYPE_ERR: Raised if <code> refNode </code> or an ancestor of <code> refNode </code> is an Attr, Entity, Notation, or DocumentType node.

Parameters:

refNode	The <code> refNode </code> value. This parameter must be different from <code> null </code> .
offset	The <code> endOffset </code> value.

Throws: RangeException, NULL_NODE_ERR:, Raised, if, <code>, refNode, </code>, is, <code>, null, </code>, .

Sets the start position to be before a node

Parameters:

refNode

Range starts before <code> refNode </code>

Throws: RangeException, INVALID_NODE_TYPE_ERR:, Raised, if, an, ancestor, of, <code>, refNode, </code>, is, an, Attr, Entity, Notation, or, DocumentType, node, or, if, <code>, refNode, </code>, is, a, Document, DocumentFragment, Attr, Entity, or, Notation, node.

Sets the start position to be after a node

Parameters:

refNode

Range starts after <code> refNode </code>

Throws: RangeException, INVALID_NODE_TYPE_ERR:, Raised, if, an, ancestor, of, <code>, refNode, </code>, is, an, Attr, Entity, Notation, or, DocumentType, node, or, if, <code>, refNode, </code>, is, a, Document, DocumentFragment, Attr, Entity, or, Notation, node.

Sets the end position to be before a node.

Parameters:

refNode

Range ends before <code> refNode </code>

Throws: RangeException, INVALID_NODE_TYPE_ERR:, Raised, if, an, ancestor, of, <code>, refNode, </code>, is, an, Attr, Entity, Notation, or, DocumentType, node, or, if, <code>, refNode, </code>, is, a, Document, DocumentFragment, Attr, Entity, or, Notation, node.

Sets the end of a range to be after a node

Parameters:

refNode

Range ends after <code> refNode </code> .

Throws: RangeException, INVALID_NODE_TYPE_ERR:, Raised, if, an, ancestor, of, <code>, refNode, </code>, is, an, Attr, Entity, Notation, or, DocumentType, node, or, if, <code>, refNode, </code>, is, a, Document, DocumentFragment, Attr, Entity, or, Notation, node.

Collapse a range onto one of its end-points

Parameters:

toStart

If TRUE, collapses the Range onto its start; if FALSE, collapses it onto its end.

Select a node and its contents

Parameters:

refNode

The node to select.

Throws: RangeException, INVALID_NODE_TYPE_ERR:, Raised, if, an, ancestor, of, <code>, refNode, </code>, is, an, Attr, Entity, Notation, or, DocumentType, node, or, if, <code>, refNode, </code>, is, a, Document, DocumentFragment, Attr, Entity, or, Notation, node.

Select the contents within a node

Parameters:

refNode

Node to select from

Throws: RangeException, INVALID_NODE_TYPE_ERR:, Raised, if, <code>, refNode, </code>, or, an, ancestor, of, <code>, refNode, </code>, is, an, Attr, Entity, Notation, or, DocumentType, node.

Compare the end-points of two ranges in a document.

Returns: -1, 0 or 1 depending on whether the corresponding end-point of the Range is before, equal to, or after the corresponding end-point of <code> sourceRange </code> .

Throws: DOMException, WRONG_DOCUMENT_ERR:, Raised, if, the, two, Ranges, are, not, in, the, same, document, or, document, fragment.

not part of the DOM

Compare the boundary-points of a range.

Return true if the startContainer is before the endContainer, or if they are equal. Return false if the startContainer is after the endContainer.

Removes the contents of a range from the containing document or document fragment without returning a reference to the removed content.

Throws: 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.

Moves the contents of a range from the containing document or document fragment to a new DocumentFragment.

HIERARCHY_REQUEST_ERR: Raised if a DocumentType node would be extracted into the new DocumentFragment.

Returns: A DocumentFragment containing the extracted contents.

Throws: 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.

Duplicates the contents of a range

Returns: A DocumentFragment containing contents equivalent to those of this range.

Throws: DOMException, HIERARCHY_REQUEST_ERR:, Raised, if, a, DocumentType, node, would, be, extracted, into, the, new, DocumentFragment.

Inserts a node into the document or document fragment at the start of the range.

WRONG_DOCUMENT_ERR: Raised if <code> newNode </code> 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 <code> newNode </code> or if <code> newNode </code> is an ancestor of the container .

Parameters:

newNode

The node to insert at the start of the range

Throws: DOMException, NO_MODIFICATION_ALLOWED_ERR:, Raised, if, an, ancestor, container, of, the, start, of, the, range, is, read-only., RangeException, INVALID_NODE_TYPE_ERR:, Raised, if, <code>, node, </code>, is, an, Attr, Entity, Notation, DocumentFragment, or, Document, node.

Reparents the contents of the range to the given node and inserts the node at the position of the start of the range.

WRONG_DOCUMENT_ERR: Raised if <code> newParent </code> 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 <code> newParent </code> or if <code> newParent </code> is an ancestor of the container or if <code> node </code> would end up with a child node of a type not allowed by the type of <code> node </code> .

INVALID_NODE_TYPE_ERR: Raised if <code> node </code> is an Attr, Entity, DocumentType, Notation, Document, or DocumentFragment node.

Parameters:

newParent

The node to surround the contents with.

Throws: DOMException, NO_MODIFICATION_ALLOWED_ERR:, Raised, if, an, ancestor, container, of, either, end-point, of, the, range, is, read-only., RangeException, BAD_ENDPOINTS_ERR:, Raised, if, the, range, partially, selects, a, non-text, node.

Produces a new range whose end-points are equal to the end-points of the range.

Returns: The duplicated range.

Returns the contents of a range as a string.

Returns: The contents of the range.

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.

[const]

not part of the DOM TRUE if the range is detached

[const]

not part of the DOM