/*******************************************************************************
 * Copyright (c) 2001, 2004 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     Jens Lukowski/Innoopract - initial renaming/restructuring
 *     
 *******************************************************************************/

package org.w3c.dom.ranges;

import org.w3c.dom.DOMException;
import org.w3c.dom.DocumentFragment;
import org.w3c.dom.Node;

/**
 * <p>
 * See also the <a
 * href='http://www.w3.org/TR/2000/REC-DOM-Level-2-Traversal-Range-20001113'>Document
 * Object Model (DOM) Level 2 Traversal and Range Specification </a>.
 * 
 * @see DOM Level 2
 */
public interface Range {
	/**
	 * Compare end boundary-point of <code>sourceRange</code> to end
	 * boundary-point of Range on which <code>compareBoundaryPoints</code>
	 * is invoked.
	 */
	public static final short END_TO_END = 2;
	/**
	 * Compare end boundary-point of <code>sourceRange</code> to start
	 * boundary-point of Range on which <code>compareBoundaryPoints</code>
	 * is invoked.
	 */
	public static final short END_TO_START = 3;
	/**
	 * Compare start boundary-point of <code>sourceRange</code> to end
	 * boundary-point of Range on which <code>compareBoundaryPoints</code>
	 * is invoked.
	 */
	public static final short START_TO_END = 1;

	// CompareHow
	/**
	 * Compare start boundary-point of <code>sourceRange</code> to start
	 * boundary-point of Range on which <code>compareBoundaryPoints</code>
	 * is invoked.
	 */
	public static final short START_TO_START = 0;

	/**
	 * 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. <br>
	 *                INVALID_STATE_ERR: Raised if <code>detach()</code> has
	 *                already been invoked on this object.
	 */
	public DocumentFragment cloneContents() throws DOMException;

	/**
	 * 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 <code>detach()</code> has
	 *                already been invoked on this object.
	 */
	public Range cloneRange() throws DOMException;

	/**
	 * Collapse a Range onto one of its boundary-points
	 * 
	 * @param toStartIf
	 *            TRUE, collapses the Range onto its start; if FALSE,
	 *            collapses it onto its end.
	 * @exception DOMException
	 *                INVALID_STATE_ERR: Raised if <code>detach()</code> has
	 *                already been invoked on this object.
	 */
	public void collapse(boolean toStart) throws DOMException;

	/**
	 * Compare the boundary-points of two Ranges in a document.
	 * 
	 * @param howA
	 *            code representing the type of comparison, as defined above.
	 * @param sourceRangeThe
	 *            <code>Range</code> on which this current
	 *            <code>Range</code> 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
	 *         <code>sourceRange</code>.
	 * @exception DOMException
	 *                WRONG_DOCUMENT_ERR: Raised if the two Ranges are not in
	 *                the same Document or DocumentFragment. <br>
	 *                INVALID_STATE_ERR: Raised if <code>detach()</code> has
	 *                already been invoked on this object.
	 */
	public short compareBoundaryPoints(short how, Range sourceRange) throws DOMException;

	/**
	 * 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. <br>
	 *                INVALID_STATE_ERR: Raised if <code>detach()</code> has
	 *                already been invoked on this object.
	 */
	public void deleteContents() throws DOMException;

	/**
	 * 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 <code>DOMException</code> being thrown with an error code
	 * of <code>INVALID_STATE_ERR</code>.
	 * 
	 * @exception DOMException
	 *                INVALID_STATE_ERR: Raised if <code>detach()</code> has
	 *                already been invoked on this object.
	 */
	public void detach() throws DOMException;

	/**
	 * 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. <br>
	 *                HIERARCHY_REQUEST_ERR: Raised if a DocumentType node
	 *                would be extracted into the new DocumentFragment. <br>
	 *                INVALID_STATE_ERR: Raised if <code>detach()</code> has
	 *                already been invoked on this object.
	 */
	public DocumentFragment extractContents() throws DOMException;

	/**
	 * TRUE if the Range is collapsed
	 * 
	 * @exception DOMException
	 *                INVALID_STATE_ERR: Raised if <code>detach()</code> has
	 *                already been invoked on this object.
	 */
	public boolean getCollapsed() throws DOMException;

	/**
	 * The deepest common ancestor container of the Range's two
	 * boundary-points.
	 * 
	 * @exception DOMException
	 *                INVALID_STATE_ERR: Raised if <code>detach()</code> has
	 *                already been invoked on this object.
	 */
	public Node getCommonAncestorContainer() throws DOMException;

	/**
	 * Node within which the Range ends
	 * 
	 * @exception DOMException
	 *                INVALID_STATE_ERR: Raised if <code>detach()</code> has
	 *                already been invoked on this object.
	 */
	public Node getEndContainer() throws DOMException;

	/**
	 * Offset within the ending node of the Range.
	 * 
	 * @exception DOMException
	 *                INVALID_STATE_ERR: Raised if <code>detach()</code> has
	 *                already been invoked on this object.
	 */
	public int getEndOffset() throws DOMException;

	/**
	 * Node within which the Range begins
	 * 
	 * @exception DOMException
	 *                INVALID_STATE_ERR: Raised if <code>detach()</code> has
	 *                already been invoked on this object.
	 */
	public Node getStartContainer() throws DOMException;

	/**
	 * Offset within the starting node of the Range.
	 * 
	 * @exception DOMException
	 *                INVALID_STATE_ERR: Raised if <code>detach()</code> has
	 *                already been invoked on this object.
	 */
	public int getStartOffset() throws DOMException;

	/**
	 * 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 newNodeThe
	 *            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. <br>
	 *                WRONG_DOCUMENT_ERR: Raised if <code>newNode</code> and
	 *                the container of the start of the Range were not created
	 *                from the same document. <br>
	 *                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.
	 *                <br>
	 *                INVALID_STATE_ERR: Raised if <code>detach()</code> has
	 *                already been invoked on this object.
	 * @exception RangeException
	 *                INVALID_NODE_TYPE_ERR: Raised if <code>newNode</code>
	 *                is an Attr, Entity, Notation, or Document node.
	 */
	public void insertNode(Node newNode) throws DOMException, RangeException;

	/**
	 * Select a node and its contents
	 * 
	 * @param refNodeThe
	 *            node to select.
	 * @exception RangeException
	 *                INVALID_NODE_TYPE_ERR: Raised if an ancestor of
	 *                <code>refNode</code> is an Entity, Notation or
	 *                DocumentType node or if <code>refNode</code> is a
	 *                Document, DocumentFragment, Attr, Entity, or Notation
	 *                node.
	 * @exception DOMException
	 *                INVALID_STATE_ERR: Raised if <code>detach()</code> has
	 *                already been invoked on this object.
	 */
	public void selectNode(Node refNode) throws RangeException, DOMException;

	/**
	 * Select the contents within a node
	 * 
	 * @param refNodeNode
	 *            to select from
	 * @exception RangeException
	 *                INVALID_NODE_TYPE_ERR: Raised if <code>refNode</code>
	 *                or an ancestor of <code>refNode</code> is an Entity,
	 *                Notation or DocumentType node.
	 * @exception DOMException
	 *                INVALID_STATE_ERR: Raised if <code>detach()</code> has
	 *                already been invoked on this object.
	 */
	public void selectNodeContents(Node refNode) throws RangeException, DOMException;

	/**
	 * Sets the attributes describing the end of a Range.
	 * 
	 * @param refNodeThe
	 *            <code>refNode</code> value. This parameter must be
	 *            different from <code>null</code>.
	 * @param offsetThe
	 *            <code>endOffset</code> value.
	 * @exception RangeException
	 *                INVALID_NODE_TYPE_ERR: Raised if <code>refNode</code>
	 *                or an ancestor of <code>refNode</code> is an Entity,
	 *                Notation, or DocumentType node.
	 * @exception DOMException
	 *                INDEX_SIZE_ERR: Raised if <code>offset</code> is
	 *                negative or greater than the number of child units in
	 *                <code>refNode</code>. Child units are 16-bit units if
	 *                <code>refNode</code> 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. <br>
	 *                INVALID_STATE_ERR: Raised if <code>detach()</code> has
	 *                already been invoked on this object.
	 */
	public void setEnd(Node refNode, int offset) throws RangeException, DOMException;

	/**
	 * Sets the end of a Range to be after a node
	 * 
	 * @param refNodeRange
	 *            ends after <code>refNode</code>.
	 * @exception RangeException
	 *                INVALID_NODE_TYPE_ERR: Raised if the root container of
	 *                <code>refNode</code> is not an Attr, Document or
	 *                DocumentFragment node or if <code>refNode</code> is a
	 *                Document, DocumentFragment, Attr, Entity, or Notation
	 *                node.
	 * @exception DOMException
	 *                INVALID_STATE_ERR: Raised if <code>detach()</code> has
	 *                already been invoked on this object.
	 */
	public void setEndAfter(Node refNode) throws RangeException, DOMException;

	/**
	 * Sets the end position to be before a node.
	 * 
	 * @param refNodeRange
	 *            ends before <code>refNode</code>
	 * @exception RangeException
	 *                INVALID_NODE_TYPE_ERR: Raised if the root container of
	 *                <code>refNode</code> is not an Attr, Document, or
	 *                DocumentFragment node or if <code>refNode</code> is a
	 *                Document, DocumentFragment, Attr, Entity, or Notation
	 *                node.
	 * @exception DOMException
	 *                INVALID_STATE_ERR: Raised if <code>detach()</code> has
	 *                already been invoked on this object.
	 */
	public void setEndBefore(Node refNode) throws RangeException, DOMException;

	/**
	 * Sets the attributes describing the start of the Range.
	 * 
	 * @param refNodeThe
	 *            <code>refNode</code> value. This parameter must be
	 *            different from <code>null</code>.
	 * @param offsetThe
	 *            <code>startOffset</code> value.
	 * @exception RangeException
	 *                INVALID_NODE_TYPE_ERR: Raised if <code>refNode</code>
	 *                or an ancestor of <code>refNode</code> is an Entity,
	 *                Notation, or DocumentType node.
	 * @exception DOMException
	 *                INDEX_SIZE_ERR: Raised if <code>offset</code> is
	 *                negative or greater than the number of child units in
	 *                <code>refNode</code>. Child units are 16-bit units if
	 *                <code>refNode</code> 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. <br>
	 *                INVALID_STATE_ERR: Raised if <code>detach()</code> has
	 *                already been invoked on this object.
	 */
	public void setStart(Node refNode, int offset) throws RangeException, DOMException;

	/**
	 * Sets the start position to be after a node
	 * 
	 * @param refNodeRange
	 *            starts after <code>refNode</code>
	 * @exception RangeException
	 *                INVALID_NODE_TYPE_ERR: Raised if the root container of
	 *                <code>refNode</code> is not an Attr, Document, or
	 *                DocumentFragment node or if <code>refNode</code> is a
	 *                Document, DocumentFragment, Attr, Entity, or Notation
	 *                node.
	 * @exception DOMException
	 *                INVALID_STATE_ERR: Raised if <code>detach()</code> has
	 *                already been invoked on this object.
	 */
	public void setStartAfter(Node refNode) throws RangeException, DOMException;

	/**
	 * Sets the start position to be before a node
	 * 
	 * @param refNodeRange
	 *            starts before <code>refNode</code>
	 * @exception RangeException
	 *                INVALID_NODE_TYPE_ERR: Raised if the root container of
	 *                <code>refNode</code> is not an Attr, Document, or
	 *                DocumentFragment node or if <code>refNode</code> is a
	 *                Document, DocumentFragment, Attr, Entity, or Notation
	 *                node.
	 * @exception DOMException
	 *                INVALID_STATE_ERR: Raised if <code>detach()</code> has
	 *                already been invoked on this object.
	 */
	public void setStartBefore(Node refNode) throws RangeException, DOMException;

	/**
	 * Reparents the contents of the Range to the given node and inserts the
	 * node at the position of the start of the Range.
	 * 
	 * @param newParentThe
	 *            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. <br>
	 *                WRONG_DOCUMENT_ERR: Raised if <code> newParent</code>
	 *                and the container of the start of the Range were not
	 *                created from the same document. <br>
	 *                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>.
	 *                <br>
	 *                INVALID_STATE_ERR: Raised if <code>detach()</code> has
	 *                already been invoked on this object.
	 * @exception RangeException
	 *                BAD_BOUNDARYPOINTS_ERR: Raised if the Range partially
	 *                selects a non-text node. <br>
	 *                INVALID_NODE_TYPE_ERR: Raised if <code> node</code> is
	 *                an Attr, Entity, DocumentType, Notation, Document, or
	 *                DocumentFragment node.
	 */
	public void surroundContents(Node newParent) throws DOMException, RangeException;

	/**
	 * 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 <code>detach()</code> has
	 *                already been invoked on this object.
	 */
	public String toString() throws DOMException;

}