com.gargoylesoftware.htmlunit.javascript.host.dom

Class Range

java.lang.Object

net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

com.gargoylesoftware.htmlunit.javascript.HtmlUnitScriptable

com.gargoylesoftware.htmlunit.javascript.host.dom.Range

All Implemented Interfaces:

Serializable, Cloneable, net.sourceforge.htmlunit.corejs.javascript.ConstProperties, net.sourceforge.htmlunit.corejs.javascript.debug.DebuggableObject, net.sourceforge.htmlunit.corejs.javascript.Scriptable, net.sourceforge.htmlunit.corejs.javascript.SymbolScriptable

public class Range
extends HtmlUnitScriptable

The JavaScript object that represents a Range.

Author:

Marc Guillemot, Ahmed Ashour, Daniel Gredler, James Phillpotts, Ronald Brill

See Also:

XULPlanet, DOM-Level-2-Traversal-Range, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

net.sourceforge.htmlunit.corejs.javascript.ScriptableObject.KeyComparator

Field Summary

Fields

Modifier and Type	Field and Description
static short	END_TO_END Comparison mode for compareBoundaryPoints.
static short	END_TO_START Comparison mode for compareBoundaryPoints.
static short	START_TO_END Comparison mode for compareBoundaryPoints.
static short	START_TO_START Comparison mode for compareBoundaryPoints.

Fields inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface net.sourceforge.htmlunit.corejs.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
Range() Creates an instance.
Range(Document document) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
Object	cloneContents() Returns a clone of the range in a document fragment.
Object	cloneRange() Returns a clone of the range.
void	collapse(boolean toStart) Collapse a Range onto one of its boundaries.
Object	compareBoundaryPoints(int how, Range sourceRange) Compares the boundary points of two Ranges.
Object	createContextualFragment(String valueAsString) Parses an HTML snippet.
void	deleteContents() Deletes the contents of the range.
void	detach() Releases Range from use to improve performance.
protected Object	equivalentValues(Object value)
Object	extractContents() Moves this range's contents from the document tree into a document fragment.
ClientRect	getBoundingClientRect() Returns an object that bounds the contents of the range.
ClientRectList	getClientRects() Retrieves a collection of rectangles that describes the layout of the contents of an object or range within the client.
Object	getCommonAncestorContainer() Returns the deepest common ancestor container of the Range's two boundary points.
Object	getDefaultValue(Class<?> hint) Returns the JavaScript default value of this object.
Object	getEndContainer() Gets the node within which the Range ends.
int	getEndOffset() Gets the offset within the end node of the Range.
Object	getStartContainer() Gets the node within which the Range begins.
int	getStartOffset() Gets the offset within the starting node of the Range.
void	insertNode(Node newNode) Inserts a new node at the beginning of the range.
boolean	isCollapsed() Indicates if the range is collapsed.
String	jsToString() Returns the text of the Range.
void	selectNode(Node refNode) Selects 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 the range to be after the node.
void	setEndBefore(Node refNode) Sets the end of the range to be before the node.
void	setStart(Node refNode, int offset) Sets the attributes describing the start of a Range.
void	setStartAfter(Node refNode) Sets the start of the range to be after the node.
void	setStartBefore(Node refNode) Sets the start of the range to be before the node.
void	surroundContents(Node newNode) Surrounds the contents of the range in a new node.
SimpleRange	toW3C() Returns a W3C Range version of this object.

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.HtmlUnitScriptable

clone, get, getBrowserVersion, getClassName, getDomNodeOrDie, getDomNodeOrNull, getPrototype, getScriptableFor, getStartingScope, getWindow, getWindow, getWithPreemption, has, hasInstance, initParentScope, makeScriptableFor, put, setClassName, setDomNode, setDomNode, setParentScope

Methods inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, ensureSymbolScriptable, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGeneratorFunctionPrototype, getGetterOrSetter, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, hasProperty, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, putProperty, querySlot, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setAttributes, setCommonDescriptorProperties, setExternalArrayData, setGetterOrSetter, setPrototype, size

Methods inherited from class java.lang.Object

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

Field Detail

START_TO_START

public static final short START_TO_START

Comparison mode for compareBoundaryPoints.

See Also:

Constant Field Values

START_TO_END

public static final short START_TO_END

Comparison mode for compareBoundaryPoints.

See Also:

Constant Field Values

END_TO_END

public static final short END_TO_END

Comparison mode for compareBoundaryPoints.

See Also:

Constant Field Values

END_TO_START

public static final short END_TO_START

Comparison mode for compareBoundaryPoints.

See Also:

Constant Field Values

Constructor Detail

Range

public Range()

Creates an instance.

Range

public Range(Document document)

Creates a new instance.

Parameters:

document - the HTML document creating the range

Method Detail

getDefaultValue

public Object getDefaultValue(Class<?> hint)

Returns the JavaScript default value of this object. This is the JavaScript equivalent of a toString() in Java.

Specified by:

getDefaultValue in interface net.sourceforge.htmlunit.corejs.javascript.Scriptable

Overrides:

getDefaultValue in class HtmlUnitScriptable

Parameters:

hint - a hint as to the format of the default value (ignored in this case)

Returns:

the default value

getStartContainer

public Object getStartContainer()

Gets the node within which the Range begins.

Returns:

undefined if not initialized

getEndContainer

public Object getEndContainer()

Gets the node within which the Range ends.

Returns:

undefined if not initialized

getStartOffset

public int getStartOffset()

Gets the offset within the starting node of the Range.

Returns:

0 if not initialized

getEndOffset

public int getEndOffset()

Gets the offset within the end node of the Range.

Returns:

0 if not initialized

setStart

public void setStart(Node refNode,
                     int offset)

Sets the attributes describing the start of a Range.

Parameters:

refNode - the reference node

offset - the offset value within the node

setStartAfter

public void setStartAfter(Node refNode)

Sets the start of the range to be after the node.

Parameters:

refNode - the reference node

setStartBefore

public void setStartBefore(Node refNode)

Sets the start of the range to be before the node.

Parameters:

refNode - the reference node

isCollapsed

public boolean isCollapsed()

Indicates if the range is collapsed.

Returns:

true if the range is collapsed

setEnd

public void setEnd(Node refNode,
                   int offset)

Sets the attributes describing the end of a Range.

Parameters:

refNode - the reference node

offset - the offset value within the node

setEndAfter

public void setEndAfter(Node refNode)

Sets the end of the range to be after the node.

Parameters:

refNode - the reference node

setEndBefore

public void setEndBefore(Node refNode)

Sets the end of the range to be before the node.

Parameters:

refNode - the reference node

selectNodeContents

public void selectNodeContents(Node refNode)

Select the contents within a node.

Parameters:

refNode - Node to select from

selectNode

public void selectNode(Node refNode)

Selects a node and its contents.

Parameters:

refNode - the node to select

collapse

public void collapse(boolean toStart)

Collapse a Range onto one of its boundaries.

Parameters:

toStart - if true, collapses the Range onto its start; else collapses it onto its end

getCommonAncestorContainer

public Object getCommonAncestorContainer()

Returns the deepest common ancestor container of the Range's two boundary points.

Returns:

the deepest common ancestor container of the Range's two boundary points

createContextualFragment

public Object createContextualFragment(String valueAsString)

Parses an HTML snippet.

Parameters:

valueAsString - text that contains text and tags to be converted to a document fragment

Returns:

a document fragment

See Also:

Mozilla documentation

extractContents

public Object extractContents()

Moves this range's contents from the document tree into a document fragment.

Returns:

the new document fragment containing the range contents

toW3C

public SimpleRange toW3C()

Returns a W3C Range version of this object.

Returns:

a W3C Range version of this object

compareBoundaryPoints

public Object compareBoundaryPoints(int how,
                                    Range sourceRange)

Compares the boundary points of two Ranges.

Parameters:

how - a constant describing the comparison method

sourceRange - the Range to compare boundary points with this range

Returns:

-1, 0, or 1, indicating whether the corresponding boundary-point of range is respectively before, equal to, or after the corresponding boundary-point of sourceRange.

cloneContents

public Object cloneContents()

Returns a clone of the range in a document fragment.

Returns:

a clone

deleteContents

public void deleteContents()

Deletes the contents of the range.

insertNode

public void insertNode(Node newNode)

Inserts a new node at the beginning of the range. If the range begins at an offset, the node is split.

Parameters:

newNode - The node to insert

See Also:

https://developer.mozilla.org/en/DOM/range

surroundContents

public void surroundContents(Node newNode)

Surrounds the contents of the range in a new node.

Parameters:

newNode - The node to surround the range in

cloneRange

public Object cloneRange()

Returns a clone of the range.

Returns:

a clone of the range

detach

public void detach()

Releases Range from use to improve performance.

jsToString

public String jsToString()

Returns the text of the Range.

Returns:

the text

equivalentValues

protected Object equivalentValues(Object value)

Description copied from class: HtmlUnitScriptable

Overrides:

equivalentValues in class HtmlUnitScriptable

getClientRects

public ClientRectList getClientRects()

Retrieves a collection of rectangles that describes the layout of the contents of an object or range within the client. Each rectangle describes a single line.

Returns:

a collection of rectangles that describes the layout of the contents

getBoundingClientRect

public ClientRect getBoundingClientRect()

Returns an object that bounds the contents of the range. this a rectangle enclosing the union of the bounding rectangles for all the elements in the range.

Returns:

an object the bounds the contents of the range