akasha

Class Range

java.lang.Object

akasha.AbstractRange

akasha.Range

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="Range")
public class Range
extends AbstractRange

The Range interface represents a fragment of a document that can contain nodes and parts of text nodes.

See Also:

Range - MDN, Range - DOM, Extensions to Range - DOM Parsing and Serialization, Extensions to Range - CSS Object Model (CSSOM) View Module, Range - Document Object Model (DOM) Level 2 Traversal and Range Specification

Field Summary

Fields

Modifier and Type	Field and Description
static int	END_TO_END
static int	END_TO_START
static int	START_TO_END
static int	START_TO_START

Constructor Summary

Constructors

Constructor and Description
Range() The Range() constructor returns a newly created Range object whose start and end is the global Document object.

Method Summary

Modifier and Type	Method and Description
DocumentFragment	cloneContents() The Range.cloneContents() returns a DocumentFragment copying the objects of type Node included in the Range.
Range	cloneRange() The Range.cloneRange() method returns a Range object with boundary points identical to the cloned Range.
void	collapse() The Range.collapse() method collapses the Range to one of its boundary points.
void	collapse(boolean toStart) The Range.collapse() method collapses the Range to one of its boundary points.
Node	commonAncestorContainer() The Range.commonAncestorContainer read-only property returns the deepest — or furthest down the document tree — Node that contains both boundary points of the Range.
short	compareBoundaryPoints(int how, Range sourceRange) The Range.compareBoundaryPoints() method compares the boundary points of the Range with those of another range.
short	comparePoint(Node node, int offset) The Range.comparePoint() method returns -1, 0, or 1 depending on whether the referenceNode is before, the same as, or after the Range.
DocumentFragment	createContextualFragment(java.lang.String fragment) The Range.createContextualFragment() method returns a DocumentFragment by invoking the HTML fragment parsing algorithm or the XML fragment parsing algorithm with the start of the range (the parent of the selected node) as the context node.
void	deleteContents() The Range.deleteContents() method removes the contents of the Range from the Document.
void	detach() The Range.detach() method does nothing.
DocumentFragment	extractContents() The Range.extractContents() method moves contents of the Range from the document tree into a DocumentFragment.
DOMRect	getBoundingClientRect() The Range.getBoundingClientRect() method returns a DOMRect object that bounds the contents of the range; this is a rectangle enclosing the union of the bounding rectangles for all the elements in the range.
DOMRectList	getClientRects() The Range.getClientRects() method returns a list of DOMRect objects representing the area of the screen occupied by the range.
void	insertNode(Node node) The Range.insertNode() method inserts a node at the start of the Range.
boolean	intersectsNode(Node node) The Range.intersectsNode() method returns a boolean indicating whether the given Node intersects the Range.
boolean	isPointInRange(Node node, int offset) The Range.isPointInRange() method returns a boolean indicating whether the given point is in the Range.
void	selectNode(Node node) The Range.selectNode() method sets the Range to contain the Node and its contents.
void	selectNodeContents(Node node) The Range.selectNodeContents() method sets the Range to contain the contents of a Node.
void	setEnd(Node node, int offset) The Range.setEnd() method sets the end position of a Range to be located at the given offset into the specified node x.Setting the end point above (higher in the document) than the start point will result in a collapsed range with the start and end points both set to the specified end position.
void	setEndAfter(Node node) The Range.setEndAfter() method sets the end position of a Range relative to another Node.
void	setEndBefore(Node node) The Range.setEndBefore() method sets the end position of a Range relative to another Node.
void	setStart(Node node, int offset) The Range.setStart() method sets the start position of a Range.
void	setStartAfter(Node node) The Range.setStartAfter() method sets the start position of a Range relative to a Node.
void	setStartBefore(Node node) The Range.setStartBefore() method sets the start position of a Range relative to another Node.
void	surroundContents(Node newParent) The Range.surroundContents() method moves content of the Range into a new node, placing the new node at the start of the specified range.

Methods inherited from class akasha.AbstractRange

collapsed, endContainer, endOffset, startContainer, startOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

END_TO_END

@JsOverlay
public static final int END_TO_END

See Also:

Constant Field Values

END_TO_START

@JsOverlay
public static final int END_TO_START

See Also:

Constant Field Values

START_TO_END

@JsOverlay
public static final int START_TO_END

See Also:

Constant Field Values

START_TO_START

@JsOverlay
public static final int START_TO_START

See Also:

Constant Field Values

Constructor Detail

Range

public Range()

The Range() constructor returns a newly created Range object whose start and end is the global Document object.

See Also:

Range.Range - MDN

Method Detail

commonAncestorContainer

@JsProperty(name="commonAncestorContainer")
 @Nonnull
public Node commonAncestorContainer()

The Range.commonAncestorContainer read-only property returns the deepest — or furthest down the document tree — Node that contains both boundary points of the Range. This means that if Range.startContainer and Range.endContainer both refer to the same node, this node is the common ancestor container.

See Also:

Range.commonAncestorContainer - MDN, Range.commonAncestorContainer - DOM, Range.commonAncestorContainer - Document Object Model (DOM) Level 2 Traversal and Range Specification

cloneContents

@Nonnull
public DocumentFragment cloneContents()

The Range.cloneContents() returns a DocumentFragment copying the objects of type Node included in the Range.

See Also:

Range.cloneContents - MDN

cloneRange

@Nonnull
public Range cloneRange()

The Range.cloneRange() method returns a Range object with boundary points identical to the cloned Range.

See Also:

Range.cloneRange - MDN

collapse

public void collapse(boolean toStart)

The Range.collapse() method collapses the Range to one of its boundary points.

See Also:

Range.collapse - MDN, Range.collapse() - DOM, Range.collapse() - Document Object Model (DOM) Level 2 Traversal and Range Specification

collapse

public void collapse()

The Range.collapse() method collapses the Range to one of its boundary points.

See Also:

Range.collapse - MDN, Range.collapse() - DOM, Range.collapse() - Document Object Model (DOM) Level 2 Traversal and Range Specification

compareBoundaryPoints

public short compareBoundaryPoints(@RangeCompareType
                                   int how,
                                   @Nonnull
                                   Range sourceRange)

The Range.compareBoundaryPoints() method compares the boundary points of the Range with those of another range.

See Also:

Range.compareBoundaryPoints - MDN

comparePoint

public short comparePoint(@Nonnull
                          Node node,
                          int offset)

The Range.comparePoint() method returns -1, 0, or 1 depending on whether the referenceNode is before, the same as, or after the Range.

See Also:

Range.comparePoint - MDN

deleteContents

public void deleteContents()

The Range.deleteContents() method removes the contents of the Range from the Document.

See Also:

Range.deleteContents - MDN, Range.deleteContents() - DOM, Range.deleteContents() - Document Object Model (DOM) Level 2 Traversal and Range Specification

detach

public void detach()

The Range.detach() method does nothing. It used to disable the Range object and enable the browser to release associated resources. The method has been kept for compatibility.

See Also:

Range.detach - MDN, Range.detach() - DOM, Range.detach() - Document Object Model (DOM) Level 2 Traversal and Range Specification

extractContents

@Nonnull
public DocumentFragment extractContents()

The Range.extractContents() method moves contents of the Range from the document tree into a DocumentFragment.

See Also:

Range.extractContents - MDN, Range.extractContents() - DOM, Range.extractContents() - Document Object Model (DOM) Level 2 Traversal and Range Specification

insertNode

public void insertNode(@Nonnull
                       Node node)

The Range.insertNode() method inserts a node at the start of the Range.

See Also:

Range.insertNode - MDN, Range.insertNode() - DOM, Range.insertNode() - Document Object Model (DOM) Level 2 Traversal and Range Specification

intersectsNode

public boolean intersectsNode(@Nonnull
                              Node node)

The Range.intersectsNode() method returns a boolean indicating whether the given Node intersects the Range.

See Also:

Range.intersectsNode - MDN

isPointInRange

public boolean isPointInRange(@Nonnull
                              Node node,
                              int offset)

The Range.isPointInRange() method returns a boolean indicating whether the given point is in the Range. It returns true if the point (cursor position) at offset within ReferenceNode is within this range.

See Also:

Range.isPointInRange - MDN

selectNode

public void selectNode(@Nonnull
                       Node node)

The Range.selectNode() method sets the Range to contain the Node and its contents. The parent Node of the start and end of the Range will be the same as the parent of the referenceNode.

See Also:

Range.selectNode - MDN, Range.selectNode() - DOM, Range.selectNode() - Document Object Model (DOM) Level 2 Traversal and Range Specification

selectNodeContents

public void selectNodeContents(@Nonnull
                               Node node)

The Range.selectNodeContents() method sets the Range to contain the contents of a Node.

See Also:

Range.selectNodeContents - MDN, Range.selectNodeContents() - DOM, Range.selectNodeContents() - Document Object Model (DOM) Level 2 Traversal and Range Specification

setEnd

public void setEnd(@Nonnull
                   Node node,
                   int offset)

The Range.setEnd() method sets the end position of a Range to be located at the given offset into the specified node x.Setting the end point above (higher in the document) than the start point will result in a collapsed range with the start and end points both set to the specified end position.

See Also:

Range.setEnd - MDN, Range.setEnd() - DOM, Range.setEnd() - Document Object Model (DOM) Level 2 Traversal and Range Specification

setEndAfter

public void setEndAfter(@Nonnull
                        Node node)

The Range.setEndAfter() method sets the end position of a Range relative to another Node. The parent Node of end of the Range will be the same as that for the referenceNode.

See Also:

Range.setEndAfter - MDN, Range.setEndAfter() - DOM, Range.setEndAfter() - Document Object Model (DOM) Level 2 Traversal and Range Specification

setEndBefore

public void setEndBefore(@Nonnull
                         Node node)

The Range.setEndBefore() method sets the end position of a Range relative to another Node. The parent Node of end of the Range will be the same as that for the referenceNode.

See Also:

Range.setEndBefore - MDN

setStart

public void setStart(@Nonnull
                     Node node,
                     int offset)

The Range.setStart() method sets the start position of a Range.

See Also:

Range.setStart - MDN, Range.setStart() - DOM, Range.setStart() - Document Object Model (DOM) Level 2 Traversal and Range Specification

setStartAfter

public void setStartAfter(@Nonnull
                          Node node)

The Range.setStartAfter() method sets the start position of a Range relative to a Node. The parent Node of the start of the Range will be the same as that for the referenceNode.

See Also:

Range.setStartAfter - MDN

setStartBefore

public void setStartBefore(@Nonnull
                           Node node)

The Range.setStartBefore() method sets the start position of a Range relative to another Node. The parent Node of the start of the Range will be the same as that for the referenceNode.

See Also:

Range.setStartBefore - MDN, Range.setStartBefore() - DOM, Range.setStartBefore() - Document Object Model (DOM) Level 2 Traversal and Range Specification

surroundContents

public void surroundContents(@Nonnull
                             Node newParent)

The Range.surroundContents() method moves content of the Range into a new node, placing the new node at the start of the specified range.

See Also:

Range.surroundContents - MDN, Range.surroundContents() - DOM, Range.surroundContents() - Document Object Model (DOM) Level 2 Traversal and Range Specification

getBoundingClientRect

@Nonnull
public DOMRect getBoundingClientRect()

The Range.getBoundingClientRect() method returns a DOMRect object that bounds the contents of the range; this is a rectangle enclosing the union of the bounding rectangles for all the elements in the range.

See Also:

Range.getBoundingClientRect - MDN

getClientRects

@Nonnull
public DOMRectList getClientRects()

The Range.getClientRects() method returns a list of DOMRect objects representing the area of the screen occupied by the range. This is created by aggregating the results of calls to Element.getClientRects() for all the elements in the range.

See Also:

Range.getClientRects - MDN

createContextualFragment

@Nonnull
public DocumentFragment createContextualFragment(@Nonnull
                                                          java.lang.String fragment)

The Range.createContextualFragment() method returns a DocumentFragment by invoking the HTML fragment parsing algorithm or the XML fragment parsing algorithm with the start of the range (the parent of the selected node) as the context node. The HTML fragment parsing algorithm is used if the range belongs to a Document whose HTMLness bit is set. In the HTML case, if the context node would be html, for historical reasons the fragment parsing algorithm is invoked with body as the context instead.

See Also:

Range.createContextualFragment - MDN