com.google.gwt.user.client.ui
Class UIObject

java.lang.Object
  com.google.gwt.user.client.ui.UIObject

Direct Known Subclasses:

MenuItem, TreeItem, Widget

public abstract class UIObject

extends Object

The base class for all user-interface objects. It simply wraps a DOM element, and cannot receive events. Most interesting user-interface classes derive from Widget.

Field Summary

Fields inherited from class java.lang.Object

typeId, typeName

Constructor Summary

UIObject()

Method Summary

void	addStyleName(String style) Adds a style name to the widget.
int	getAbsoluteLeft() Gets the object's absolute left position in pixels, as measured from the browser window's client area.
int	getAbsoluteTop() Gets the object's absolute top position in pixels, as measured from the browser window's client area.
Element	getElement() Gets a handle to the object's underlying DOM element.
int	getOffsetHeight() Gets the object's offset height in pixels.
int	getOffsetWidth() Gets the object's offset width in pixels.
String	getStyleName() Gets the style name associated with the object.
boolean	isVisible() Determines whether or not this object is visible.
static boolean	isVisible(Element elem)
void	removeStyleName(String style) Removes a style name from the widget.
protected void	setElement(Element elem) Sets this object's browser element.
void	setHeight(String height) Sets the object's height.
void	setPixelSize(int width, int height) Sets the object's size, in pixels, not including decorations such as border, margin, and padding.
void	setSize(String width, String height) Sets the object's size.
protected static void	setStyleName(Element elem, String style, boolean add) This convenience method implements allows one to easily add or remove the style name for any element.
void	setStyleName(String style) Sets the object's style name, removing all other styles.
void	setVisible(boolean visible) Sets whether this object is visible.
static void	setVisible(Element elem, boolean visible)
void	setWidth(String width) Sets the object's width.
void	sinkEvents(int eventBitsToAdd) Adds a set of events to be sunk by this object.
String	toString() This method is overridden so that any object can be viewed in the debugger as an HTML snippet.
void	unsinkEvents(int eventBitsToRemove) Removes a set of events from this object's event list.

Methods inherited from class java.lang.Object

equals, finalize, hashCode

Constructor Detail

UIObject

public UIObject()

Method Detail

isVisible

public static boolean isVisible(Element elem)

setVisible

public static void setVisible(Element elem,
                              boolean visible)

setStyleName

protected static void setStyleName(Element elem,
                                   String style,
                                   boolean add)

This convenience method implements allows one to easily add or remove the style name for any element. This can be useful when you need to add and remove styles from a sub-element within a UIObject.

Parameters:

elem - the element whose style is to be modified

style - the style name to be added or removed

add - true to add the given style, false to remove it

addStyleName

public void addStyleName(String style)

Adds a style name to the widget.

Parameters:

style - the style name to be added

See Also:

removeStyleName(String)

getAbsoluteLeft

public int getAbsoluteLeft()

Gets the object's absolute left position in pixels, as measured from the browser window's client area.

Returns:

the object's absolute left position

getAbsoluteTop

public int getAbsoluteTop()

Gets the object's absolute top position in pixels, as measured from the browser window's client area.

Returns:

the object's absolute top position

getElement

public Element getElement()

Gets a handle to the object's underlying DOM element.

Returns:

the object's browser element

getOffsetHeight

public int getOffsetHeight()

Gets the object's offset height in pixels. This is the total height of the object, including decorations such as border, margin, and padding.

Returns:

the object's offset height

getOffsetWidth

public int getOffsetWidth()

Gets the object's offset width in pixels. This is the total width of the object, including decorations such as border, margin, and padding.

Returns:

the object's offset width

getStyleName

public String getStyleName()

Gets the style name associated with the object.

Returns:

the object's style name

See Also:

setStyleName(com.google.gwt.user.client.Element, java.lang.String, boolean)

isVisible

public boolean isVisible()

Determines whether or not this object is visible.

Returns:

true if the object is visible

removeStyleName

public void removeStyleName(String style)

Removes a style name from the widget.

Parameters:

style - the style name to be added

See Also:

addStyleName(String)

setHeight

public void setHeight(String height)

Sets the object's height. This height does not include decorations such as border, margin, and padding.

Parameters:

height - the object's new height, in CSS units (e.g. "10px", "1em")

setPixelSize

public void setPixelSize(int width,
                         int height)

Sets the object's size, in pixels, not including decorations such as border, margin, and padding.

Parameters:

width - the object's new width, in pixels

height - the object's new height, in pixels

setSize

public void setSize(String width,
                    String height)

Sets the object's size. This size does not include decorations such as border, margin, and padding.

Parameters:

width - the object's new width, in CSS units (e.g. "10px", "1em")

height - the object's new height, in CSS units (e.g. "10px", "1em")

setStyleName

public void setStyleName(String style)

Sets the object's style name, removing all other styles.

The style name is the name referred to in CSS style rules (in HTML, this is referred to as the element's "class"). By convention, style rules are of the form [project]-[widget] (e.g. the Button widget's style name is .gwt-Button).

For example, if a widget's style name is myProject-MyWidget, then the style rule that applies to it will be .myProject-MyWidget. Note the "dot" prefix -- this is necessary because calling this method sets the underlying element's className property.

An object may have any number of style names, which may be manipulated using addStyleName(String) and removeStyleName(String). The attributes of all styles associated with the object will be applied to it.

Parameters:

style - the style name to be added

See Also:

addStyleName(String), removeStyleName(String)

setVisible

public void setVisible(boolean visible)

Sets whether this object is visible.

Parameters:

visible - true to show the object, false to hide it

setWidth

public void setWidth(String width)

Sets the object's width. This width does not include decorations such as border, margin, and padding.

Parameters:

width - the object's new width, in CSS units (e.g. "10px", "1em")

sinkEvents

public void sinkEvents(int eventBitsToAdd)

Adds a set of events to be sunk by this object. Note that only widgets may actually receive events, but can receive events from all objects contained within them.

Parameters:

eventBitsToAdd - a bitfield representing the set of events to be added to this element's event set

See Also:

Event

toString

public String toString()

This method is overridden so that any object can be viewed in the debugger as an HTML snippet.

Returns:

a string representation of the object

unsinkEvents

public void unsinkEvents(int eventBitsToRemove)

Removes a set of events from this object's event list.

Parameters:

eventBitsToRemove - a bitfield representing the set of events to be removed from this element's event set

See Also:

sinkEvents(int), Event

setElement

protected void setElement(Element elem)

Sets this object's browser element. UIObject subclasses must call this method before attempting to call any other methods.