com.google.gwt.user.client
Class DOM

java.lang.Object
  extended bycom.google.gwt.user.client.DOM

public class DOM
extends Object

This class provides a set of static methods that allow you to manipulate the browser's Document Object Model (DOM). It contains methods for manipulating both elements and events.


Field Summary
 
Fields inherited from class java.lang.Object
typeId, typeName
 
Constructor Summary
DOM()
           
 
Method Summary
static void addEventPreview(EventPreview preview)
          Adds an event preview to the preview stack.
static void appendChild(Element parent, Element child)
          Appends one element to another's list of children.
static boolean compare(Element elem1, Element elem2)
          Compares two elements for equality (note that reference equality is not sufficient to determine equality among elements on most browsers).
static Element createAnchor()
          Creates an HTML A element.
static Element createButton()
          Creates an HTML BUTTON element.
static Element createCol()
          Creates an HTML COL element.
static Element createDiv()
          Creates an HTML DIV element.
static Element createElement(String tagName)
          Creates an HTML element.
static Element createFieldSet()
          Creates an HTML FIELDSET element.
static Element createIFrame()
          Creates an HTML IFRAME element.
static Element createImg()
          Creates an HTML IMG element.
static Element createInputCheck()
          Creates an HTML INPUT type='CHECK' element.
static Element createInputPassword()
          Creates an HTML INPUT type='PASSWORD' element.
static Element createInputRadio(String group)
          Creates an HTML INPUT type='RADIO' element.
static Element createInputText()
          Creates an HTML INPUT type='TEXT' element.
static Element createLabel()
          Creates an HTML LABEL element.
static Element createLegend()
          Creates an HTML LEGEND element.
static Element createOptions()
          Creates an HTML OPTIONS element.
static Element createSelect()
          Creates an HTML SELECT element.
static Element createSpan()
          Creates an HTML SPAN element.
static Element createTable()
          Creates an HTML TABLE element.
static Element createTBody()
          Creates an HTML BODY element.
static Element createTD()
          Creates an HTML TD element.
static Element createTextArea()
          Creates an HTML TEXTAREA element.
static Element createTH()
          Creates an HTML THEAD element.
static Element createTR()
          Creates an HTML TR element.
static void eventCancelBubble(Event evt, boolean cancel)
          Cancels bubbling for the given event.
static boolean eventGetAltKey(Event evt)
          Gets whether the ALT key was depressed when the given event occurred.
static int eventGetButton(Event evt)
          Gets the mouse buttons that were depressed when the given event occurred.
static int eventGetClientX(Event evt)
          Gets the mouse x-position within the browser window's client area.
static int eventGetClientY(Event evt)
          Gets the mouse y-position within the browser window's client area.
static boolean eventGetCtrlKey(Event evt)
          Gets whether the CTRL key was depressed when the given event occurred.
static Element eventGetFromElement(Event evt)
          Gets the element from which the mouse pointer was moved (only valid for Event.ONMOUSEOVER).
static char eventGetKeyCode(Event evt)
          Gets the key code associated with this event.
static boolean eventGetRepeat(Event evt)
          Gets the key-repeat state of this event.
static int eventGetScreenX(Event evt)
          Gets the mouse x-position on the user's display.
static int eventGetScreenY(Event evt)
          Gets the mouse y-position on the user's display.
static boolean eventGetShiftKey(Event evt)
          Gets whether the shift key was depressed when the given event occurred.
static Element eventGetTarget(Event evt)
          Returns the element that was the actual target of the given event.
static Element eventGetToElement(Event evt)
          Gets the element to which the mouse pointer was moved (only valid for Event.ONMOUSEOUT).
static int eventGetType(Event evt)
          Gets the enumerated type of this event (as defined in Event).
static String eventGetTypeString(Event evt)
          Gets the type of the given event as a string.
static void eventPreventDefault(Event evt)
          Prevents the browser from taking its default action for the given event.
static void eventSetKeyCode(Event evt, char key)
          Sets the key code associated with the given keyboard event.
static String eventToString(Event evt)
          Returns a stringized version of the event.
static int getAbsoluteLeft(Element elem)
          Gets an element's absolute left coordinate in the document's coordinate system.
static int getAbsoluteTop(Element elem)
          Gets an element's absolute top coordinate in the document's coordinate system.
static String getAttribute(Element elem, String attr)
          Gets any named attribute from an element, as a string.
static Element getCaptureElement()
          Gets the element that currently has mouse capture.
static Element getChild(Element parent, int index)
          Gets an element's n-th child element
static int getChildCount(Element parent)
          Gets the number of child elements present in a given parent element.
static int getChildIndex(Element parent, Element child)
          Gets the index of a given child element within its parent.
static Element getElementById(String id)
          Gets the element associated with the given unique id within the entire document.
static int getEventsSunk(Element elem)
          Gets the current set of events sunk by a given element.
static Element getFirstChild(Element elem)
          Gets the first child element of the given element.
static String getInnerHTML(Element elem)
          Gets an HTML representation of an element's children.
static String getInnerText(Element elem)
          Gets the text contained within an element.
static int getIntAttribute(Element elem, String attr)
          Gets an integer attribute on a given element.
static int getIntStyleAttribute(Element elem, String attr)
          Gets an integer attribute on a given element's style.
static Element getNextSibling(Element elem)
          Gets an element's next sibling element.
static Element getParent(Element elem)
          Gets an element's parent element.
static String getStyleAttribute(Element elem, String attr)
          Gets an attribute of the given element's style.
static void insertChild(Element parent, Element child, int index)
          Inserts an element as a child of the given parent element.
static boolean isOrHasChild(Element parent, Element child)
          Determine whether one element is equal to, or the child of, another.
static void releaseCapture(Element elem)
          Releases mouse capture on the given element.
static void removeChild(Element parent, Element child)
          Removes a child element from the given parent element.
static void removeEventPreview(EventPreview preview)
          Removes an element from the preview stack.
static void setAttribute(Element elem, String attr, String value)
          Sets an attribute on the given element.
static void setCapture(Element elem)
          Sets mouse-capture on the given element.
static void setEventListener(Element elem, EventListener listener)
          Sets the EventListener to receive events for the given element.
static void setInnerHTML(Element elem, String html)
          Sets the HTML contained within an element.
static void setInnerText(Element elem, String text)
          Sets the text contained within an element.
static void setIntAttribute(Element elem, String attr, int value)
          Sets an integer attribute on the given element.
static void setIntStyleAttribute(Element elem, String attr, int value)
          Sets an integer attribute on the given element's style.
static void setStyleAttribute(Element elem, String attr, String value)
          Sets an attribute on the given element's style.
static void sinkEvents(Element elem, int eventBits)
          Sets the current set of events sunk by a given element.
static String toString(Element elem)
          Returns a stringized version of the element.
 
Methods inherited from class java.lang.Object
equals, finalize, hashCode, toString
 

Constructor Detail

DOM

public DOM()
Method Detail

addEventPreview

public static void addEventPreview(EventPreview preview)
Adds an event preview to the preview stack. As long as this preview remains on the top of the stack, it will receive all events before they are fired to their listeners. Note that the event preview will receive all events, including those received due to bubbling, whereas normal event handlers only receive explicitly sunk events.

Parameters:
preview - the event preview to be added to the stack.

appendChild

public static void appendChild(Element parent,
                               Element child)
Appends one element to another's list of children.

Parameters:
parent - the parent element
child - its new child

compare

public static boolean compare(Element elem1,
                              Element elem2)
Compares two elements for equality (note that reference equality is not sufficient to determine equality among elements on most browsers).

Parameters:
elem1 - the first element to be compared
elem2 - the second element to be compared
Returns:
true if they are in fact the same element

createAnchor

public static Element createAnchor()
Creates an HTML A element.

Returns:
the newly-created element

createButton

public static Element createButton()
Creates an HTML BUTTON element.

Returns:
the newly-created element

createCol

public static Element createCol()
Creates an HTML COL element.

Returns:
the newly-created element

createDiv

public static Element createDiv()
Creates an HTML DIV element.

Returns:
the newly-created element

createElement

public static Element createElement(String tagName)
Creates an HTML element.

Parameters:
tagName - the HTML tag of the element to be created
Returns:
the newly-created element

createFieldSet

public static Element createFieldSet()
Creates an HTML FIELDSET element.

Returns:
the newly-created element

createIFrame

public static Element createIFrame()
Creates an HTML IFRAME element.

Returns:
the newly-created element

createImg

public static Element createImg()
Creates an HTML IMG element.

Returns:
the newly-created element

createInputCheck

public static Element createInputCheck()
Creates an HTML INPUT type='CHECK' element.

Returns:
the newly-created element

createInputPassword

public static Element createInputPassword()
Creates an HTML INPUT type='PASSWORD' element.

Returns:
the newly-created element

createInputRadio

public static Element createInputRadio(String group)
Creates an HTML INPUT type='RADIO' element.

Parameters:
group - the name of the group with which this radio button will be associated
Returns:
the newly-created element

createInputText

public static Element createInputText()
Creates an HTML INPUT type='TEXT' element.

Returns:
the newly-created element

createLabel

public static Element createLabel()
Creates an HTML LABEL element.

Returns:
the newly-created element

createLegend

public static Element createLegend()
Creates an HTML LEGEND element.

Returns:
the newly-created element

createOptions

public static Element createOptions()
Creates an HTML OPTIONS element.

Returns:
the newly-created element

createSelect

public static Element createSelect()
Creates an HTML SELECT element.

Returns:
the newly-created element

createSpan

public static Element createSpan()
Creates an HTML SPAN element.

Returns:
the newly-created element

createTable

public static Element createTable()
Creates an HTML TABLE element.

Returns:
the newly-created element

createTBody

public static Element createTBody()
Creates an HTML BODY element.

Returns:
the newly-created element

createTD

public static Element createTD()
Creates an HTML TD element.

Returns:
the newly-created element

createTextArea

public static Element createTextArea()
Creates an HTML TEXTAREA element.

Returns:
the newly-created element

createTH

public static Element createTH()
Creates an HTML THEAD element.

Returns:
the newly-created element

createTR

public static Element createTR()
Creates an HTML TR element.

Returns:
the newly-created element

eventCancelBubble

public static void eventCancelBubble(Event evt,
                                     boolean cancel)
Cancels bubbling for the given event. This will stop the event from being propagated to parent elements.

Parameters:
evt - the event on which to cancel bubbling
cancel - true to cancel bubbling

eventGetAltKey

public static boolean eventGetAltKey(Event evt)
Gets whether the ALT key was depressed when the given event occurred.

Parameters:
evt - the event to be tested
Returns:
true if ALT was depressed when the event occurred

eventGetButton

public static int eventGetButton(Event evt)
Gets the mouse buttons that were depressed when the given event occurred.

Parameters:
evt - the event to be tested
Returns:
a bit-field, defined by Event.BUTTON_LEFT, Event.BUTTON_MIDDLE, and Event.BUTTON_RIGHT

eventGetClientX

public static int eventGetClientX(Event evt)
Gets the mouse x-position within the browser window's client area.

Parameters:
evt - the event to be tested
Returns:
the mouse x-position

eventGetClientY

public static int eventGetClientY(Event evt)
Gets the mouse y-position within the browser window's client area.

Parameters:
evt - the event to be tested
Returns:
the mouse y-position

eventGetCtrlKey

public static boolean eventGetCtrlKey(Event evt)
Gets whether the CTRL key was depressed when the given event occurred.

Parameters:
evt - the event to be tested
Returns:
true if CTRL was depressed when the event occurred

eventGetFromElement

public static Element eventGetFromElement(Event evt)
Gets the element from which the mouse pointer was moved (only valid for Event.ONMOUSEOVER).

Parameters:
evt - the event to be tested
Returns:
the element from which the mouse pointer was moved

eventGetKeyCode

public static char eventGetKeyCode(Event evt)
Gets the key code associated with this event.

For Event.ONKEYPRESS, this method returns the Unicode value of the character generated. For Event.ONKEYDOWN and Event.ONKEYUP, it returns the code associated with the physical key.

Parameters:
evt - the event to be tested
Returns:
the Unicode character or key code.
See Also:
KeyboardListener

eventGetRepeat

public static boolean eventGetRepeat(Event evt)
Gets the key-repeat state of this event.

Parameters:
evt - the event to be tested
Returns:
true if this key event was an auto-repeat

eventGetScreenX

public static int eventGetScreenX(Event evt)
Gets the mouse x-position on the user's display.

Parameters:
evt - the event to be tested
Returns:
the mouse x-position

eventGetScreenY

public static int eventGetScreenY(Event evt)
Gets the mouse y-position on the user's display.

Parameters:
evt - the event to be tested
Returns:
the mouse y-position

eventGetShiftKey

public static boolean eventGetShiftKey(Event evt)
Gets whether the shift key was depressed when the given event occurred.

Parameters:
evt - the event to be tested
Returns:
true if shift was depressed when the event occurred

eventGetTarget

public static Element eventGetTarget(Event evt)
Returns the element that was the actual target of the given event.

Parameters:
evt - the event to be tested
Returns:
the target element

eventGetToElement

public static Element eventGetToElement(Event evt)
Gets the element to which the mouse pointer was moved (only valid for Event.ONMOUSEOUT).

Parameters:
evt - the event to be tested
Returns:
the element to which the mouse pointer was moved

eventGetType

public static int eventGetType(Event evt)
Gets the enumerated type of this event (as defined in Event).

Parameters:
evt - the event to be tested
Returns:
the event's enumerated type

eventGetTypeString

public static String eventGetTypeString(Event evt)
Gets the type of the given event as a string.

Parameters:
evt - the event to be tested
Returns:
the event's type name

eventPreventDefault

public static void eventPreventDefault(Event evt)
Prevents the browser from taking its default action for the given event.

Parameters:
evt - the event whose default action is to be prevented

eventSetKeyCode

public static void eventSetKeyCode(Event evt,
                                   char key)
Sets the key code associated with the given keyboard event.

Parameters:
evt - the event whose key code is to be set
key - the new key code

eventToString

public static String eventToString(Event evt)
Returns a stringized version of the event. This string is for debugging purposes and will NOT be consistent on different browsers.

Parameters:
evt - the event to stringize
Returns:
a string form of the event

getAbsoluteLeft

public static int getAbsoluteLeft(Element elem)
Gets an element's absolute left coordinate in the document's coordinate system.

Parameters:
elem - the element to be measured
Returns:
the element's absolute left coordinate

getAbsoluteTop

public static int getAbsoluteTop(Element elem)
Gets an element's absolute top coordinate in the document's coordinate system.

Parameters:
elem - the element to be measured
Returns:
the element's absolute top coordinate

getAttribute

public static String getAttribute(Element elem,
                                  String attr)
Gets any named attribute from an element, as a string.

Parameters:
elem - the element whose attribute is to be retrieved
attr - the name of the attribute
Returns:
the attribute's value

getCaptureElement

public static Element getCaptureElement()
Gets the element that currently has mouse capture.

Returns:
a handle to the capture element, or null if none exists

getChild

public static Element getChild(Element parent,
                               int index)
Gets an element's n-th child element

Parameters:
parent - the element whose child is to be retrieved
index - the index of the child element
Returns:
the n-th child element

getChildCount

public static int getChildCount(Element parent)
Gets the number of child elements present in a given parent element.

Parameters:
parent - the element whose children are to be counted
Returns:
the number of children

getChildIndex

public static int getChildIndex(Element parent,
                                Element child)
Gets the index of a given child element within its parent.

Parameters:
parent - the parent element
child - the child element
Returns:
the child's index within its parent, or -1 if it is not a child of the given parent

getElementById

public static Element getElementById(String id)
Gets the element associated with the given unique id within the entire document.

Parameters:
id - the id whose associated element is to be retrieved
Returns:
the associated element, or null if none is found

getEventsSunk

public static int getEventsSunk(Element elem)
Gets the current set of events sunk by a given element.

Parameters:
elem - the element whose events are to be retrieved
Returns:
a bitfield describing the events sunk on this element (its possible values are described in Event)

getFirstChild

public static Element getFirstChild(Element elem)
Gets the first child element of the given element.

Parameters:
elem - the element whose child is to be retrieved
Returns:
the child element

getInnerHTML

public static String getInnerHTML(Element elem)
Gets an HTML representation of an element's children.

Parameters:
elem - the element whose HTML is to be retrieved
Returns:
the HTML representation of the element's children

getInnerText

public static String getInnerText(Element elem)
Gets the text contained within an element. If the element has child elements, only the text between them will be retrieved.

Parameters:
elem - the element whose inner text is to be retrieved
Returns:
the text inside this element

getIntAttribute

public static int getIntAttribute(Element elem,
                                  String attr)
Gets an integer attribute on a given element.

Parameters:
elem - the element whose attribute is to be retrieved
attr - the name of the attribute to be retrieved
Returns:
the attribute's value as an integer

getIntStyleAttribute

public static int getIntStyleAttribute(Element elem,
                                       String attr)
Gets an integer attribute on a given element's style.

Parameters:
elem - the element whose style attribute is to be retrieved
attr - the name of the attribute to be retrieved
Returns:
the style attribute's value as an integer

getNextSibling

public static Element getNextSibling(Element elem)
Gets an element's next sibling element.

Parameters:
elem - the element whose sibling is to be retrieved
Returns:
the sibling element

getParent

public static Element getParent(Element elem)
Gets an element's parent element.

Parameters:
elem - the element whose parent is to be retrieved
Returns:
the parent element

getStyleAttribute

public static String getStyleAttribute(Element elem,
                                       String attr)
Gets an attribute of the given element's style.

Parameters:
elem - the element whose style attribute is to be retrieved
attr - the name of the style attribute to be retrieved
Returns:
the style attribute's value

insertChild

public static void insertChild(Element parent,
                               Element child,
                               int index)
Inserts an element as a child of the given parent element.

Parameters:
parent - the parent element
child - the child element
index - the index before which the child will be inserted (any value greater than the number of existing children will cause the child to be appended)

isOrHasChild

public static boolean isOrHasChild(Element parent,
                                   Element child)
Determine whether one element is equal to, or the child of, another.

Parameters:
parent - the potential parent element
child - the potential child element
Returns:
true if the relationship holds

releaseCapture

public static void releaseCapture(Element elem)
Releases mouse capture on the given element. Calling this method has no effect if the element does not currently have mouse capture.

Parameters:
elem - the element to release capture
See Also:
setCapture(Element)

removeChild

public static void removeChild(Element parent,
                               Element child)
Removes a child element from the given parent element.

Parameters:
parent - the parent element
child - the child element to be removed

removeEventPreview

public static void removeEventPreview(EventPreview preview)
Removes an element from the preview stack. This element will no longer capture events, though any preview underneath it will begin to do so.

Parameters:
preview - the event preview to be removed from the stack

setAttribute

public static void setAttribute(Element elem,
                                String attr,
                                String value)
Sets an attribute on the given element.

Parameters:
elem - the element whose attribute is to be set
attr - the name of the attribute to be set
value - the new attribute value

setCapture

public static void setCapture(Element elem)
Sets mouse-capture on the given element. This element will directly receive all mouse events until releaseCapture(Element) is called on it.

Parameters:
elem - the element on which to set mouse capture

setEventListener

public static void setEventListener(Element elem,
                                    EventListener listener)
Sets the EventListener to receive events for the given element. Only one such listener may exist for a single element.

Parameters:
elem - the element whose listener is to be set
listener - the listener to receive events

setInnerHTML

public static void setInnerHTML(Element elem,
                                String html)
Sets the HTML contained within an element.

Parameters:
elem - the element whose inner HTML is to be set
html - the new html

setInnerText

public static void setInnerText(Element elem,
                                String text)
Sets the text contained within an element. If the element already has children, they will be destroyed.

Parameters:
elem - the element whose inner text is to be set
text - the new text

setIntAttribute

public static void setIntAttribute(Element elem,
                                   String attr,
                                   int value)
Sets an integer attribute on the given element.

Parameters:
elem - the element whose attribute is to be set
attr - the name of the attribute to be set
value - the attribute's new integer value

setIntStyleAttribute

public static void setIntStyleAttribute(Element elem,
                                        String attr,
                                        int value)
Sets an integer attribute on the given element's style.

Parameters:
elem - the element whose style attribute is to be set
attr - the name of the style attribute to be set
value - the style attribute's new integer value

setStyleAttribute

public static void setStyleAttribute(Element elem,
                                     String attr,
                                     String value)
Sets an attribute on the given element's style.

Parameters:
elem - the element whose style attribute is to be set
attr - the name of the style attribute to be set
value - the style attribute's new value

sinkEvents

public static void sinkEvents(Element elem,
                              int eventBits)
Sets the current set of events sunk by a given element. These events will be fired to the nearest EventListener specified on any of the element's parents.

Parameters:
elem - the element whose events are to be retrieved
eventBits - a bitfield describing the events sunk on this element (its possible values are described in Event)

toString

public static String toString(Element elem)
Returns a stringized version of the element. This string is for debugging purposes and will NOT be consistent on different browsers.

Parameters:
elem - the element to stringize
Returns:
a string form of the element


This javadoc distribution was not produced by Google. The official documentation is here.