UIObject

Adds a dependent style name by specifying the style name's suffix. The actual form of the style name that is added is:

 getStylePrimaryName() + '-' + styleSuffix
 

Adds a secondary or dependent style name to this object. A secondary style name is an additional style name that is, in HTML/CSS terms, included as a space-separated token in the value of the CSS class attribute for this object's root element.

The most important use for this method is to add a special kind of secondary style name called a dependent style name. To add a dependent style name, use addStyleDependentName(String), which will prefix the 'style' argument with the result of getStylePrimaryName() (followed by a '-'). For example, suppose the primary style name is gwt-TextBox. If the following method is called as obj.setReadOnly(true):

 public void setReadOnly(boolean readOnly) {
   isReadOnlyMode = readOnly;
   
   // Create a dependent style name.
   String readOnlyStyle = "readonly";
    
   if (readOnly) {
     addStyleDependentName(readOnlyStyle);
   } else {
     removeStyleDependentName(readOnlyStyle);
   }
 }

then both of the CSS style rules below will be applied:

 // This rule is based on the primary style name and is always active.
 .gwt-TextBox {
   font-size: 12pt;
 }
 
 // This rule is based on a dependent style name that is only active
 // when the widget has called addStyleName(getStylePrimaryName() +
 // "-readonly").
 .gwt-TextBox-readonly {
   background-color: lightgrey;
   border: none;
 }

The code can also be simplified with setStyleDependentName(String, boolean):

 public void setReadOnly(boolean readOnly) {
   isReadOnlyMode = readOnly;
   setStyleDependentName("readonly", readOnly);
 }

Dependent style names are powerful because they are automatically updated whenever the primary style name changes. Continuing with the example above, if the primary style name changed due to the following call:

setStylePrimaryName("my-TextThingy");

then the object would be re-associated with following style rules, removing those that were shown above.

 .my-TextThingy {
   font-size: 20pt;
 }
 
 .my-TextThingy-readonly {
   background-color: red;
   border: 2px solid yellow;
 }

Secondary style names that are not dependent style names are not automatically updated when the primary style name changes.

Ensure that the main Element for this UIObject has an ID property set, which allows it to integrate with third-party libraries and test tools. Complex Widgets will also set the IDs of their important sub-elements. If the main element already has an ID, this method WILL override it. The ID that you specify will be prefixed by the static string DEBUG_ID_PREFIX. This method will be compiled out and will have no effect unless you inherit the DebugID module in your gwt.xml file by adding the following line:

 <inherits name="com.google.gwt.user.Debug"/>

Ensure that elem has an ID property set, which allows it to integrate with third-party libraries and test tools. If elem already has an ID, this method WILL override it. The ID that you specify will be prefixed by the static string DEBUG_ID_PREFIX.

This method will be compiled out and will have no effect unless you inherit the DebugID module in your gwt.xml file by adding the following line:

 <inherits name="com.google.gwt.user.Debug"/>

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

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

Gets a handle to the object's underlying DOM element. This method should not be overridden. It is non-final solely to support legacy code that depends upon overriding it. If it is overridden, the subclass implementation must not return a different element than was previously set using setElement(com.google.gwt.user.client.Element).

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

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

Gets all of the object's style names, as a space-separated list. If you wish to retrieve only the primary style name, call getStylePrimaryName().

Gets the primary style name associated with the object.

Gets the title associated with this object. The title is the 'tool-tip' displayed to users when they hover over the object.

Determines whether or not this object is visible.

Removes a dependent style name by specifying the style name's suffix.

Removes a style name. This method is typically used to remove secondary style names, but it can be used to remove primary stylenames as well. That use is not recommended.

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

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

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

Adds or removes a dependent style name by specifying the style name's suffix. The actual form of the style name that is added is:

 getStylePrimaryName() + '-' + styleSuffix
 

Clears all of the object's style names and sets it to the given style. You should normally use setStylePrimaryName(String) unless you wish to explicitly remove all existing styles.

Adds or removes a style name. This method is typically used to remove secondary style names, but it can be used to remove primary stylenames as well. That use is not recommended.

Sets the object's primary style name and updates all dependent style names.

Sets the title associated with this object. The title is the 'tool-tip' displayed to users when they hover over the object.

Sets whether this object is visible.

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

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.

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

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

Set the debug id of a specific element. The id will be appended to the end of the base debug id, with a dash separator. The base debug id is the ID of the main element in this UIObject.

Template method that returns the element to which style names will be applied. By default it returns the root element, but this method may be overridden to apply styles to a child element.

Gets all of the element's style names, as a space-separated list.

Gets the element's primary style name.

Called when the user sets the id using the ensureDebugId(String) method. Subclasses of UIObject can override this method to add IDs to their sub elements. If a subclass does override this method, it should list the IDs (relative to the base ID), that will be applied to each sub Element with a short description. For example:

• -mysubelement = Applies to my sub element.

 <inherits name="com.google.gwt.user.Debug"/>

Sets this object's browser element. UIObject subclasses must call this method before attempting to call any other methods, and it may only be called once.

Sets this object's browser element. UIObject subclasses must call this method before attempting to call any other methods, and it may only be called once. This method exists for backwards compatibility with pre-1.5 code. As of GWT 1.5, setElement(Element) is the preferred method.

Clears all of the element's style names and sets it to the given style.

This convenience method adds or removes a style name for a given element. This method is typically used to add and remove secondary style names, but it can be used to remove primary stylenames as well, but that is not recommended. See setStyleName(String) for a description of how primary and secondary style names are used.

Sets the element's primary style name and updates all dependent style names.