com.google.gwt.dom.client
Class Element

java.lang.Object
  extended by com.google.gwt.core.client.JavaScriptObject
      extended by com.google.gwt.dom.client.Node
          extended by com.google.gwt.dom.client.Element
Direct Known Subclasses:
AbstractImagePrototype.ImagePrototypeElement, AnchorElement, AreaElement, BaseElement, BodyElement, BRElement, ButtonElement, DivElement, DListElement, Element, FieldSetElement, FormElement, FrameElement, FrameSetElement, HeadElement, HeadingElement, HRElement, IFrameElement, ImageElement, InputElement, LabelElement, LegendElement, LIElement, LinkElement, MapElement, MetaElement, ModElement, ObjectElement, OListElement, OptGroupElement, OptionElement, ParagraphElement, ParamElement, PreElement, QuoteElement, ScriptElement, SelectElement, SpanElement, StyleElement, TableCaptionElement, TableCellElement, TableColElement, TableElement, TableRowElement, TableSectionElement, TextAreaElement, TitleElement, UListElement

public class Element
extends Node

All HTML element interfaces derive from this class.


Field Summary
 
Fields inherited from class com.google.gwt.dom.client.Node
DOCUMENT_NODE, ELEMENT_NODE, TEXT_NODE
 
Constructor Summary
protected Element()
           
 
Method Summary
static Element as(JavaScriptObject o)
          Assert that the given Node is an Element and automatically typecast it.
static Element as(Node node)
          Assert that the given Node is an Element and automatically typecast it.
 void dispatchEvent(NativeEvent evt)
          Dispatched the given event with this element as its target.
 int getAbsoluteLeft()
          Gets an element's absolute left coordinate in the document's coordinate system.
 int getAbsoluteTop()
          Gets an element's absolute top coordinate in the document's coordinate system.
 java.lang.String getAttribute(java.lang.String name)
          Retrieves an attribute value by name.
 java.lang.String getClassName()
          The class attribute of the element.
 int getClientHeight()
          Returns the inner height of an element in pixels, including padding but not the horizontal scrollbar height, border, or margin.
 int getClientWidth()
          Returns the inner width of an element in pixels, including padding but not the vertical scrollbar width, border, or margin.
 java.lang.String getDir()
          Specifies the base direction of directionally neutral text and the directionality of tables.
 NodeList<Element> getElementsByTagName(java.lang.String name)
          Returns a NodeList of all descendant Elements with a given tag name, in the order in which they are encountered in a preorder traversal of this Element tree.
 Element getFirstChildElement()
          The first child of element this element.
 java.lang.String getId()
          The element's identifier.
 java.lang.String getInnerHTML()
          All of the markup and content within a given element.
 java.lang.String getInnerText()
          The text between the start and end tags of the object.
 java.lang.String getLang()
          Language code defined in RFC 1766.
 Element getNextSiblingElement()
          The element immediately following this element.
 int getOffsetHeight()
          The height of an element relative to the layout.
 int getOffsetLeft()
          The number of pixels that the upper left corner of the current element is offset to the left within the offsetParent node.
 Element getOffsetParent()
          Returns a reference to the object which is the closest (nearest in the containment hierarchy) positioned containing element.
 int getOffsetTop()
          The number of pixels that the upper top corner of the current element is offset to the top within the offsetParent node.
 int getOffsetWidth()
          The width of an element relative to the layout.
 Element getParentElement()
          The parent element of this element.
 boolean getPropertyBoolean(java.lang.String name)
          Gets a boolean property from this element.
 double getPropertyDouble(java.lang.String name)
          Gets a double property from this element.
 int getPropertyInt(java.lang.String name)
          Gets an integer property from this element.
 java.lang.String getPropertyString(java.lang.String name)
          Gets a property from this element.
 int getScrollHeight()
          The height of the scroll view of an element.
 int getScrollLeft()
          The number of pixels that an element's content is scrolled from the left.
 int getScrollTop()
          The number of pixels that an element's content is scrolled from the top.
 int getScrollWidth()
          The height of the scroll view of an element.
 java.lang.String getString()
          Gets a string representation of this element (as outer HTML).
 Style getStyle()
          Gets this element's Style object.
 java.lang.String getTagName()
          The name of the element.
 java.lang.String getTitle()
          The element's advisory title.
static boolean is(JavaScriptObject o)
          Determines whether the given JavaScriptObject can be cast to an Element.
static boolean is(Node node)
          Determine whether the given Node can be cast to an Element.
 boolean isOrHasChild(Element child)
          Determine whether an element is equal to, or the child of, this element.
 void removeAttribute(java.lang.String name)
          Removes an attribute by name.
 void scrollIntoView()
          Scrolls this element into view.
 void setAttribute(java.lang.String name, java.lang.String value)
          Adds a new attribute.
 void setClassName(java.lang.String className)
          The class attribute of the element.
 void setDir(java.lang.String dir)
          Specifies the base direction of directionally neutral text and the directionality of tables.
 void setId(java.lang.String id)
          The element's identifier.
 void setInnerHTML(java.lang.String html)
          All of the markup and content within a given element.
 void setInnerText(java.lang.String text)
          The text between the start and end tags of the object.
 void setLang(java.lang.String lang)
          Language code defined in RFC 1766.
 void setPropertyBoolean(java.lang.String name, boolean value)
          Sets a boolean property on this element.
 void setPropertyDouble(java.lang.String name, double value)
          Sets a double property on this element.
 void setPropertyInt(java.lang.String name, int value)
          Sets an integer property on this element.
 void setPropertyString(java.lang.String name, java.lang.String value)
          Sets a property on this element.
 void setScrollLeft(int scrollLeft)
          The number of pixels that an element's content is scrolled to the left.
 void setScrollTop(int scrollTop)
          The number of pixels that an element's content is scrolled to the top.
 void setTitle(java.lang.String title)
          The element's advisory title.
 
Methods inherited from class com.google.gwt.dom.client.Node
appendChild, cloneNode, getChildNodes, getFirstChild, getLastChild, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, hasChildNodes, insertBefore, removeChild, replaceChild, setNodeValue
 
Methods inherited from class com.google.gwt.core.client.JavaScriptObject
cast, createArray, createFunction, createObject, equals, hashCode, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Element

protected Element()
Method Detail

as

public static Element as(JavaScriptObject o)
Assert that the given Node is an Element and automatically typecast it.


as

public static Element as(Node node)
Assert that the given Node is an Element and automatically typecast it.


is

public static boolean is(JavaScriptObject o)
Determines whether the given JavaScriptObject can be cast to an Element. A null object will cause this method to return false.


is

public static boolean is(Node node)
Determine whether the given Node can be cast to an Element. A null node will cause this method to return false.


dispatchEvent

public final void dispatchEvent(NativeEvent evt)
Dispatched the given event with this element as its target. The event will go through all phases of the browser's normal event dispatch mechanism. Note: Because the browser's normal dispatch mechanism is used, exceptions thrown from within handlers triggered by this method cannot be caught by wrapping this method in a try/catch block. Such exceptions will be caught by the uncaught exception handler as usual.

Parameters:
evt - the event to be dispatched

getAbsoluteLeft

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


getAbsoluteTop

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


getAttribute

public final java.lang.String getAttribute(java.lang.String name)
Retrieves an attribute value by name. Attribute support can be inconsistent across various browsers. Consider using the accessors in Element and its specific subclasses to retrieve attributes and properties.

Parameters:
name - The name of the attribute to retrieve
Returns:
The Attr value as a string, or the empty string if that attribute does not have a specified or default value

getClassName

public final java.lang.String getClassName()
The class attribute of the element. This attribute has been renamed due to conflicts with the "class" keyword exposed by many languages.

See Also:
W3C HTML Specification

getClientHeight

public final int getClientHeight()
Returns the inner height of an element in pixels, including padding but not the horizontal scrollbar height, border, or margin.

Returns:
the element's client height

getClientWidth

public final int getClientWidth()
Returns the inner width of an element in pixels, including padding but not the vertical scrollbar width, border, or margin.

Returns:
the element's client width

getDir

public final java.lang.String getDir()
Specifies the base direction of directionally neutral text and the directionality of tables.


getElementsByTagName

public final NodeList<Element> getElementsByTagName(java.lang.String name)
Returns a NodeList of all descendant Elements with a given tag name, in the order in which they are encountered in a preorder traversal of this Element tree.

Parameters:
name - The name of the tag to match on. The special value "*" matches all tags
Returns:
A list of matching Element nodes

getFirstChildElement

public final Element getFirstChildElement()
The first child of element this element. If there is no such element, this returns null.


getId

public final java.lang.String getId()
The element's identifier.

See Also:
W3C HTML Specification

getInnerHTML

public final java.lang.String getInnerHTML()
All of the markup and content within a given element.


getInnerText

public final java.lang.String getInnerText()
The text between the start and end tags of the object.


getLang

public final java.lang.String getLang()
Language code defined in RFC 1766.


getNextSiblingElement

public final Element getNextSiblingElement()
The element immediately following this element. If there is no such element, this returns null.


getOffsetHeight

public final int getOffsetHeight()
The height of an element relative to the layout.


getOffsetLeft

public final int getOffsetLeft()
The number of pixels that the upper left corner of the current element is offset to the left within the offsetParent node.


getOffsetParent

public final Element getOffsetParent()
Returns a reference to the object which is the closest (nearest in the containment hierarchy) positioned containing element.


getOffsetTop

public final int getOffsetTop()
The number of pixels that the upper top corner of the current element is offset to the top within the offsetParent node.


getOffsetWidth

public final int getOffsetWidth()
The width of an element relative to the layout.


getParentElement

public final Element getParentElement()
The parent element of this element.


getPropertyBoolean

public final boolean getPropertyBoolean(java.lang.String name)
Gets a boolean property from this element.

Parameters:
name - the name of the property to be retrieved
Returns:
the property value

getPropertyDouble

public final double getPropertyDouble(java.lang.String name)
Gets a double property from this element.

Parameters:
name - the name of the property to be retrieved
Returns:
the property value

getPropertyInt

public final int getPropertyInt(java.lang.String name)
Gets an integer property from this element.

Parameters:
name - the name of the property to be retrieved
Returns:
the property value

getPropertyString

public final java.lang.String getPropertyString(java.lang.String name)
Gets a property from this element.

Parameters:
name - the name of the property to be retrieved
Returns:
the property value

getScrollHeight

public final int getScrollHeight()
The height of the scroll view of an element.


getScrollLeft

public final int getScrollLeft()
The number of pixels that an element's content is scrolled from the left.

If the element is in RTL mode, this method will return a negative value of the number of pixels scrolled from the right.


getScrollTop

public final int getScrollTop()
The number of pixels that an element's content is scrolled from the top.


getScrollWidth

public final int getScrollWidth()
The height of the scroll view of an element.


getString

public final java.lang.String getString()
Gets a string representation of this element (as outer HTML). We do not override JavaScriptObject.toString() because it is final in JavaScriptObject.

Returns:
the string representation of this element

getStyle

public final Style getStyle()
Gets this element's Style object.


getTagName

public final java.lang.String getTagName()
The name of the element.


getTitle

public final java.lang.String getTitle()
The element's advisory title.


isOrHasChild

public final boolean isOrHasChild(Element child)
Determine whether an element is equal to, or the child of, this element.

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

removeAttribute

public final void removeAttribute(java.lang.String name)
Removes an attribute by name.


scrollIntoView

public final void scrollIntoView()
Scrolls this element into view.

This method crawls up the DOM hierarchy, adjusting the scrollLeft and scrollTop properties of each scrollable element to ensure that the specified element is completely in view. It adjusts each scroll position by the minimum amount necessary.


setAttribute

public final void setAttribute(java.lang.String name,
                               java.lang.String value)
Adds a new attribute. If an attribute with that name is already present in the element, its value is changed to be that of the value parameter.

Parameters:
name - The name of the attribute to create or alter
value - Value to set in string form

setClassName

public final void setClassName(java.lang.String className)
The class attribute of the element. This attribute has been renamed due to conflicts with the "class" keyword exposed by many languages.

See Also:
W3C HTML Specification

setDir

public final void setDir(java.lang.String dir)
Specifies the base direction of directionally neutral text and the directionality of tables.


setId

public final void setId(java.lang.String id)
The element's identifier.

See Also:
W3C HTML Specification

setInnerHTML

public final void setInnerHTML(java.lang.String html)
All of the markup and content within a given element.


setInnerText

public final void setInnerText(java.lang.String text)
The text between the start and end tags of the object.


setLang

public final void setLang(java.lang.String lang)
Language code defined in RFC 1766.


setPropertyBoolean

public final void setPropertyBoolean(java.lang.String name,
                                     boolean value)
Sets a boolean property on this element.

Parameters:
name - the name of the property to be set
value - the new property value

setPropertyDouble

public final void setPropertyDouble(java.lang.String name,
                                    double value)
Sets a double property on this element.

Parameters:
name - the name of the property to be set
value - the new property value

setPropertyInt

public final void setPropertyInt(java.lang.String name,
                                 int value)
Sets an integer property on this element.

Parameters:
name - the name of the property to be set
value - the new property value

setPropertyString

public final void setPropertyString(java.lang.String name,
                                    java.lang.String value)
Sets a property on this element.

Parameters:
name - the name of the property to be set
value - the new property value

setScrollLeft

public final void setScrollLeft(int scrollLeft)
The number of pixels that an element's content is scrolled to the left.


setScrollTop

public final void setScrollTop(int scrollTop)
The number of pixels that an element's content is scrolled to the top.


setTitle

public final void setTitle(java.lang.String title)
The element's advisory title.