org.enhydra.apache.xerces.dom
Class RangeImpl

java.lang.Object
  |
  +--org.enhydra.apache.xerces.dom.RangeImpl
All Implemented Interfaces:
Range

public class RangeImpl
extends java.lang.Object
implements Range

The RangeImpl class implements the org.w3c.dom.range.Range interface.

Please see the API documentation for the interface classes and use the interfaces in your client programs.


Field Summary
(package private) static int CLONE_CONTENTS
           
(package private) static int DELETE_CONTENTS
           
(package private) static int EXTRACT_CONTENTS
           
(package private)  Node fDeleteNode
           
(package private)  boolean fDetach
           
(package private)  DocumentImpl fDocument
           
(package private)  Node fEndContainer
           
(package private)  int fEndOffset
           
(package private)  Node fInsertNode
           
(package private)  boolean fIsCollapsed
           
(package private)  Node fRemoveChild
          This function is called within Range instead of Node.removeChild, so that the range can remember that it is actively removing this child.
(package private)  Node fSplitNode
           
(package private)  Node fStartContainer
           
(package private)  int fStartOffset
           
 
Fields inherited from interface org.w3c.dom.ranges.Range
END_TO_END, END_TO_START, START_TO_END, START_TO_START
 
Constructor Summary
RangeImpl(DocumentImpl document)
          The constructor.
 
Method Summary
(package private)  void checkIndex(Node refNode, int offset)
           
 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.
(package private)  void deleteData(CharacterData node, int offset, int count)
          This function inserts text into a Node and invokes a method to fix-up all other Ranges.
 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.
(package private)  int indexOf(Node child, Node parent)
          what is the index of the child in the parent
(package private)  void insertData(CharacterData node, int index, java.lang.String insert)
          This function inserts text into a Node and invokes a method to fix-up all other Ranges.
 void insertedNodeFromDOM(Node node)
          This function is called from the DOM.
 void insertNode(Node newNode)
          Inserts a node into the Document or DocumentFragment at the start of the Range.
(package private)  boolean isAncestorOf(Node a, Node b)
          is a an ancestor of b ?
(package private)  Node nextNode(Node node, boolean visitChildren)
           
(package private)  void receiveDeletedText(Node node, int offset, int count)
          This function is called from DOM.
(package private)  void receiveInsertedText(Node node, int index, int len)
          This function is called from DOM.
(package private)  void receiveReplacedText(Node node)
          This function is called from DOM.
(package private)  void receiveSplitData(Node node, Node newNode, int offset)
          Fix up this Range if another Range has split a Text Node into 2 Nodes.
(package private)  Node removeChild(Node parent, Node child)
           
(package private)  void removeNode(Node node)
          This function must be called by the DOM _BEFORE_ a node is deleted, because at that time it is connected in the DOM tree, which we depend on.
 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
(package private)  void signalSplitData(Node node, Node newNode, int offset)
          Signal other Ranges to update their start/end containers/offsets.
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

fDocument

DocumentImpl fDocument

fStartContainer

Node fStartContainer

fEndContainer

Node fEndContainer

fStartOffset

int fStartOffset

fEndOffset

int fEndOffset

fIsCollapsed

boolean fIsCollapsed

fDetach

boolean fDetach

fInsertNode

Node fInsertNode

fDeleteNode

Node fDeleteNode

fSplitNode

Node fSplitNode

fRemoveChild

Node fRemoveChild
This function is called within Range instead of Node.removeChild, so that the range can remember that it is actively removing this child.


EXTRACT_CONTENTS

static final int EXTRACT_CONTENTS
See Also:
Constant Field Values

CLONE_CONTENTS

static final int CLONE_CONTENTS
See Also:
Constant Field Values

DELETE_CONTENTS

static final int DELETE_CONTENTS
See Also:
Constant Field Values
Constructor Detail

RangeImpl

public RangeImpl(DocumentImpl document)
The constructor. Clients must use DocumentRange.createRange(), because it registers the Range with the document, so it can be fixed-up.

Method Detail

getStartContainer

public Node getStartContainer()
Description copied from interface: Range
Node within which the Range begins

Specified by:
getStartContainer in interface Range

getStartOffset

public int getStartOffset()
Description copied from interface: Range
Offset within the starting node of the Range.

Specified by:
getStartOffset in interface Range

getEndContainer

public Node getEndContainer()
Description copied from interface: Range
Node within which the Range ends

Specified by:
getEndContainer in interface Range

getEndOffset

public int getEndOffset()
Description copied from interface: Range
Offset within the ending node of the Range.

Specified by:
getEndOffset in interface Range

getCollapsed

public boolean getCollapsed()
Description copied from interface: Range
TRUE if the Range is collapsed

Specified by:
getCollapsed in interface Range

getCommonAncestorContainer

public Node getCommonAncestorContainer()
Description copied from interface: Range
The deepest common ancestor container of the Range's two boundary-points.

Specified by:
getCommonAncestorContainer in interface Range

setStart

public void setStart(Node refNode,
                     int offset)
              throws RangeException,
                     DOMException
Description copied from interface: Range
Sets the attributes describing the start of the Range.

Specified by:
setStart in interface Range
Throws:
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.
RangeException - INVALID_NODE_TYPE_ERR: Raised if refNode or an ancestor of refNode is an Entity, Notation, or DocumentType node.

setEnd

public void setEnd(Node refNode,
                   int offset)
            throws RangeException,
                   DOMException
Description copied from interface: Range
Sets the attributes describing the end of a Range.

Specified by:
setEnd in interface Range
Throws:
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.
RangeException - INVALID_NODE_TYPE_ERR: Raised if refNode or an ancestor of refNode is an Entity, Notation, or DocumentType node.

setStartBefore

public void setStartBefore(Node refNode)
                    throws RangeException
Description copied from interface: Range
Sets the start position to be before a node

Specified by:
setStartBefore in interface Range
Throws:
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.

setStartAfter

public void setStartAfter(Node refNode)
                   throws RangeException
Description copied from interface: Range
Sets the start position to be after a node

Specified by:
setStartAfter in interface Range
Throws:
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.

setEndBefore

public void setEndBefore(Node refNode)
                  throws RangeException
Description copied from interface: Range
Sets the end position to be before a node.

Specified by:
setEndBefore in interface Range
Throws:
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.

setEndAfter

public void setEndAfter(Node refNode)
                 throws RangeException
Description copied from interface: Range
Sets the end of a Range to be after a node

Specified by:
setEndAfter in interface Range
Throws:
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.

collapse

public void collapse(boolean toStart)
Description copied from interface: Range
Collapse a Range onto one of its boundary-points

Specified by:
collapse in interface Range

selectNode

public void selectNode(Node refNode)
                throws RangeException
Description copied from interface: Range
Select a node and its contents

Specified by:
selectNode in interface Range
Throws:
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.

selectNodeContents

public void selectNodeContents(Node refNode)
                        throws RangeException
Description copied from interface: Range
Select the contents within a node

Specified by:
selectNodeContents in interface Range
Throws:
RangeException - INVALID_NODE_TYPE_ERR: Raised if refNode or an ancestor of refNode is an Entity, Notation or DocumentType node.

compareBoundaryPoints

public short compareBoundaryPoints(short how,
                                   Range sourceRange)
                            throws DOMException
Description copied from interface: Range
Compare the boundary-points of two Ranges in a document.

Specified by:
compareBoundaryPoints in interface Range
Returns:
-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.
Throws:
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.

deleteContents

public void deleteContents()
                    throws DOMException
Description copied from interface: Range
Removes the contents of a Range from the containing document or document fragment without returning a reference to the removed content.

Specified by:
deleteContents in interface Range
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.
INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.

extractContents

public DocumentFragment extractContents()
                                 throws DOMException
Description copied from interface: Range
Moves the contents of a Range from the containing document or document fragment to a new DocumentFragment.

Specified by:
extractContents in interface Range
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.
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.

cloneContents

public DocumentFragment cloneContents()
                               throws DOMException
Description copied from interface: Range
Duplicates the contents of a Range

Specified by:
cloneContents in interface Range
Returns:
A DocumentFragment that contains content equivalent to this Range.
Throws:
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.

insertNode

public void insertNode(Node newNode)
                throws DOMException,
                       RangeException
Description copied from interface: Range
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.

Specified by:
insertNode in interface Range
Throws:
RangeException - INVALID_NODE_TYPE_ERR: Raised if newNode is an Attr, Entity, Notation, or Document node.
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.

surroundContents

public void surroundContents(Node newParent)
                      throws DOMException,
                             RangeException
Description copied from interface: Range
Reparents the contents of the Range to the given node and inserts the node at the position of the start of the Range.

Specified by:
surroundContents in interface Range
Throws:
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.
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.

cloneRange

public Range cloneRange()
Description copied from interface: Range
Produces a new Range whose boundary-points are equal to the boundary-points of the Range.

Specified by:
cloneRange in interface Range
Returns:
The duplicated Range.

toString

public java.lang.String toString()
Description copied from interface: Range
Returns the contents of a Range as a string. This string contains only the data characters, not any markup.

Specified by:
toString in interface Range
Overrides:
toString in class java.lang.Object
Returns:
The contents of the Range.

detach

public void detach()
Description copied from interface: 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.

Specified by:
detach in interface Range

signalSplitData

void signalSplitData(Node node,
                     Node newNode,
                     int offset)
Signal other Ranges to update their start/end containers/offsets. The data has already been split into the two Nodes.


receiveSplitData

void receiveSplitData(Node node,
                      Node newNode,
                      int offset)
Fix up this Range if another Range has split a Text Node into 2 Nodes.


deleteData

void deleteData(CharacterData node,
                int offset,
                int count)
This function inserts text into a Node and invokes a method to fix-up all other Ranges.


receiveDeletedText

void receiveDeletedText(Node node,
                        int offset,
                        int count)
This function is called from DOM. The text has already beeen inserted. Fix-up any offsets.


insertData

void insertData(CharacterData node,
                int index,
                java.lang.String insert)
This function inserts text into a Node and invokes a method to fix-up all other Ranges.


receiveInsertedText

void receiveInsertedText(Node node,
                         int index,
                         int len)
This function is called from DOM. The text has already beeen inserted. Fix-up any offsets.


receiveReplacedText

void receiveReplacedText(Node node)
This function is called from DOM. The text has already beeen replaced. Fix-up any offsets.


insertedNodeFromDOM

public void insertedNodeFromDOM(Node node)
This function is called from the DOM. This node has already been inserted into the DOM. Fix-up any offsets.


removeChild

Node removeChild(Node parent,
                 Node child)

removeNode

void removeNode(Node node)
This function must be called by the DOM _BEFORE_ a node is deleted, because at that time it is connected in the DOM tree, which we depend on.


checkIndex

void checkIndex(Node refNode,
                int offset)
          throws DOMException
DOMException

nextNode

Node nextNode(Node node,
              boolean visitChildren)

isAncestorOf

boolean isAncestorOf(Node a,
                     Node b)
is a an ancestor of b ?


indexOf

int indexOf(Node child,
            Node parent)
what is the index of the child in the parent



Copyright © 1999 The Apache Software Foundation. All Rights reserved.