File	Doc	Category	Size	Date	Package
Range.java	API Doc	Java SE 5 API	18620	Fri Aug 26 14:58:42 BST 2005	org.w3c.dom.ranges

Range

Fields Summary
public static final short	START_TO_START Compare start boundary-point of sourceRange to start boundary-point of Range on which compareBoundaryPoints is invoked.
public static final short	START_TO_END Compare start boundary-point of sourceRange to end boundary-point of Range on which compareBoundaryPoints is invoked.
public static final short	END_TO_END Compare end boundary-point of sourceRange to end boundary-point of Range on which compareBoundaryPoints is invoked.
public static final short	END_TO_START Compare end boundary-point of sourceRange to start boundary-point of Range on which compareBoundaryPoints is invoked.

Constructors Summary

Methods Summary
public org.w3c.dom.DocumentFragment	cloneContents() Duplicates the contents of a Range return 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.
public org.w3c.dom.ranges.Range	cloneRange() Produces a new Range whose boundary-points are equal to the boundary-points of the Range. return The duplicated Range. exception DOMException INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.
public void	collapse(boolean toStart) Collapse a Range onto one of its boundary-points param 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.
public short	compareBoundaryPoints(short how, org.w3c.dom.ranges.Range sourceRange) Compare the boundary-points of two Ranges in a document. param how A code representing the type of comparison, as defined above. param sourceRange The Range on which this current Range is compared to. return -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.
public void	deleteContents() 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.
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. 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.
public org.w3c.dom.DocumentFragment	extractContents() Moves the contents of a Range from the containing document or document fragment to a new DocumentFragment. return 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.
public boolean	getCollapsed() TRUE if the Range is collapsed exception DOMException INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.
public org.w3c.dom.Node	getCommonAncestorContainer() 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.
public org.w3c.dom.Node	getEndContainer() Node within which the Range ends exception DOMException INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.
public int	getEndOffset() Offset within the ending node of the Range. exception DOMException INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.
public org.w3c.dom.Node	getStartContainer() Node within which the Range begins exception DOMException INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.
public int	getStartOffset() Offset within the starting node of the Range. exception DOMException INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.
public void	insertNode(org.w3c.dom.Node newNode) 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. param 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.
public void	selectNode(org.w3c.dom.Node refNode) Select a node and its contents param 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.
public void	selectNodeContents(org.w3c.dom.Node refNode) Select the contents within a node param 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.
public void	setEnd(org.w3c.dom.Node refNode, int offset) Sets the attributes describing the end of a Range. param refNode The refNode value. This parameter must be different from null. param 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.
public void	setEndAfter(org.w3c.dom.Node refNode) Sets the end of a Range to be after a node param 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.
public void	setEndBefore(org.w3c.dom.Node refNode) Sets the end position to be before a node. param 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.
public void	setStart(org.w3c.dom.Node refNode, int offset) Sets the attributes describing the start of the Range. param refNode The refNode value. This parameter must be different from null. param 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.
public void	setStartAfter(org.w3c.dom.Node refNode) Sets the start position to be after a node param 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.
public void	setStartBefore(org.w3c.dom.Node refNode) Sets the start position to be before a node param 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.
public 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. param 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.
public java.lang.String	toString() Returns the contents of a Range as a string. This string contains only the data characters, not any markup. return The contents of the Range. exception DOMException INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.