elemental.js.ranges

Class JsRange

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

elemental.js.util.JsElementalBase

elemental.js.dom.JsElementalMixinBase

elemental.js.ranges.JsRange

All Implemented Interfaces:

ElementalMixinBase, ElementTraversal, NodeSelector, EventTarget, Range, ElementTimeControl, SVGExternalResourcesRequired, SVGFilterPrimitiveStandardAttributes, SVGFitToViewBox, SVGLangSpace, SVGLocatable, SVGStylable, SVGTests, SVGTransformable, SVGURIReference, SVGZoomAndPan, Indexable, IndexableInt, IndexableNumber, Mappable, Settable, SettableInt, SettableNumber

public class JsRange
extends JsElementalMixinBase
implements Range

Field Summary

Fields inherited from interface elemental.ranges.Range

END_TO_END, END_TO_START, NODE_AFTER, NODE_BEFORE, NODE_BEFORE_AND_AFTER, NODE_INSIDE, START_TO_END, START_TO_START

Fields inherited from interface elemental.svg.SVGZoomAndPan

SVG_ZOOMANDPAN_DISABLE, SVG_ZOOMANDPAN_MAGNIFY, SVG_ZOOMANDPAN_UNKNOWN

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JsRange()

Method Summary

Modifier and Type	Method and Description
JsDocumentFragment	cloneContents() Returns a DocumentFragment copying the nodes of a Range.
JsRange	cloneRange() Returns a Range object with boundary points identical to the cloned Range.
void	collapse(boolean toStart) Collapses the Range to one of its boundary points.
short	compareNode(Node refNode) Returns a constant representing whether the Node is before, after, inside, or surrounding the range.
short	comparePoint(Node refNode, int offset) Returns -1, 0, or 1 indicating whether the point occurs before, inside, or after the range.
JsDocumentFragment	createContextualFragment(String html) Returns a DocumentFragment created from a given string of code.
void	deleteContents() Removes the contents of a Range from the Document .
void	detach() Releases Range from use to improve performance.
void	expand(String unit)
JsDocumentFragment	extractContents() Moves contents of a Range from the document tree into a DocumentFragment .
JsClientRect	getBoundingClientRect() Returns a ClientRect object which bounds the entire contents of the range; this would be the union of all the rectangles returned by range.getClientRects() .
JsClientRectList	getClientRects() Returns a list of ClientRect objects that aggregates the results of Element.getClientRects() for all the elements in the range.
JsNode	getCommonAncestorContainer() Returns the deepest Node that contains the startContainer and endContainer Nodes.
JsNode	getEndContainer() Returns the Node within which the Range ends.
int	getEndOffset() Returns a number representing where in the endContainer the Range ends.
JsNode	getStartContainer() Returns the Node within which the Range starts.
int	getStartOffset() Returns a number representing where in the startContainer the Range starts.
void	insertNode(Node newNode) Insert a Node at the start of a Range.
boolean	intersectsNode(Node refNode) Returns a boolean indicating whether the given node intersects the range.
boolean	isCollapsed() Returns a boolean indicating whether the range's start and end points are at the same position.
boolean	isPointInRange(Node refNode, int offset) Returns a boolean indicating whether the given point is in the range.
void	selectNode(Node refNode) Sets the Range to contain the Node and its contents.
void	selectNodeContents(Node refNode) Sets the Range to contain the contents of a Node .
void	setEnd(Node refNode, int offset) Sets the end position of a Range.
void	setEndAfter(Node refNode) Sets the end position of a Range relative to another Node .
void	setEndBefore(Node refNode) Sets the end position of a Range relative to another Node .
void	setStart(Node refNode, int offset) Sets the start position of a Range.
void	setStartAfter(Node refNode) Sets the start position of a Range relative to another Node .
void	setStartBefore(Node refNode) Sets the start position of a Range relative to another Node .
void	surroundContents(Node newParent) Moves content of a Range into a new Node .

Methods inherited from class elemental.js.dom.JsElementalMixinBase

addEventListener, addEventListener, beginElement, beginElementAt, dispatchEvent, endElement, endElementAt, getAnimatedClassName, getAnimatedHeight, getAnimatedHref, getAnimatedResult, getAnimatedTransform, getAnimatedWidth, getAnimatedX, getAnimatedY, getBBox, getChildElementCount, getCTM, getExternalResourcesRequired, getFarthestViewportElement, getFirstElementChild, getLastElementChild, getNearestViewportElement, getNextElementSibling, getPresentationAttribute, getPreserveAspectRatio, getPreviousElementSibling, getRequiredExtensions, getRequiredFeatures, getScreenCTM, getSvgStyle, getSystemLanguage, getTransformToElement, getViewBox, getXmllang, getXmlspace, getZoomAndPan, hasExtension, querySelector, querySelectorAll, removeEventListener, removeEventListener, setXmllang, setXmlspace, setZoomAndPan

Methods inherited from class elemental.js.util.JsElementalBase

at, at, intAt, intAt, length, numberAt, numberAt, setAt, setAt, setAt, setAt, setAt, setAt

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface elemental.util.IndexableInt

intAt, length

Methods inherited from interface elemental.util.IndexableNumber

numberAt

Constructor Detail

JsRange

protected JsRange()

Method Detail

isCollapsed

public final boolean isCollapsed()

Description copied from interface: Range

Returns a boolean indicating whether the range's start and end points are at the same position.

Specified by:

isCollapsed in interface Range

getCommonAncestorContainer

public final JsNode getCommonAncestorContainer()

Description copied from interface: Range

Returns the deepest Node that contains the startContainer and endContainer Nodes.

Specified by:

getCommonAncestorContainer in interface Range

getEndContainer

public final JsNode getEndContainer()

Description copied from interface: Range

Returns the Node within which the Range ends.

Specified by:

getEndContainer in interface Range

getEndOffset

public final int getEndOffset()

Description copied from interface: Range

Returns a number representing where in the endContainer the Range ends.

Specified by:

getEndOffset in interface Range

getStartContainer

public final JsNode getStartContainer()

Description copied from interface: Range

Returns the Node within which the Range starts.

Specified by:

getStartContainer in interface Range

getStartOffset

public final int getStartOffset()

Description copied from interface: Range

Returns a number representing where in the startContainer the Range starts.

Specified by:

getStartOffset in interface Range

cloneContents

public final JsDocumentFragment cloneContents()

Description copied from interface: Range

Returns a DocumentFragment copying the nodes of a Range.

Specified by:

cloneContents in interface Range

cloneRange

public final JsRange cloneRange()

Description copied from interface: Range

Returns a Range object with boundary points identical to the cloned Range.

Specified by:

cloneRange in interface Range

collapse

public final void collapse(boolean toStart)

Description copied from interface: Range

Collapses the Range to one of its boundary points.

Specified by:

collapse in interface Range

compareNode

public final short compareNode(Node refNode)

Description copied from interface: Range

Returns a constant representing whether the Node is before, after, inside, or surrounding the range.

Specified by:

compareNode in interface Range

comparePoint

public final short comparePoint(Node refNode,
                                int offset)

Description copied from interface: Range

Returns -1, 0, or 1 indicating whether the point occurs before, inside, or after the range.

Specified by:

comparePoint in interface Range

createContextualFragment

public final JsDocumentFragment createContextualFragment(String html)

Description copied from interface: Range

Returns a DocumentFragment created from a given string of code.

Specified by:

createContextualFragment in interface Range

deleteContents

public final void deleteContents()

Description copied from interface: Range

Removes the contents of a Range from the Document .

Specified by:

deleteContents in interface Range

detach

public final void detach()

Description copied from interface: Range

Releases Range from use to improve performance.

Specified by:

detach in interface Range

expand

public final void expand(String unit)

Specified by:

expand in interface Range

extractContents

public final JsDocumentFragment extractContents()

Description copied from interface: Range

Moves contents of a Range from the document tree into a DocumentFragment .

Specified by:

extractContents in interface Range

getBoundingClientRect

public final JsClientRect getBoundingClientRect()

Description copied from interface: Range

Returns a ClientRect object which bounds the entire contents of the range; this would be the union of all the rectangles returned by range.getClientRects() .

Specified by:

getBoundingClientRect in interface Range

getClientRects

public final JsClientRectList getClientRects()

Description copied from interface: Range

Returns a list of ClientRect objects that aggregates the results of Element.getClientRects() for all the elements in the range.

Specified by:

getClientRects in interface Range

insertNode

public final void insertNode(Node newNode)

Description copied from interface: Range

Insert a Node at the start of a Range.

Specified by:

insertNode in interface Range

intersectsNode

public final boolean intersectsNode(Node refNode)

Description copied from interface: Range

Returns a boolean indicating whether the given node intersects the range.

Specified by:

intersectsNode in interface Range

isPointInRange

public final boolean isPointInRange(Node refNode,
                                    int offset)

Description copied from interface: Range

Returns a boolean indicating whether the given point is in the range.

Specified by:

isPointInRange in interface Range

selectNode

public final void selectNode(Node refNode)

Description copied from interface: Range

Sets the Range to contain the Node and its contents.

Specified by:

selectNode in interface Range

selectNodeContents

public final void selectNodeContents(Node refNode)

Description copied from interface: Range

Sets the Range to contain the contents of a Node .

Specified by:

selectNodeContents in interface Range

setEnd

public final void setEnd(Node refNode,
                         int offset)

Description copied from interface: Range

Sets the end position of a Range.

Specified by:

setEnd in interface Range

setEndAfter

public final void setEndAfter(Node refNode)

Description copied from interface: Range

Sets the end position of a Range relative to another Node .

Specified by:

setEndAfter in interface Range

setEndBefore

public final void setEndBefore(Node refNode)

Description copied from interface: Range

Sets the end position of a Range relative to another Node .

Specified by:

setEndBefore in interface Range

setStart

public final void setStart(Node refNode,
                           int offset)

Description copied from interface: Range

Sets the start position of a Range.

Specified by:

setStart in interface Range

setStartAfter

public final void setStartAfter(Node refNode)

Description copied from interface: Range

Sets the start position of a Range relative to another Node .

Specified by:

setStartAfter in interface Range

setStartBefore

public final void setStartBefore(Node refNode)

Description copied from interface: Range

Sets the start position of a Range relative to another Node .

Specified by:

setStartBefore in interface Range

surroundContents

public final void surroundContents(Node newParent)

Description copied from interface: Range

Moves content of a Range into a new Node .

Specified by:

surroundContents in interface Range