range.java

gcc的组建

/*
 * Copyright (c) 2000 World Wide Web Consortium,
 * (Massachusetts Institute of Technology, Institut National de
 * Recherche en Informatique et en Automatique, Keio University). All
 * Rights Reserved. This program is distributed under the W3C's Software
 * Intellectual Property License. This program is distributed in the
 * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 * PURPOSE.
 * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
 */

package org.w3c.dom.ranges;

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

/**
 * <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>.
 * @since DOM Level 2
 */
public interface Range {
    /**
     * 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;

    /**
     * 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;

    /**
     * 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;

    /**
     * Sets the attributes describing the start of the Range. 
     * @param refNode The <code>refNode</code> value. This parameter must be 
     *   different from <code>null</code>.
     * @param offset The <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.
     *   <br>WRONG_DOCUMENT_ERR: Raised if <code>refNode</code> was created 
     *   from a different document than the one that created this range.
     */
    public void setStart(Node refNode, 
                         int offset)
                         throws RangeException, DOMException;

    /**
     * Sets the attributes describing the end of a Range.
     * @param refNode The <code>refNode</code> value. This parameter must be 
     *   different from <code>null</code>.
     * @param offset The <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.
     *   <br>WRONG_DOCUMENT_ERR: Raised if <code>refNode</code> was created 
     *   from a different document than the one that created this range.
     */
    public void setEnd(Node refNode, 
                       int offset)
                       throws RangeException, DOMException;

    /**
     * Sets the start position to be before a node
     * @param refNode Range 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.
     *   <br>WRONG_DOCUMENT_ERR: Raised if <code>refNode</code> was created 
     *   from a different document than the one that created this range.
     */
    public void setStartBefore(Node refNode)
                               throws RangeException, DOMException;

    /**
     * Sets the start position to be after a node
     * @param refNode Range 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.
     *   <br>WRONG_DOCUMENT_ERR: Raised if <code>refNode</code> was created 
     *   from a different document than the one that created this range.
     */
    public void setStartAfter(Node refNode)
                              throws RangeException, DOMException;

    /**
     * Sets the end position to be before a node. 
     * @param refNode Range 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.
     *   <br>WRONG_DOCUMENT_ERR: Raised if <code>refNode</code> was created 
     *   from a different document than the one that created this range.
     */
    public void setEndBefore(Node refNode)
                             throws RangeException, DOMException;

    /**
     * Sets the end of a Range to be after a node 
     * @param refNode Range 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.
     *   <br>WRONG_DOCUMENT_ERR: Raised if <code>refNode</code> was created 
     *   from a different document than the one that created this range.
     */
    public void setEndAfter(Node refNode)
                            throws RangeException, DOMException;

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

    /**
     * Select a node and its contents 
     * @param refNode The node to select. 
     * @exception RangeException