com.gargoylesoftware.htmlunit.javascript.host
Class TextRange

java.lang.Object
  extended by net.sourceforge.htmlunit.corejs.javascript.ScriptableObject
      extended by com.gargoylesoftware.htmlunit.javascript.SimpleScriptable
          extended by com.gargoylesoftware.htmlunit.javascript.host.TextRange
All Implemented Interfaces:
Serializable, Cloneable, Map, net.sourceforge.htmlunit.corejs.javascript.ConstProperties, net.sourceforge.htmlunit.corejs.javascript.debug.DebuggableObject, net.sourceforge.htmlunit.corejs.javascript.Scriptable

public class TextRange
extends SimpleScriptable

A JavaScript object for a TextRange (IE only).

Version:
$Revision: 5563 $
Author:
Ahmed Ashour, Marc Guillemot
See Also:
MSDN documentation (1), MSDN documentation (2), Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>
 
Field Summary
 
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
TextRange()
          Default constructor used to build the prototype.
TextRange(HTMLElement elt)
          Constructs a text range around the provided element.
TextRange(org.w3c.dom.ranges.Range range)
          Constructs a text range around the provided range.
 
Method Summary
 void jsxFunction_collapse(boolean toStart)
          Collapses the range.
 Object jsxFunction_duplicate()
          Duplicates this TextRange instance.
 boolean jsxFunction_inRange(TextRange other)
          Indicates if a range is contained in current one.
 int jsxFunction_moveEnd(String unit, Object count)
          Changes the end position of the range.
 int jsxFunction_moveStart(String unit, Object count)
          Changes the start position of the range.
 void jsxFunction_moveToElementText(HTMLElement element)
          Moves the text range so that the start and end positions of the range encompass the text in the specified element.
 Object jsxFunction_parentElement()
          Retrieves the parent element for the given text range.
 void jsxFunction_select()
          Makes the current range the active selection.
 void jsxFunction_setEndPoint(String type, TextRange other)
          Sets the endpoint of the range based on the endpoint of another range..
 String jsxGet_htmlText()
          Retrieves the HTML fragment contained within the range.
 String jsxGet_text()
          Retrieves the text contained within the range.
 void jsxSet_text(String text)
          Sets the text contained within the range.
 
Methods inherited from class com.gargoylesoftware.htmlunit.javascript.SimpleScriptable
clone, defineFunctionProperties, defineProperty, equivalentValues, get, getBrowserVersion, getClassName, getDefaultValue, getDomNodeOrDie, getDomNodeOrNull, getPrototype, getScriptableFor, getStartingScope, getTransformerScriptableFor, getWindow, getWindow, getWithPreemption, hasInstance, initParentScope, makeScriptableFor, setCaseSensitive, setDomNode, setDomNode, setHtmlElement
 
Methods inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject
applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, clear, containsKey, containsValue, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineOwnProperties, defineOwnProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, entrySet, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getSlot, getTopLevelScope, getTopScopeValue, getTypeOf, has, has, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, keySet, preventExtensions, put, put, put, putAll, putConst, putConstProperty, putProperty, putProperty, redefineProperty, remove, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setGetterOrSetter, setParentScope, setPrototype, size, values
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.util.Map
equals, hashCode
 

Constructor Detail

TextRange

public TextRange()
Default constructor used to build the prototype.


TextRange

public TextRange(HTMLElement elt)
Constructs a text range around the provided element.

Parameters:
elt - the element to wrap

TextRange

public TextRange(org.w3c.dom.ranges.Range range)
Constructs a text range around the provided range.

Parameters:
range - the initial range
Method Detail

jsxGet_text

public String jsxGet_text()
Retrieves the text contained within the range.

Returns:
the text contained within the range

jsxSet_text

public void jsxSet_text(String text)
Sets the text contained within the range.

Parameters:
text - the text contained within the range

jsxGet_htmlText

public String jsxGet_htmlText()
Retrieves the HTML fragment contained within the range.

Returns:
the HTML fragment contained within the range

jsxFunction_duplicate

public Object jsxFunction_duplicate()
Duplicates this TextRange instance.

Returns:
a duplicate of this TextRange instance
See Also:
MSDN documentation

jsxFunction_parentElement

public Object jsxFunction_parentElement()
Retrieves the parent element for the given text range. The parent element is the element that completely encloses the text in the range. If the text range spans text in more than one element, this method returns the smallest element that encloses all the elements. When you insert text into a range that spans multiple elements, the text is placed in the parent element rather than in any of the contained elements.

Returns:
the parent element object if successful, or null otherwise.
See Also:
MSDN doc

jsxFunction_collapse

public void jsxFunction_collapse(boolean toStart)
Collapses the range.

Parameters:
toStart - indicates if collapse should be done to the start
See Also:
MSDN doc

jsxFunction_select

public void jsxFunction_select()
Makes the current range the active selection.

See Also:
MSDN doc

jsxFunction_moveStart

public int jsxFunction_moveStart(String unit,
                                 Object count)
Changes the start position of the range.

Parameters:
unit - specifies the units to move
count - the number of units to move
Returns:
the number of units moved

jsxFunction_moveEnd

public int jsxFunction_moveEnd(String unit,
                               Object count)
Changes the end position of the range.

Parameters:
unit - specifies the units to move
count - the number of units to move
Returns:
the number of units moved

jsxFunction_moveToElementText

public void jsxFunction_moveToElementText(HTMLElement element)
Moves the text range so that the start and end positions of the range encompass the text in the specified element.

Parameters:
element - the element to move to
See Also:
MSDN Documentation

jsxFunction_inRange

public boolean jsxFunction_inRange(TextRange other)
Indicates if a range is contained in current one.

Parameters:
other - the other range
Returns:
true if other is contained within current range
See Also:
MSDN doc

jsxFunction_setEndPoint

public void jsxFunction_setEndPoint(String type,
                                    TextRange other)
Sets the endpoint of the range based on the endpoint of another range..

Parameters:
type - end point transfer type. One of "StartToEnd", "StartToStart", "EndToStart" and "EndToEnd"
other - the other range
See Also:
MSDN doc


Copyright © 2002-2011 Gargoyle Software Inc.. All Rights Reserved.