API Reference 0.3.24dart_web_toolkit_uiRadioButton

RadioButton class

A mutually-exclusive selection radio button widget. Fires {@link com.google.gwt.event.dom.client.ClickEvent}s when the radio button is clicked, and {@link ValueChangeEvent}s when the button becomes checked. Note, however, that browser limitations prevent ValueChangeEvents from being sent when the radio button is cleared as a side effect of another in the group being clicked.

Built-in Bidi Text Support

This widget is capable of automatically adjusting its direction according to its content. This feature is controlled by {@link #setDirectionEstimator} or passing a DirectionEstimator parameter to the constructor, and is off by default.

CSS Style Rules

.gwt-RadioButton
the outer element

Example

{@example com.google.gwt.examples.RadioButtonExample}

class RadioButton extends CheckBox {

 bool _oldValue;

 /**
  * Creates a new radio associated with a particular group name. All radio
  * buttons associated with the same group name belong to a mutually-exclusive
  * set.
  *
  * Radio buttons are grouped by their name attribute, so changing their name
  * using the setName() method will also change their associated group.
  *
  * @param name the group name with which to associate the radio button
  */
 RadioButton(String name, [String label = null, bool asHtml = false]) : super.fromElement(new dart_html.InputElement()) {
   inputElem.type = "radio";
   //super(DOM.createInputRadio(name));
   inputElem.name = name;
   clearAndSetStyleName("dwt-RadioButton");

   if (label != null) {
     if (asHtml) {
       html = label;
     } else {
       text = label;
     }
   }
   sinkEvents(IEvent.ONCLICK);
   sinkEvents(IEvent.ONMOUSEUP);
   sinkEvents(IEvent.ONBLUR);
   sinkEvents(IEvent.ONKEYDOWN);
 }

 /**
  * Overridden to send ValueChangeEvents only when appropriate.
  */
 void onBrowserEvent(dart_html.Event event) {
   
   if (event.type == BrowserEvents.MOUSEUP ||
       event.type == BrowserEvents.BLUR ||
       event.type == BrowserEvents.KEYDOWN) {
     // Note the old value for onValueChange purposes (in ONCLICK case)
     _oldValue = getValue();
   } else if (event.type == BrowserEvents.CLICK) {
     dart_html.EventTarget target = (event as dart_html.MouseEvent).target;
     if (target is  dart_html.Element && Dom.isOrHasChild(labelElem, target as dart_html.Element)) {

       // They clicked the label. Note our pre-click value, and
       // short circuit event routing so that other click handlers
       // don't hear about it
       _oldValue = getValue();
       return;
     }

     // It's not the label. Let our handlers hear about the
     // click...
     super.onBrowserEvent(event);
     // ...and now maybe tell them about the change
     ValueChangeEvent.fireIfNotEqual(this, _oldValue, getValue());
     return;
   }

   super.onBrowserEvent(event);
 }
 
 //**************************
 // Implementation of HasName
 //**************************

 /**
  * Change the group name of this radio button.
  *
  * Radio buttons are grouped by their name attribute, so changing their name
  * using the setName() method will also change their associated group.
  *
  * If changing this group name results in a new radio group with multiple
  * radio buttons selected, this radio button will remain selected and the
  * other radio buttons will be unselected.
  *
  * @param name name the group with which to associate the radio button
  */
 void set name(String val) {
   // Just changing the radio button name tends to break groupiness,
   // so we have to replace it. Note that replaceInputElement is careful
   // not to propagate name when it propagates everything else
   dart_html.InputElement radio = new dart_html.InputElement();
   radio.type = "radio";
   radio.name = name;
   replaceInputElement(radio);
 }

 // Unlike other widgets the Radio button sinks on its inputElement, not
 // its wrapper
 void sinkEvents(int eventBitsToAdd) {
   // Like CheckBox, we want to hear about inputElem. We
   // also want to know what's going on with the label, to
   // make sure onBrowserEvent is able to record value changes
   // initiated by label events
   if (isOrWasAttached()) {
     IEvent.sinkEvents(inputElem, eventBitsToAdd | IEvent.getEventsSunk(inputElem));
     IEvent.sinkEvents(labelElem, eventBitsToAdd | IEvent.getEventsSunk(labelElem));
   } else {
     super.sinkEvents(eventBitsToAdd);
   }
 }
 
 /**
  * No-op. CheckBox's click handler is no good for radio button, so don't use
  * it. Our event handling is all done in {@link #onBrowserEvent}
  */
 void ensureDomEventHandlers() {}
}

Extends

UiObject > Widget > FocusWidget > ButtonBase > CheckBox > RadioButton

Constructors

new RadioButton(String name, [String label = null, bool asHtml = false]) #

Creates a new radio associated with a particular group name. All radio buttons associated with the same group name belong to a mutually-exclusive set.

Radio buttons are grouped by their name attribute, so changing their name using the setName() method will also change their associated group.

@param name the group name with which to associate the radio button

RadioButton(String name, [String label = null, bool asHtml = false]) : super.fromElement(new dart_html.InputElement()) {
 inputElem.type = "radio";
 //super(DOM.createInputRadio(name));
 inputElem.name = name;
 clearAndSetStyleName("dwt-RadioButton");

 if (label != null) {
   if (asHtml) {
     html = label;
   } else {
     text = label;
   }
 }
 sinkEvents(IEvent.ONCLICK);
 sinkEvents(IEvent.ONMOUSEUP);
 sinkEvents(IEvent.ONBLUR);
 sinkEvents(IEvent.ONKEYDOWN);
}

Properties

void set accessKey(int key) #

inherited from FocusWidget

Sets the widget's 'access key'. This key is used (in conjunction with a browser-specific modifier key) to automatically focus the widget.

@param key the widget's access key

void set accessKey(int key) {
 //Dom.setElementProperty(getElement(), "accessKey", "" + key);
}

DirectionalTextHelper directionalTextHelper #

inherited from CheckBox
DirectionalTextHelper directionalTextHelper

LeafValueEditor<bool> editor #

inherited from CheckBox
LeafValueEditor<bool> editor

bool get enabled #

inherited from CheckBox

Gets whether this widget is enabled.

@return <code>true</code> if the widget is enabled

bool get enabled => !inputElem.disabled;

void set enabled(bool val) #

inherited from CheckBox

Sets whether this widget is enabled.

@param enabled <code>true</code> to enable the widget, <code>false</code>

     to disable it
void set enabled(bool val) {
 //Dom.setElementPropertyBoolean(inputElem, "disabled", !val);
 inputElem.disabled = !val;
 if (val) {
   removeStyleDependentName("disabled");
 } else {
   addStyleDependentName("disabled");
 }
}

int eventsToSink #

inherited from Widget

A set og events that should be sunk when the widget is attached to the DOM. (We delay the sinking of events to improve startup performance.) When the widget is attached, this is set is empty

Package protected to allow Composite to see it.

int eventsToSink = 0

void set focus(bool focused) #

inherited from CheckBox

Explicitly focus/unfocus this widget. Only one widget can have focus at a time, and the widget that does will receive all keyboard events.

@param focused whether this widget should take focus or release it

void set focus(bool focused) {
 if (focused) {
   inputElem.focus();
 } else {
   inputElem.blur();
 }
}

String get formValue #

inherited from CheckBox

Returns the value property of the input element that backs this widget. This is the value that will be associated with the CheckBox name and submitted to the server if a {@link FormPanel} that holds it is submitted and the box is checked. <p> Don't confuse this with {@link #getValue}, which returns true or false if the widget is checked.

String get formValue => inputElem.value;

void set formValue(String val) #

inherited from CheckBox

Set the value property on the input element that backs this widget. This is the value that will be associated with the CheckBox's name and submitted to the server if a {@link FormPanel} that holds it is submitted and the box is checked. <p> Don't confuse this with {@link #setValue}, which actually checks and unchecks the box.

@param value

void set formValue(String val) {
 inputElem.value = val;
}

String get html #

inherited from CheckBox

Gets this object's contents as HTML.

@return the object's HTML

String get html {
 return directionalTextHelper.getTextOrHtml(true);
}

void set html(String val) #

inherited from CheckBox

Sets this object's contents via HTML. Use care when setting an object's HTML; it is an easy way to expose script-based security problems. Consider using {@link #setText(String)} whenever possible.

@param html the object's new HTML

void set html(String val) {
 directionalTextHelper.setTextOrHtml(val, true);
}

InputElement inputElem #

inherited from CheckBox
dart_html.InputElement inputElem

LabelElement labelElem #

inherited from CheckBox
dart_html.LabelElement labelElem

String get name #

inherited from CheckBox

Gets the widget's name.

@return the widget's name

String get name => inputElem.name;

void set name(String val) #

Change the group name of this radio button.

Radio buttons are grouped by their name attribute, so changing their name using the setName() method will also change their associated group.

If changing this group name results in a new radio group with multiple radio buttons selected, this radio button will remain selected and the other radio buttons will be unselected.

@param name name the group with which to associate the radio button

void set name(String val) {
 // Just changing the radio button name tends to break groupiness,
 // so we have to replace it. Note that replaceInputElement is careful
 // not to propagate name when it propagates everything else
 dart_html.InputElement radio = new dart_html.InputElement();
 radio.type = "radio";
 radio.name = name;
 replaceInputElement(radio);
}

int get tabIndex #

inherited from CheckBox

Gets the widget's position in the tab index.

@return the widget's tab index

int get tabIndex => inputElem.tabIndex;

void set tabIndex(int index) #

inherited from CheckBox

Sets the widget's position in the tab index. If more than one widget has the same tab index, each such widget will receive focus in an arbitrary order. Setting the tab index to <code>-1</code> will cause this widget to be removed from the tab order.

@param index the widget's tab index

void set tabIndex(int index) {
 // Need to guard against call to setTabIndex before inputElem is
 // initialized. This happens because FocusWidget's (a superclass of
 // CheckBox) setElement method calls setTabIndex before inputElem is
 // initialized. See CheckBox's protected constructor for more information.
 if (inputElem != null) {
   inputElem.tabIndex = index;
 }
}

String get text #

inherited from CheckBox

Sets the element's text.

String get text => directionalTextHelper.getTextOrHtml(false);

void set text(String val) #

inherited from CheckBox

Get the element's text.

void set text(String val) {
 directionalTextHelper.setTextOrHtml(val, false);
}

String get title #

inherited from UiObject

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

@return the object's title

String get title => getElement().title;

void set title(String value) #

inherited from UiObject

Sets the element's title.

void set title(String value) {
 getElement().title = value;
}

bool get visible #

inherited from UiObject

Determines whether or not this object is visible. Note that this does not necessarily take into account whether or not the receiver's parent is visible, or even if it is attached to the Document. The default implementation of this trait in UIObject is based on the value of a dom element's style object's display attribute.

@return <code>true</code> if the object is visible

bool get visible => isVisible(getElement());

void set visible(bool visible) #

inherited from UiObject

Sets whether this object is visible.

@param visible <code>true</code> to show the object, <code>false</code> to

     hide it
void set visible(bool visible) {
 setVisible(getElement(), visible);
}

bool get wordWrap #

inherited from CheckBox

Gets whether word-wrapping is enabled.

@return <code>true</code> if word-wrapping is enabled.

bool get wordWrap => WhiteSpace.NOWRAP.value != getElement().style.whiteSpace;

void set wordWrap(bool wrap) #

inherited from CheckBox

Sets whether word-wrapping is enabled.

@param wrap <code>true</code> to enable word-wrapping.

void set wordWrap(bool wrap) {
 getElement().style.whiteSpace = wrap ? WhiteSpace.NORMAL.value : WhiteSpace.NOWRAP.value;
}

Methods

HandlerRegistration addAttachHandler(AttachEventHandler handler) #

inherited from Widget

Adds an AttachEvent handler.

@param handler the handler @return the handler registration

HandlerRegistration addAttachHandler(AttachEventHandler handler) {
 return addHandler(handler, AttachEvent.TYPE);
}

HandlerRegistration addBitlessDomHandler(EventHandler handler, DomEventType type) #

inherited from Widget

For <a href= "http://code.google.com/p/google-web-toolkit/wiki/UnderstandingMemoryLeaks"

browsers which do not leak</a>, adds a native event handler to the widget.

Note that, unlike the {@link #addDomHandler(EventHandler, com.google.gwt.event.dom.client.DomEvent.Type)} implementation, there is no need to attach the widget to the DOM in order to cause the event handlers to be attached.

@param <H> the type of handler to add @param type the event key @param handler the handler @return {@link HandlerRegistration} used to remove the handler

HandlerRegistration addBitlessDomHandler(EventHandler handler, DomEventType type) {
 assert (handler != null);; // : "handler must not be null";
 assert (type != null); // : "type must not be null";
 sinkBitlessEvent(type.eventName);
 return ensureHandlers().addHandler(type, handler);
}

HandlerRegistration addBlurHandler(BlurHandler handler) #

inherited from FocusWidget

Adds a {@link BlurEvent} handler.

@param handler the blur handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasBlurHandlers
HandlerRegistration addBlurHandler(BlurHandler handler) {
 return addDomHandler(handler, BlurEvent.TYPE);
}

HandlerRegistration addClickHandler(ClickHandler handler) #

inherited from FocusWidget

Adds a {@link ClickEvent} handler.

@param handler the click handler @return {@link HandlerRegistration} used to remove this handler

HandlerRegistration addClickHandler(ClickHandler handler) {
 return addDomHandler(handler, ClickEvent.TYPE);
}

HandlerRegistration addDomHandler(EventHandler handler, DomEventType type) #

inherited from Widget

Adds a native event handler to the widget and sinks the corresponding native event. If you do not want to sink the native event, use the generic addHandler method instead.

@param <H> the type of handler to add @param type the event key @param handler the handler @return {@link HandlerRegistration} used to remove the handler

HandlerRegistration addDomHandler(EventHandler handler, DomEventType type) {
 assert (handler != null); // : "handler must not be null";
 assert (type != null); // : "type must not be null";
 int typeInt = IEvent.getTypeInt(type.eventName);
 if (typeInt == -1) {
   sinkBitlessEvent(type.eventName);
 } else {
   sinkEvents(typeInt);
 }
 return ensureHandlers().addHandler(type, handler);
}

HandlerRegistration addDoubleClickHandler(DoubleClickHandler handler) #

inherited from FocusWidget

Adds a {@link DoubleClickEvent} handler.

@param handler the double click handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasDoubleClickHandlers
HandlerRegistration addDoubleClickHandler(DoubleClickHandler handler) {
 return addDomHandler(handler, DoubleClickEvent.TYPE);
}

HandlerRegistration addDragEndHandler(DragEndHandler handler) #

inherited from FocusWidget

Adds a {@link DragEndEvent} handler.

@param handler the drag end handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasDragEndHandlers
HandlerRegistration addDragEndHandler(DragEndHandler handler) {
 return addBitlessDomHandler(handler, DragEndEvent.TYPE);
}

HandlerRegistration addDragEnterHandler(DragEnterHandler handler) #

inherited from FocusWidget

Adds a {@link DragEnterEvent} handler.

@param handler the drag end handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasDragEnterHandlers
HandlerRegistration addDragEnterHandler(DragEnterHandler handler) {
 return addBitlessDomHandler(handler, DragEnterEvent.TYPE);
}

HandlerRegistration addDragHandler(DragHandler handler) #

inherited from FocusWidget

Adds a {@link DragEvent} handler.

@param handler the drag handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasDragHandlers
HandlerRegistration addDragHandler(DragHandler handler) {
 return addBitlessDomHandler(handler, DragEvent.TYPE);
}

HandlerRegistration addDragLeaveHandler(DragLeaveHandler handler) #

inherited from FocusWidget

Adds a {@link DragLeaveEvent} handler.

@param handler the drag leave handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasDragLeaveHandlers
HandlerRegistration addDragLeaveHandler(DragLeaveHandler handler) {
 return addBitlessDomHandler(handler, DragLeaveEvent.TYPE);
}

HandlerRegistration addDragOverHandler(DragOverHandler handler) #

inherited from FocusWidget

Adds a {@link DragOverEvent} handler.

@param handler the drag over handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasDragOverHandlers
HandlerRegistration addDragOverHandler(DragOverHandler handler) {
 return addBitlessDomHandler(handler, DragOverEvent.TYPE);
}

HandlerRegistration addDragStartHandler(DragStartHandler handler) #

inherited from FocusWidget

Adds a {@link DragStartEvent} handler.

@param handler the drag start handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasDragStartHandlers
HandlerRegistration addDragStartHandler(DragStartHandler handler) {
 return addBitlessDomHandler(handler, DragStartEvent.TYPE);
}

HandlerRegistration addDropHandler(DropHandler handler) #

inherited from FocusWidget

Adds a {@link DropEvent} handler.

@param handler the drop handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasDropHandlers
HandlerRegistration addDropHandler(DropHandler handler) {
 return addBitlessDomHandler(handler, DropEvent.TYPE);
}

HandlerRegistration addFocusHandler(FocusHandler handler) #

inherited from FocusWidget

Adds a {@link FocusEvent} handler.

@param handler the focus handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasFocusHandlers
HandlerRegistration addFocusHandler(FocusHandler handler) {
 return addDomHandler(handler, FocusEvent.TYPE);
}

HandlerRegistration addGestureChangeHandler(GestureChangeHandler handler) #

inherited from FocusWidget
HandlerRegistration addGestureChangeHandler(GestureChangeHandler handler) {
 return addDomHandler(handler, GestureChangeEvent.TYPE);
}

HandlerRegistration addGestureEndHandler(GestureEndHandler handler) #

inherited from FocusWidget
HandlerRegistration addGestureEndHandler(GestureEndHandler handler) {
 return addDomHandler(handler, GestureEndEvent.TYPE);
}

HandlerRegistration addGestureStartHandler(GestureStartHandler handler) #

inherited from FocusWidget
HandlerRegistration addGestureStartHandler(GestureStartHandler handler) {
 return addDomHandler(handler, GestureStartEvent.TYPE);
}

HandlerRegistration addHandler(EventHandler handler, EventType<EventHandler> type) #

inherited from Widget

Adds this handler to the widget.

@param <H> the type of handler to add @param type the event type @param handler the handler @return {@link HandlerRegistration} used to remove the handler

HandlerRegistration addHandler(EventHandler handler, EventType<EventHandler> type) {
 return ensureHandlers().addHandler(type, handler);
}

HandlerRegistration addKeyDownHandler(KeyDownHandler handler) #

inherited from FocusWidget

Adds a {@link KeyDownEvent} handler.

@param handler the key down handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasKeyDownHandlers
HandlerRegistration addKeyDownHandler(KeyDownHandler handler) {
 return addDomHandler(handler, KeyDownEvent.TYPE);
}

HandlerRegistration addKeyPressHandler(KeyPressHandler handler) #

inherited from FocusWidget

Adds a {@link KeyPressEvent} handler.

@param handler the key press handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasKeyPressHandlers
HandlerRegistration addKeyPressHandler(KeyPressHandler handler) {
 return addDomHandler(handler, KeyPressEvent.TYPE);
}

HandlerRegistration addKeyUpHandler(KeyUpHandler handler) #

inherited from FocusWidget

Adds a {@link KeyUpEvent} handler.

@param handler the key up handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasKeyUpHandlers
HandlerRegistration addKeyUpHandler(KeyUpHandler handler) {
 return addDomHandler(handler, KeyUpEvent.TYPE);
}

HandlerRegistration addMouseDownHandler(MouseDownHandler handler) #

inherited from FocusWidget

Adds a {@link MouseDownEvent} handler.

@param handler the mouse down handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasMouseDownHandlers
HandlerRegistration addMouseDownHandler(MouseDownHandler handler) {
 return addDomHandler(handler, MouseDownEvent.TYPE);
}

HandlerRegistration addMouseMoveHandler(MouseMoveHandler handler) #

inherited from FocusWidget

Adds a {@link MouseMoveEvent} handler.

@param handler the mouse move handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasMouseMoveHandlers
HandlerRegistration addMouseMoveHandler(MouseMoveHandler handler) {
 return addDomHandler(handler, MouseMoveEvent.TYPE);
}

HandlerRegistration addMouseOutHandler(MouseOutHandler handler) #

inherited from FocusWidget

Adds a {@link MouseOutEvent} handler.

@param handler the mouse out handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasMouseOutHandlers
HandlerRegistration addMouseOutHandler(MouseOutHandler handler) {
 return addDomHandler(handler, MouseOutEvent.TYPE);
}

HandlerRegistration addMouseOverHandler(MouseOverHandler handler) #

inherited from FocusWidget

Adds a {@link MouseOverEvent} handler.

@param handler the mouse over handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasMouseOverHandlers
HandlerRegistration addMouseOverHandler(MouseOverHandler handler) {
 return addDomHandler(handler, MouseOverEvent.TYPE);
}

HandlerRegistration addMouseUpHandler(MouseUpHandler handler) #

inherited from FocusWidget

Adds a {@link MouseUpEvent} handler.

@param handler the mouse up handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasMouseUpHandlers
HandlerRegistration addMouseUpHandler(MouseUpHandler handler) {
 return addDomHandler(handler, MouseUpEvent.TYPE);
}

HandlerRegistration addMouseWheelHandler(MouseWheelHandler handler) #

inherited from FocusWidget

Adds a {@link MouseWheelEvent} handler.

@param handler the mouse wheel handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasMouseWheelHandlers
HandlerRegistration addMouseWheelHandler(MouseWheelHandler handler) {
 return addDomHandler(handler, MouseWheelEvent.TYPE);
}

void addStyleDependentName(String styleSuffix) #

inherited from 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

@param styleSuffix the suffix of the dependent style to be added. @see #setStylePrimaryName(String) @see #removeStyleDependentName(String) @see #setStyleDependentName(String, boolean) @see #addStyleName(String)

void addStyleDependentName(String styleSuffix) {
 setStyleDependentName(styleSuffix, true);
}

void addStyleName(String style) #

inherited from UiObject

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 <code>class</code> 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 {@link #addStyleDependentName(String)}, which will prefix the 'style' argument with the result of {@link #k()} (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);

} }</pre>

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; }</pre>

The code can also be simplified with {@link #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; }</pre>

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

@param style the secondary style name to be added @see UIObject @see #removeStyleName(String)

void addStyleName(String style) {
 setStyleName(style, true);
}

HandlerRegistration addTouchCancelHandler(TouchCancelHandler handler) #

inherited from FocusWidget

Adds a {@link TouchCancelEvent} handler.

@param handler the touch cancel handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasTouchCancelHandlers
HandlerRegistration addTouchCancelHandler(TouchCancelHandler handler) {
 return addDomHandler(handler, TouchCancelEvent.TYPE);
}

HandlerRegistration addTouchEndHandler(TouchEndHandler handler) #

inherited from FocusWidget

Adds a {@link TouchEndEvent} handler.

@param handler the touch end handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasTouchEndHandlers
HandlerRegistration addTouchEndHandler(TouchEndHandler handler) {
 return addDomHandler(handler, TouchEndEvent.TYPE);
}

HandlerRegistration addTouchMoveHandler(TouchMoveHandler handler) #

inherited from FocusWidget

Adds a {@link TouchMoveEvent} handler.

@param handler the touch move handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasTouchMoveHandlers
HandlerRegistration addTouchMoveHandler(TouchMoveHandler handler) {
 return addDomHandler(handler, TouchMoveEvent.TYPE);
}

HandlerRegistration addTouchStartHandler(TouchStartHandler handler) #

inherited from FocusWidget

Adds a {@link TouchStartEvent} handler.

@param handler the touch start handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasTouchStartHandlers
HandlerRegistration addTouchStartHandler(TouchStartHandler handler) {
 return addDomHandler(handler, TouchStartEvent.TYPE);
}

HandlerRegistration addValueChangeHandler(ValueChangeHandler<bool> handler) #

inherited from CheckBox

Adds a {@link ValueChangeEvent} handler.

@param handler the handler @return the registration for the event

docs inherited from HasValueChangeHandlers<T>
HandlerRegistration addValueChangeHandler(ValueChangeHandler<bool> handler) {
 // Is this the first value change handler? If so, time to add handlers
 if (!_valueChangeHandlerInitialized) {
   ensureDomEventHandlers();
   _valueChangeHandlerInitialized = true;
 }
 return addHandler(handler, ValueChangeEvent.TYPE);
}

LeafValueEditor<bool> asEditor() #

inherited from CheckBox
LeafValueEditor<bool> asEditor() {
 if (editor == null) {
   editor = new TakesValueEditor.of(this);
 }
 return editor;
}

Widget asWidget() #

inherited from Widget

Returns the Widget aspect of the receiver.

Widget asWidget() {
 return this;
}

void clearAndSetStyleName(String style) #

inherited from UiObject

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

@param style the new style name @see #setStylePrimaryName(String)

void clearAndSetStyleName(String style) {
 setElementStyleName(getStyleElement(), style);
}

EventBus createEventBus() #

inherited from Widget

Creates the SimpleEventBus used by this Widget. You can override this method to create a custom EventBus.

@return the EventBus you want to use.

EventBus createEventBus() {
 return new SimpleEventBus();
}

void delegateEvent(Widget target, DwtEvent event) #

inherited from Widget

Fires an event on a child widget. Used to delegate the handling of an event from one widget to another.

@param event the event @param target fire the event on the given target

void delegateEvent(Widget target, DwtEvent event) {
 target.fireEvent(event);
}

void doAttachChildren() #

inherited from Widget

If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call {@link #onAttach()} for each of its child widgets.

@see #onAttach()

void doAttachChildren() {
}

void doDetachChildren() #

inherited from Widget

If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call {@link #onDetach()} for each of its child widgets.

@see #onDetach()

void doDetachChildren() {
}

void enableDirectionEstimator(bool enabled) #

inherited from CheckBox

{@inheritDoc} <p> See note at {@link #setDirectionEstimator(DirectionEstimator)}.

void enableDirectionEstimator(bool enabled) {
 directionalTextHelper.enableDefaultDirectionEstimator(enabled);
}

void ensureDomEventHandlers() #

No-op. CheckBox's click handler is no good for radio button, so don't use it. Our event handling is all done in {@link #onBrowserEvent}

void ensureDomEventHandlers() {}

EventBus ensureHandlers() #

inherited from Widget

Ensures the existence of the event bus.

@return the EventBus.

EventBus ensureHandlers() {
 return _eventBus == null ? _eventBus = createEventBus() : _eventBus;
}

double extractLengthValue(String s) #

inherited from UiObject

Intended to be used to pull the value out of a CSS length. If the value is "auto" or "inherit", 0 will be returned.

@param s The CSS length string to extract @return The leading numeric portion of <code>s</code>, or 0 if "auto" or

    "inherit" are passed in.
double extractLengthValue(String s) {
 if (s == "auto" || s == "inherit" || s == "") {
   return 0.0;
 } else {
   // numberRegex divides the string into a leading numeric portion
   // followed by an arbitrary portion.
   if(numberRegex.hasMatch(s)) {
     // Extract the leading numeric portion of string
     s = numberRegex.firstMatch(s)[0];
   }
   return double.parse(s);
 }
}

void fireEvent(DwtEvent event) #

inherited from Widget

Fires the given event to the handlers listening to the event's type.

Any exceptions thrown by handlers will be bundled into a UmbrellaException and then re-thrown after all handlers have completed. An exception thrown by a handler will not prevent other handlers from executing.

@param event the event

void fireEvent(DwtEvent event) {
//    if (_eventBus != null) {
//      _eventBus.fireEvent(event);
//    }
 if (_eventBus != null) {
   // If it not live we should revive it.
   if (!event.isLive()) {
     event.revive();
   }
   Object oldSource = event.getSource();
   event.overrideSource(getElement());
   try {

     // May throw an UmbrellaException.
     _eventBus.fireEventFromSource(event, getElement());
   } on UmbrellaException catch (e) {
     throw new UmbrellaException(e.causes);
   } finally {
     if (oldSource == null) {
       // This was my event, so I should kill it now that I'm done.
       event.kill();
     } else {
       // Restoring the source for the next handler to use.
       event.overrideSource(oldSource);
     }
   }
 }
}

int getAbsoluteLeft() #

inherited from UiObject

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

@return the object's absolute left position

int getAbsoluteLeft() {
 return Dom.getAbsoluteLeft(getElement());
}

int getAbsoluteTop() #

inherited from UiObject

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

@return the object's absolute top position

int getAbsoluteTop() {
 return Dom.getAbsoluteTop(getElement());
}

DirectionEstimator getDirectionEstimator() #

inherited from CheckBox
DirectionEstimator getDirectionEstimator() {
 return directionalTextHelper.getDirectionEstimator();
}

Element getElement() #

inherited from UiObject

Gets this object's browser element.

dart_html.Element getElement() {
 assert (_element != null); // : MISSING_ELEMENT_ERROR;
 return _element;
}

EventBus getEventBus() #

inherited from Widget

Return EventBus.

EventBus getEventBus() {
 return _eventBus;
}

Object getLayoutData() #

inherited from Widget

Gets the panel-defined layout data associated with this widget.

@return the widget's layout data @see #setLayoutData

Object getLayoutData() {
 return _layoutData;
}

int getOffsetHeight() #

inherited from UiObject

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

@return the object's offset height

int getOffsetHeight() {
 return getElement().offset.height; // Dom.getElementPropertyInt(getElement(), "offsetHeight");
}

int getOffsetWidth() #

inherited from UiObject

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

@return the object's offset width

int getOffsetWidth() {
 return getElement().offset.width; // Dom.getElementPropertyInt(getElement(), "offsetWidth");
}

Widget getParent() #

inherited from Widget

Gets this widget's parent panel.

@return the widget's parent panel

Widget getParent() {
 return _parent;
}

Element getStyleElement() #

inherited from 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.

@return the element to which style names will be applied

dart_html.Element getStyleElement() {
 return getElement();
}

String getStyleName() #

inherited from UiObject

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

@return the objects's space-separated style names @see #getStylePrimaryName()

String getStyleName() {
 return getElementStyleName(getStyleElement());
}

String getStylePrimaryName() #

inherited from UiObject

Gets the primary style name associated with the object.

@return the object's primary style name @see #setStyleName(String) @see #addStyleName(String) @see #removeStyleName(String)

String getStylePrimaryName() {
 return getElementStylePrimaryName(getStyleElement());
}

Direction getTextDirection() #

inherited from CheckBox

Gets the direction of this object's text.

@return the direction of this object's text

docs inherited from HasDirectionalText
Direction getTextDirection() {
 return directionalTextHelper.getTextDirection();
}

bool getValue() #

inherited from CheckBox

Determines whether this check box is currently checked. <p> Note that this <em>does not</em> return the value property of the checkbox input element wrapped by this widget. For access to that property, see {@link #getFormValue()}

@return <code>true</code> if the check box is checked, false otherwise.

    Will not return null
bool getValue() {
 if (isAttached()) {
   return inputElem.checked;
 } else {
   return inputElem.defaultChecked;
 }
}

bool isAttached() #

inherited from Widget

Returns whether or not the receiver is attached to the {@link com.google.gwt.dom.client.Document Document}'s {@link com.google.gwt.dom.client.BodyElement BodyElement}.

@return true if attached, false otherwise

bool isAttached() {
 return _attached;
}

bool isOrWasAttached() #

inherited from Widget

Has this widget ever been attached?

@return true if this widget ever been attached to the DOM, false otherwise

bool isOrWasAttached() {
 return eventsToSink == -1;
}

void onAttach() #

inherited from FocusWidget

This method is called when a widget is attached to the browser's document. To receive notification after a Widget has been added to the document, override the {@link #onLoad} method or use {@link #addAttachHandler}.

It is strongly recommended that you override {@link #onLoad()} or {@link #doAttachChildren()} instead of this method to avoid inconsistencies between logical and physical attachment states.

Subclasses that override this method must call super.onAttach() to ensure that the Widget has been attached to its underlying Element.

@throws IllegalStateException if this widget is already attached @see #onLoad() @see #doAttachChildren()

void onAttach() {
 super.onAttach();

 // Accessibility: setting tab index to be 0 by default, ensuring element
 // appears in tab sequence. We must ensure that the element doesn't already
 // have a tabIndex set. This is not a problem for normal widgets, but when
 // a widget is used to wrap an existing static element, it can already have
 // a tabIndex.
 if (-1 == tabIndex) {
   tabIndex = 0;
 }
}

void onBrowserEvent(Event event) #

Overridden to send ValueChangeEvents only when appropriate.

void onBrowserEvent(dart_html.Event event) {
 
 if (event.type == BrowserEvents.MOUSEUP ||
     event.type == BrowserEvents.BLUR ||
     event.type == BrowserEvents.KEYDOWN) {
   // Note the old value for onValueChange purposes (in ONCLICK case)
   _oldValue = getValue();
 } else if (event.type == BrowserEvents.CLICK) {
   dart_html.EventTarget target = (event as dart_html.MouseEvent).target;
   if (target is  dart_html.Element && Dom.isOrHasChild(labelElem, target as dart_html.Element)) {

     // They clicked the label. Note our pre-click value, and
     // short circuit event routing so that other click handlers
     // don't hear about it
     _oldValue = getValue();
     return;
   }

   // It's not the label. Let our handlers hear about the
   // click...
   super.onBrowserEvent(event);
   // ...and now maybe tell them about the change
   ValueChangeEvent.fireIfNotEqual(this, _oldValue, getValue());
   return;
 }

 super.onBrowserEvent(event);
}

void onDetach() #

inherited from Widget

This method is called when a widget is detached from the browser's document. To receive notification before a Widget is removed from the document, override the {@link #onUnload} method or use {@link #addAttachHandler}.

It is strongly recommended that you override {@link #onUnload()} or {@link #doDetachChildren()} instead of this method to avoid inconsistencies between logical and physical attachment states.

Subclasses that override this method must call super.onDetach() to ensure that the Widget has been detached from the underlying Element. Failure to do so will result in application memory leaks due to circular references between DOM Elements and JavaScript objects.

@throws IllegalStateException if this widget is already detached @see #onUnload() @see #doDetachChildren()

void onDetach() {
 if (!isAttached()) {
   throw new Exception("Should only call onDetach when the widget is attached to the browser's document");
 }

 try {
   // onUnload() gets called *before* everything else (the opposite of
   // onLoad()).
   onUnload();
   AttachEvent.fire(this, false);
 } finally {
   // Put this in a finally, just in case onUnload throws an exception.
   try {
     doDetachChildren();
   } finally {
     // Put this in a finally, in case doDetachChildren throws an exception.
     Dom.setEventListener(getElement(), null);
     _attached = false;
   }
 }
}

void onLoad() #

inherited from CheckBox

This method is called when a widget is attached to the browser's document. onAttach needs special handling for the CheckBox case. Must still call {@link Widget#onAttach()} to preserve the <code>onAttach</code> contract.

void onLoad() {
 setEventListener(inputElem, this);
}

void onUnload() #

inherited from CheckBox

This method is called when a widget is detached from the browser's document. Overridden because of IE bug that throws away checked state and in order to clear the event listener off of the <code>inputElem</code>.

void onUnload() {
 // Clear out the inputElem's event listener (breaking the circular
 // reference between it and the widget).
 setEventListener(inputElem, null);
 setValue(getValue(), false);
}

void removeFromParent() #

inherited from Widget

Removes this widget from its parent widget, if one exists.

If it has no parent, this method does nothing. If it is a "root" widget (meaning it's been added to the detach list via {@link RootPanel#detachOnWindowClose(Widget)}), it will be removed from the detached immediately. This makes it possible for Composites and Panels to adopt root widgets.

@throws IllegalStateException if this widget's parent does not support

      removal (e.g. {@link Composite})
void removeFromParent() {
 if (_parent == null) {
   // If the widget had no parent, check to see if it was in the detach list
   // and remove it if necessary.
   if (RootPanel.isInDetachList(this)) {
     RootPanel.detachNow(this);
   }
 } else if (_parent is HasWidgets) {
   (_parent as HasWidgets).remove(this);
 } else if (_parent != null) {
   throw new Exception("This widget's parent does not implement HasWidgets");
 }
}

void removeStyleDependentName(String styleSuffix) #

inherited from UiObject

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

@param styleSuffix the suffix of the dependent style to be removed @see #setStylePrimaryName(Element, String) @see #addStyleDependentName(String) @see #setStyleDependentName(String, boolean)

void removeStyleDependentName(String styleSuffix) {
 setStyleDependentName(styleSuffix, false);
}

void removeStyleName(String style) #

inherited from UiObject

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.

@param style the secondary style name to be removed @see #addStyleName(String) @see #setStyleName(String, boolean)

void removeStyleName(String style) {
 setStyleName(style, false);
}

void replaceElement(Element elem) #

inherited from Widget

Replaces this object's browser element.

This method exists only to support a specific use-case in Image, and should not be used by other classes.

@param elem the object's new element

void replaceElement(dart_html.Element elem) {
 if (isAttached()) {
   // Remove old event listener to avoid leaking. onDetach will not do this
   // for us, because it is only called when the widget itself is detached
   // from the document.
   Dom.setEventListener(getElement(), null);
 }

 super.replaceElement(elem);

 if (isAttached()) {
   // Hook the event listener back up on the new element. onAttach will not
   // do this for us, because it is only called when the widget itself is
   // attached to the document.
   Dom.setEventListener(getElement(), this);
 }
}

void replaceInputElement(InputElement newInputElem) #

inherited from CheckBox

Replace the current input element with a new one. Preserves all state except for the name property, for nasty reasons related to radio button grouping. (See implementation of {@link RadioButton#setName}.)

@param elem the new input element

void replaceInputElement(dart_html.InputElement newInputElem) {
 // Collect information we need to set
 int _tabIndex = tabIndex;
 bool _checked = getValue();
 bool _enabled = enabled;
 String _formValue = formValue;
 String _uid = inputElem.id;
 //String accessKey = inputElem.getAccessKey();
 int sunkEvents = IEvent.getEventsSunk(inputElem);

 // Clear out the old input element
 setEventListener(inputElem, null);

 //getElement().replaceChild(newInputElem, inputElem);
 inputElem.replaceWith(newInputElem);

 // Sink events on the new element
 IEvent.sinkEvents(newInputElem, IEvent.getEventsSunk(inputElem));
 IEvent.sinkEvents(inputElem, 0);
 inputElem = newInputElem;

 // Setup the new element
 IEvent.sinkEvents(inputElem, sunkEvents);
 inputElem.id = _uid;
//    if (!"".equals(accessKey)) {
//      inputElem.setAccessKey(accessKey);
//    }
 tabIndex = _tabIndex;
 setValue(_checked);
 enabled = _enabled;
 formValue = _formValue;

 // Set the event listener
 if (isAttached()) {
   setEventListener(inputElem, this);
 }
}

void setDirectionEstimator(DirectionEstimator directionEstimator) #

inherited from CheckBox

{@inheritDoc} <p> Note: DirectionEstimator should be set before the label has any content; it's highly recommended to set it using a constructor. Reason: if the label already has non-empty content, this will update its direction according to the new estimator's result. This may cause flicker, and thus should be avoided.

void setDirectionEstimator(DirectionEstimator directionEstimator) {
 directionalTextHelper.setDirectionEstimator(directionEstimator);
}

void setElement(Element elem) #

inherited from UiObject

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.

@param elem the object's element

void setElement(dart_html.Element elem) {
 assert (_element == null);
 this._element = elem;
}

void setEventListener(Element e, EventListener listener) #

inherited from CheckBox
void setEventListener(dart_html.Element e, EventListener listener) {
 Dom.setEventListener(e, listener);
}

void setHeight(String height) #

inherited from UiObject

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

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

void setHeight(String height) {
 // This exists to deal with an inconsistency in IE's implementation where
 // it won't accept negative numbers in length measurements
 assert (extractLengthValue(height.trim().toLowerCase()) >= 0); // : "CSS heights should not be negative";
 Dom.setStyleAttribute(getElement(), "height", height);
}

void setHtml(SafeHtml html, Direction dir) #

inherited from CheckBox
void setHtml(SafeHtml html, Direction dir) {
 directionalTextHelper.setTextOrHtml(html.asString(), true, dir);
}

void setLayoutData(Object value) #

inherited from Widget

Sets the panel-defined layout data associated with this widget. Only the panel that currently contains a widget should ever set this value. It serves as a place to store layout bookkeeping data associated with a widget.

@param layoutData the widget's layout data

void setLayoutData(Object value) {
 this._layoutData = value;
}

void setParent(Widget parent) #

inherited from Widget

Sets this widget's parent. This method should only be called by {@link Panel} and {@link Composite}.

@param parent the widget's new parent @throws IllegalStateException if <code>parent</code> is non-null and the

      widget already has a parent
void setParent(Widget parent) {
 Widget oldParent = this._parent;
 if (parent == null) {
   try {
     if (oldParent != null && oldParent.isAttached()) {
       onDetach();
       assert (!isAttached()); // : "Failure of " + this.getClass().getName() + " to call super.onDetach()";
     }
   } finally {
     // Put this in a finally in case onDetach throws an exception.
     this._parent = null;
   }
 } else {
   if (oldParent != null) {
     throw new Exception("Cannot set a new parent without first clearing the old parent");
   }
   this._parent = parent;
   if (parent.isAttached()) {
     onAttach();
     assert (isAttached()); // : "Failure of " + this.getClass().getName() + " to call super.onAttach()";
   }
 }
}

void setPixelSize(int width, int height) #

inherited from UiObject

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

@param width the object's new width, in pixels @param height the object's new height, in pixels

void setPixelSize(int width, int height) {
 if (width >= 0) {
   setWidth(width.toString() + "px");
 }
 if (height >= 0) {
   setHeight(height.toString() + "px");
 }
}

void setSize(String width, String height) #

inherited from UiObject

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

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

void setSize(String width, String height) {
 setWidth(width);
 setHeight(height);
}

void setStyleDependentName(String styleSuffix, bool add) #

inherited from UiObject

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

@param styleSuffix the suffix of the dependent style to be added or removed @param add <code>true</code> to add the given style, <code>false</code> to

     remove it

@see #setStylePrimaryName(Element, String) @see #addStyleDependentName(String) @see #setStyleName(String, boolean) @see #removeStyleDependentName(String)

void setStyleDependentName(String styleSuffix, bool add) {
 setStyleName(getStylePrimaryName() + '-' + styleSuffix, add);
}

void setStyleName(String style, bool add) #

inherited from UiObject

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.

@param style the style name to be added or removed @param add <code>true</code> to add the given style, <code>false</code> to

     remove it

@see #addStyleName(String) @see #removeStyleName(String)

void setStyleName(String style, bool add) {
 manageElementStyleName(getStyleElement(), style, add);
}

void setStylePrimaryName(String style) #

inherited from UiObject

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

@param style the new primary style name @see #addStyleName(String) @see #removeStyleName(String)

void setStylePrimaryName(String style) {
 setElementStylePrimaryName(getStyleElement(), style);
}

void setText(String text, Direction dir) #

inherited from CheckBox

Sets this object's text, also declaring its direction.

@param text the object's new text @param dir the text's direction

docs inherited from HasDirectionalText
void setText(String text, Direction dir) {
 directionalTextHelper.setTextOrHtml(text, false, dir);
}

void setValue(bool val, [bool fireEvents = false]) #

inherited from CheckBox

Checks or unchecks the check box, firing {@link ValueChangeEvent} if appropriate. <p> Note that this <em>does not</em> set the value property of the checkbox input element wrapped by this widget. For access to that property, see {@link #setFormValue(String)}

@param value true to check, false to uncheck; null value implies false @param fireEvents If true, and value has changed, fire a

     {@link ValueChangeEvent}
void setValue(bool val, [bool fireEvents = false]) {
 if (val == null) {
   val = false;
 }

 bool oldValue = getValue();
 inputElem.checked = val;
 inputElem.defaultChecked = val;
 if (val != oldValue && fireEvents) {
   ValueChangeEvent.fire(this, val);
 }
}

void setWidth(String width) #

inherited from UiObject

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

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

void setWidth(String width) {
 // This exists to deal with an inconsistency in IE's implementation where
 // it won't accept negative numbers in length measurements
 assert (extractLengthValue(width.trim().toLowerCase()) >= 0); // : "CSS widths should not be negative";
 Dom.setStyleAttribute(getElement(), "width", width);
}

void sinkBitlessEvent(String eventTypeName) #

inherited from UiObject

Sinks a named event. Note that only {@link Widget widgets} may actually receive events, but can receive events from all objects contained within them.

@param eventTypeName name of the event to sink on this element @see com.google.gwt.user.client.Event

void sinkBitlessEvent(String eventTypeName) {
 Dom.sinkBitlessEvent(getElement(), eventTypeName);
}

void sinkEvents(int eventBitsToAdd) #

Overridden to defer the call to super.sinkEvents until the first time this widget is attached to the dom, as a performance enhancement. Subclasses wishing to customize sinkEvents can preserve this deferred sink behavior by putting their implementation behind a check of <code>isOrWasAttached()</code>:

{@literal @}Override
public void sinkEvents(int eventBitsToAdd) {
  if (isOrWasAttached()) {
    /{@literal *} customized sink code goes here {@literal *}/
  } else {
    super.sinkEvents(eventBitsToAdd);
 }
} 
docs inherited from Widget
void sinkEvents(int eventBitsToAdd) {
 // Like CheckBox, we want to hear about inputElem. We
 // also want to know what's going on with the label, to
 // make sure onBrowserEvent is able to record value changes
 // initiated by label events
 if (isOrWasAttached()) {
   IEvent.sinkEvents(inputElem, eventBitsToAdd | IEvent.getEventsSunk(inputElem));
   IEvent.sinkEvents(labelElem, eventBitsToAdd | IEvent.getEventsSunk(labelElem));
 } else {
   super.sinkEvents(eventBitsToAdd);
 }
}

String toString() #

inherited from UiObject

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

@return a string representation of the object

String toString() {
 if (_element == null) {
   return "(null handle)";
 }
 return getElement().toString();
}

void unsinkEvents(int eventBitsToRemove) #

inherited from UiObject

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

@param eventBitsToRemove a bitfield representing the set of events to be

     removed from this element's event set

@see #sinkEvents @see com.google.gwt.user.client.Event

void unsinkEvents(int eventBitsToRemove) {
 Dom.sinkEvents(getElement(), Dom.getEventsSunk(getElement()) & (~eventBitsToRemove));
}