org.vectomatic.dom.svg
Class OMText

java.lang.Object
  extended by org.vectomatic.dom.svg.OMNode
      extended by org.vectomatic.dom.svg.OMText
All Implemented Interfaces:
com.google.gwt.event.shared.HasHandlers

public class OMText
extends OMNode

Wrapper class for DOM Text

Author:
laaglu

Field Summary
 
Fields inherited from class org.vectomatic.dom.svg.OMNode
eventBus, ot
 
Constructor Summary
  OMText(String data)
          Constructor
protected OMText(com.google.gwt.dom.client.Text ot)
           
 
Method Summary
 void appendData(String arg)
          Append the string to the end of the character data of the node.
 void deleteData(int offset, int count)
          Remove a range of 16-bit units from the node.
 String getData()
          The character data of the node that implements this interface.
 int getLength()
          The number of 16-bit units that are available through data and the substringData method below.
 com.google.gwt.dom.client.Text getText()
          Returns the wrapped Text
 void insertData(int offset, String arg)
          Insert a string at the specified 16-bit unit offset.
 void replaceData(int offset, int count, String arg)
          Replace the characters starting at the specified 16-bit unit offset with the specified string.
 void setData(String value)
          The character data of the node that implements this interface.
 OMText splitText(int offset)
          Breaks this node into two nodes at the specified offset, keeping both in the tree as siblings.
 String substringData(int offset, int count)
          Extracts a range of data from the node.
 
Methods inherited from class org.vectomatic.dom.svg.OMNode
addDomHandler, addHandler, appendChild, cleanup, cloneNode, convert, convertList, dispatch, fireEvent, getChildNodes, getEventBus, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNode, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, hasChildNodes, insertBefore, normalize, removeChild, replaceChild, setNodeValue, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

OMText

public OMText(String data)
Constructor

Parameters:
data - The text data

OMText

protected OMText(com.google.gwt.dom.client.Text ot)
Method Detail

getText

public com.google.gwt.dom.client.Text getText()
Returns the wrapped Text

Returns:
the wrapped Text

getData

public final String getData()
                     throws com.google.gwt.core.client.JavaScriptException
The character data of the node that implements this interface. The DOM implementation may not put arbitrary limits on the amount of data that may be stored in a CharacterData node. However, implementation limits may mean that the entirety of a node's data may not fit into a single DOMString. In such cases, the user may call substringData to retrieve the data in appropriately sized pieces.

Throws:
DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.
com.google.gwt.core.client.JavaScriptException

setData

public final void setData(String value)
                   throws com.google.gwt.core.client.JavaScriptException
The character data of the node that implements this interface. The DOM implementation may not put arbitrary limits on the amount of data that may be stored in a CharacterData node. However, implementation limits may mean that the entirety of a node's data may not fit into a single DOMString. In such cases, the user may call substringData to retrieve the data in appropriately sized pieces.

Throws:
DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
com.google.gwt.core.client.JavaScriptException

getLength

public final int getLength()
The number of 16-bit units that are available through data and the substringData method below. This may have the value zero, i.e., CharacterData nodes may be empty.


substringData

public final String substringData(int offset,
                                  int count)
                           throws com.google.gwt.core.client.JavaScriptException
Extracts a range of data from the node.

Parameters:
offset - Start offset of substring to extract.
count - The number of 16-bit units to extract.
Returns:
The specified substring. If the sum of offset and count exceeds the length, then all 16-bit units to the end of the data are returned.
Throws:
DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data, or if the specified count is negative.
DOMSTRING_SIZE_ERR: Raised if the specified range of text does not fit into a DOMString.
com.google.gwt.core.client.JavaScriptException

appendData

public final void appendData(String arg)
                      throws com.google.gwt.core.client.JavaScriptException
Append the string to the end of the character data of the node. Upon success, data provides access to the concatenation of data and the DOMString specified.

Parameters:
arg - The DOMString to append.
Throws:
DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
com.google.gwt.core.client.JavaScriptException

insertData

public final void insertData(int offset,
                             String arg)
                      throws com.google.gwt.core.client.JavaScriptException
Insert a string at the specified 16-bit unit offset.

Parameters:
offset - The character offset at which to insert.
arg - The DOMString to insert.
Throws:
DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
com.google.gwt.core.client.JavaScriptException

deleteData

public final void deleteData(int offset,
                             int count)
                      throws com.google.gwt.core.client.JavaScriptException
Remove a range of 16-bit units from the node. Upon success, data and length reflect the change.

Parameters:
offset - The offset from which to start removing.
count - The number of 16-bit units to delete. If the sum of offset and count exceeds length then all 16-bit units from offset to the end of the data are deleted.
Throws:
DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data, or if the specified count is negative.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
com.google.gwt.core.client.JavaScriptException

replaceData

public final void replaceData(int offset,
                              int count,
                              String arg)
                       throws com.google.gwt.core.client.JavaScriptException
Replace the characters starting at the specified 16-bit unit offset with the specified string.

Parameters:
offset - The offset from which to start replacing.
count - The number of 16-bit units to replace. If the sum of offset and count exceeds length, then all 16-bit units to the end of the data are replaced; (i.e., the effect is the same as a remove method call with the same range, followed by an append method invocation).
arg - The DOMString with which the range must be replaced.
Throws:
DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data, or if the specified count is negative.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
com.google.gwt.core.client.JavaScriptException

splitText

public final OMText splitText(int offset)
                       throws com.google.gwt.core.client.JavaScriptException
Breaks this node into two nodes at the specified offset, keeping both in the tree as siblings. After being split, this node will contain all the content up to the offset point. A new node of the same type, which contains all the content at and after the offset point, is returned. If the original node had a parent node, the new node is inserted as the next sibling of the original node. When the offset is equal to the length of this node, the new node has no data.

Parameters:
offset - The 16-bit unit offset at which to split, starting from 0.
Returns:
The new node, of the same type as this node.
Throws:
DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
com.google.gwt.core.client.JavaScriptException


Copyright © 2012. All Rights Reserved.