API Reference 0.3.24dart_web_toolkit_uiListBox

ListBox class

A widget that presents a list of choices to the user, either as a list box or as a drop-down list.

CSS Style Rules

  • .gwt-ListBox { }

Example

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

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}, and is off by default.

Use in UiBinder Templates

The items of a ListBox element are laid out in <g:item> elements. Each item contains text that will be added to the list of available items that will be shown, either in the drop down or list. (Note that the tags of the item elements are not capitalized. This is meant to signal that the item is not a runtime object, and so cannot have a ui:field attribute.) It is also possible to explicitly specify item's value using value attribute as shown below.

For example:

<g:ListBox>
 <g:item>
   first
 </g:item>
 <g:item value='2'>
   second
 </g:item>
</g:ListBox>

Important usage note

Subclasses should neither read nor write option text directly from the option elements created by this class, since such text may need to be wrapped in Unicode bidi formatting characters. They can use the getOptionText and/or setOptionText methods for this purpose instead.
class ListBox extends FocusWidget implements HasChangeHandlers, HasName,
 HasDirectionEstimator {

 static final int INSERT_AT_END = -1;

 static final String BIDI_ATTR_NAME = "bidiwrapped";

 /**
  * Creates a ListBox widget that wraps an existing &lt;select&gt; element.
  *
  * This element must already be attached to the document. If the element is
  * removed from the document, you must call
  * {@link RootPanel#detachNow(Widget)}.
  *
  * @param element the element to be wrapped
  * @return list box
  */
 factory ListBox.wrap(dart_html.Element element) {
   // Assert that the element is attached.
   //assert Document.get().getBody().isOrHasChild(element);

   ListBox listBox = new ListBox(false, element);

   // Mark it attached and remember it for cleanup.
   listBox.onAttach();
   RootPanel.detachOnWindowClose(listBox);

   return listBox;
 }
 
 /**
  * Creates an empty list box in single selection mode.
  */
 ListBox([bool isMultipleSelect = false, dart_html.Element element = null]) : super(element == null ? new dart_html.SelectElement() : element) {
   setMultipleSelect(isMultipleSelect);
 }

 //************************************
 // Implementation of HasChangeHandlers
 //************************************

 /**
  * Adds a {@link ChangeEvent} handler.
  *
  * @param handler the change handler
  * @return {@link HandlerRegistration} used to remove this handler
  */
 HandlerRegistration addChangeHandler(ChangeHandler handler) {
   return addDomHandler(handler, ChangeEvent.TYPE);
 }

 //**************************
 // Implementation of HasName
 //**************************

 /**
  * Sets the widget's name.
  *
  * @param name the widget's new name
  */
 void set name(String value) {
   _getSelectElement().name = value;
 }

 /**
  * Gets the widget's name.
  *
  * @return the widget's name
  */
 String get name => _getSelectElement().name;

 //******
 // Items
 //******

 /**
  * Adds an item to the list box. This method has the same effect as
  *
  * <pre>
  * addItem(item, item)
  * </pre>
  *
  * @param item the text of the item to be added
  */
 void addItem(String item, [String value = null]) {
   if (value != null) {
     insertItem(item, null, value, INSERT_AT_END);
   } else {
     insertItem(item, null, item, INSERT_AT_END);
   }
 }

 /**
  * Removes all items from the list box.
  */
 void clear() {
   _getSelectElement().children.clear();
 }

 /**
  * Gets the number of items present in the list box.
  *
  * @return the number of items
  */
 int getItemCount() {
   return _getSelectElement().options.length;
 }

 /**
  * Gets the text associated with the item at the specified index.
  *
  * @param index the index of the item whose text is to be retrieved
  * @return the text associated with the item
  * @throws IndexOutOfBoundsException if the index is out of range
  */
 String getItemText(int index) {
   _checkIndex(index);
   return getOptionText(_getSelectElement().options[index]);
 }

 /**
  * Gets the currently-selected item. If multiple items are selected, this
  * method will return the first selected item ({@link #isItemSelected(int)}
  * can be used to query individual items).
  *
  * @return the selected index, or <code>-1</code> if none is selected
  */
 int getSelectedIndex() {
   return _getSelectElement().selectedIndex;
 }

 /**
  * Gets the value associated with the item at a given index.
  *
  * @param index the index of the item to be retrieved
  * @return the item's associated value
  * @throws IndexOutOfBoundsException if the index is out of range
  */
 String getValue(int index) {
   _checkIndex(index);
   return _getSelectElement().options[index].value;
 }

 /**
  * Gets the number of items that are visible. If only one item is visible,
  * then the box will be displayed as a drop-down list.
  *
  * @return the visible item count
  */
 int getVisibleItemCount() {
   return _getSelectElement().size;
 }

 /**
  * Sets the number of items that are visible. If only one item is visible,
  * then the box will be displayed as a drop-down list.
  *
  * @param visibleItems the visible item count
  */
 void setVisibleItemCount(int visibleItems) {
   _getSelectElement().size = visibleItems;
 }

 /**
  * Inserts an item into the list box, specifying its direction and an initial
  * value for the item. If the index is less than zero, or greater than or
  * equal to the length of the list, then the item will be appended to the end
  * of the list.
  *
  * @param item the text of the item to be inserted
  * @param dir the item's direction. If {@code null}, the item is displayed in
  *          the widget's overall direction, or, if a direction estimator has
  *          been set, in the item's estimated direction.
  * @param value the item's value, to be submitted if it is part of a
  *          {@link FormPanel}.
  * @param index the index at which to insert it
  */
 void insertItem(String item, TextDirection dir, String value, int index) {
   dart_html.SelectElement select = _getSelectElement();
   dart_html.OptionElement option = new dart_html.OptionElement();
   setOptionText(option, item, dir);
   option.value = value;

   int itemCount = select.length;
   if (index < 0 || index > itemCount) {
     index = itemCount;
   }
   if (index == itemCount) {
     select.children.add(option);
   } else {
     //dart_html.OptionElement before = select.options[index];
//      select.children.insertRange(index, 1);
//      select.children[index] = option;
     select.children.insert(index, option);
   }
 }

 /**
  * Determines whether an individual list item is selected.
  *
  * @param index the index of the item to be tested
  * @return <code>true</code> if the item is selected
  * @throws IndexOutOfBoundsException if the index is out of range
  */
 bool isItemSelected(int index) {
   _checkIndex(index);
   return _getSelectElement().options[index].selected;
 }

 /**
  * Removes the item at the specified index.
  *
  * @param index the index of the item to be removed
  * @throws IndexOutOfBoundsException if the index is out of range
  */
 void removeItem(int index) {
   _checkIndex(index);
   _getSelectElement().options[index].remove();
 }

 /**
  * Sets whether an individual list item is selected.
  *
  * <p>
  * Note that setting the selection programmatically does <em>not</em> cause
  * the {@link ChangeHandler#onChange(ChangeEvent)} event to be fired.
  * </p>
  *
  * @param index the index of the item to be selected or unselected
  * @param selected <code>true</code> to select the item
  * @throws IndexOutOfBoundsException if the index is out of range
  */
 void setItemSelected(int index, bool selected) {
   _checkIndex(index);
   _getSelectElement().options[index].selected = selected;
 }

 /**
  * Sets the text associated with the item at a given index.
  *
  * @param index the index of the item to be set
  * @param text the item's new text
  * @param dir the item's direction.
  * @throws IndexOutOfBoundsException if the index is out of range
  */
 void setItemText(int index, String text, TextDirection dir) {
   _checkIndex(index);
   if (text == null) {
     throw new Exception("NullPointer. Cannot set an option to have null text");
   }
   setOptionText(_getSelectElement().options[index], text, dir);
 }

 /**
  * Sets the currently selected index.
  *
  * After calling this method, only the specified item in the list will remain
  * selected. For a ListBox with multiple selection enabled, see
  * {@link #setItemSelected(int, boolean)} to select multiple items at a time.
  *
  * <p>
  * Note that setting the selected index programmatically does <em>not</em>
  * cause the {@link ChangeHandler#onChange(ChangeEvent)} event to be fired.
  * </p>
  *
  * @param index the index of the item to be selected
  */
 void setSelectedIndex(int index) {
   _getSelectElement().selectedIndex = index;
 }

 /**
  * Sets the value associated with the item at a given index. This value can be
  * used for any purpose, but is also what is passed to the server when the
  * list box is submitted as part of a {@link FormPanel}.
  *
  * @param index the index of the item to be set
  * @param value the item's new value; cannot be <code>null</code>
  * @throws IndexOutOfBoundsException if the index is out of range
  */
 void setValue(int index, String value) {
   _checkIndex(index);
   _getSelectElement().options[index].value = value;
 }

 /**
  * Retrieves the text of an option element. If the text was set by
  * {@link #setOptionText} and was wrapped with Unicode bidi formatting
  * characters, also removes those additional formatting characters.
  *
  * @param option an option element
  * @return the element's text
  */
 String getOptionText(dart_html.OptionElement option) {
   String text = option.text;
   if (option.attributes[BIDI_ATTR_NAME] != null && text.length > 1) {
     text = text.substring(1, text.length - 1);
   }
   return text;
 }

 /**
  * Sets the text of an option element. If the direction of the text is
  * opposite to the page's direction, also wraps it with Unicode bidi
  * formatting characters to prevent garbling, and indicates that this was done
  * by setting the option's <code>BIDI_ATTR_NAME</code> custom attribute.
  *
  * @param option an option element
  * @param text text to be set to the element
  * @param dir the text's direction. If {@code null} and direction estimation
  *          is turned off, direction is ignored.
  */
 void setOptionText(dart_html.OptionElement option, String text, [TextDirection dir = null]) {
//    if (dir == null && estimator != null) {
//      dir = estimator.estimateDirection(text);
//    }
   if (dir == null) {
     option.text = text;
     option.attributes.remove(BIDI_ATTR_NAME);
//    } else {
//      String formattedText = BidiFormatter.getInstanceForCurrentLocale().unicodeWrapWithKnownDir(dir, text, false /* isHtml */, false /* dirReset */);
//      option.setText(formattedText);
//      if (formattedText.length > text.length) {
//        option.attribute[BIDI_ATTR_NAME] = "";
//      } else {
//        option.attribute[BIDI_ATTR_NAME].remove();
//      }
   }
 }

 /**
  * Gets whether this list allows multiple selection.
  *
  * @return <code>true</code> if multiple selection is allowed
  */
 bool isMultipleSelect() {
   return _getSelectElement().multiple;
 }

 void setMultipleSelect(bool multiple) {
   _getSelectElement().multiple = multiple;
 }

 void _checkIndex(int index) {
   if (index < 0 || index >= getItemCount()) {
     throw new Exception("IndexOutOfBoundsException");
   }
 }

 dart_html.SelectElement _getSelectElement() {
   return getElement() as dart_html.SelectElement;
 }
}

Extends

UiObject > Widget > FocusWidget > ListBox

Implements

HasDirectionEstimator, HasName, HasChangeHandlers

Static Properties

final String BIDI_ATTR_NAME #

static final String BIDI_ATTR_NAME = "bidiwrapped"

final int INSERT_AT_END #

static final int INSERT_AT_END = -1

Constructors

new ListBox([bool isMultipleSelect = false, Element element = null]) #

Creates an empty list box in single selection mode.

ListBox([bool isMultipleSelect = false, dart_html.Element element = null]) : super(element == null ? new dart_html.SelectElement() : element) {
 setMultipleSelect(isMultipleSelect);
}

factory ListBox.wrap(Element element) #

Creates a ListBox widget that wraps an existing <select> element.

This element must already be attached to the document. If the element is removed from the document, you must call {@link RootPanel#detachNow(Widget)}.

@param element the element to be wrapped @return list box

factory ListBox.wrap(dart_html.Element element) {
 // Assert that the element is attached.
 //assert Document.get().getBody().isOrHasChild(element);

 ListBox listBox = new ListBox(false, element);

 // Mark it attached and remember it for cleanup.
 listBox.onAttach();
 RootPanel.detachOnWindowClose(listBox);

 return listBox;
}

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);
}

bool get enabled #

inherited from FocusWidget

Gets whether this widget is enabled.

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

bool get enabled => !Dom.getElementPropertyBoolean(getElement(), "disabled");

void set enabled(bool value) #

inherited from FocusWidget

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 value) {
 if (value && !enabled) {
   Dom.removeElementAttribute(getElement(), "disabled");
 } else if (!value && enabled) {
   Dom.setElementPropertyBoolean(getElement(), "disabled", true);
 }
}

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 FocusWidget

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) {
   impl.focus(getElement());
 } else {
   impl.blur(getElement());
 }
}

String get name #

Gets the widget's name.

@return the widget's name

String get name => _getSelectElement().name;

void set name(String value) #

Sets the widget's name.

@param name the widget's new name

void set name(String value) {
 _getSelectElement().name = value;
}

int get tabIndex #

inherited from FocusWidget

Gets the widget's position in the tab index.

@return the widget's tab index

int get tabIndex => impl.getTabIndex(getElement());

void set tabIndex(int index) #

inherited from FocusWidget

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) {
 impl.setTabIndex(getElement(), index);
}

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);
}

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 addChangeHandler(ChangeHandler handler) #

Adds a {@link ChangeEvent} handler.

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

HandlerRegistration addChangeHandler(ChangeHandler handler) {
 return addDomHandler(handler, ChangeEvent.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);
}

void addItem(String item, [String value = null]) #

Adds an item to the list box. This method has the same effect as

addItem(item, item)

@param item the text of the item to be added

void addItem(String item, [String value = null]) {
 if (value != null) {
   insertItem(item, null, value, INSERT_AT_END);
 } else {
   insertItem(item, null, item, INSERT_AT_END);
 }
}

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);
}

Widget asWidget() #

inherited from Widget

Returns the Widget aspect of the receiver.

Widget asWidget() {
 return this;
}

void clear() #

Removes all items from the list box.

void clear() {
 _getSelectElement().children.clear();
}

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() {
}

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());
}

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

int getItemCount() #

Gets the number of items present in the list box.

@return the number of items

int getItemCount() {
 return _getSelectElement().options.length;
}

String getItemText(int index) #

Gets the text associated with the item at the specified index.

@param index the index of the item whose text is to be retrieved @return the text associated with the item @throws IndexOutOfBoundsException if the index is out of range

String getItemText(int index) {
 _checkIndex(index);
 return getOptionText(_getSelectElement().options[index]);
}

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");
}

String getOptionText(OptionElement option) #

Retrieves the text of an option element. If the text was set by {@link #setOptionText} and was wrapped with Unicode bidi formatting characters, also removes those additional formatting characters.

@param option an option element @return the element's text

String getOptionText(dart_html.OptionElement option) {
 String text = option.text;
 if (option.attributes[BIDI_ATTR_NAME] != null && text.length > 1) {
   text = text.substring(1, text.length - 1);
 }
 return text;
}

Widget getParent() #

inherited from Widget

Gets this widget's parent panel.

@return the widget's parent panel

Widget getParent() {
 return _parent;
}

int getSelectedIndex() #

Gets the currently-selected item. If multiple items are selected, this method will return the first selected item ({@link #isItemSelected(int)} can be used to query individual items).

@return the selected index, or <code>-1</code> if none is selected

int getSelectedIndex() {
 return _getSelectElement().selectedIndex;
}

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());
}

String getValue(int index) #

Gets the value associated with the item at a given index.

@param index the index of the item to be retrieved @return the item's associated value @throws IndexOutOfBoundsException if the index is out of range

String getValue(int index) {
 _checkIndex(index);
 return _getSelectElement().options[index].value;
}

int getVisibleItemCount() #

Gets the number of items that are visible. If only one item is visible, then the box will be displayed as a drop-down list.

@return the visible item count

int getVisibleItemCount() {
 return _getSelectElement().size;
}

void insertItem(String item, TextDirection dir, String value, int index) #

Inserts an item into the list box, specifying its direction and an initial value for the item. If the index is less than zero, or greater than or equal to the length of the list, then the item will be appended to the end of the list.

@param item the text of the item to be inserted @param dir the item's direction. If {@code null}, the item is displayed in

     the widget's overall direction, or, if a direction estimator has
     been set, in the item's estimated direction.

@param value the item's value, to be submitted if it is part of a

     {@link FormPanel}.

@param index the index at which to insert it

void insertItem(String item, TextDirection dir, String value, int index) {
 dart_html.SelectElement select = _getSelectElement();
 dart_html.OptionElement option = new dart_html.OptionElement();
 setOptionText(option, item, dir);
 option.value = value;

 int itemCount = select.length;
 if (index < 0 || index > itemCount) {
   index = itemCount;
 }
 if (index == itemCount) {
   select.children.add(option);
 } else {
   //dart_html.OptionElement before = select.options[index];
//      select.children.insertRange(index, 1);
//      select.children[index] = option;
   select.children.insert(index, option);
 }
}

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 isItemSelected(int index) #

Determines whether an individual list item is selected.

@param index the index of the item to be tested @return <code>true</code> if the item is selected @throws IndexOutOfBoundsException if the index is out of range

bool isItemSelected(int index) {
 _checkIndex(index);
 return _getSelectElement().options[index].selected;
}

bool isMultipleSelect() #

Gets whether this list allows multiple selection.

@return <code>true</code> if multiple selection is allowed

bool isMultipleSelect() {
 return _getSelectElement().multiple;
}

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) #

inherited from Widget

Fired whenever a browser event is received.

@param event the event received

TODO

void onBrowserEvent(dart_html.Event event) {
 switch (Dom.eventGetType(event)) {
   case IEvent.ONMOUSEOVER:
     // Only fire the mouse over event if it's coming from outside this
     // widget.
   case IEvent.ONMOUSEOUT:
     // Only fire the mouse over event if it's coming from outside this widget.
     // Only fire the mouse out event if it's leaving this widget.
     dart_html.Element related = (event as dart_html.MouseEvent).relatedTarget as dart_html.Element;
     if (related != null && Dom.isOrHasChild(getElement(), related)) {
       return;
     }
     break;
 }

 DomEvent.fireNativeEvent(event, this, this.getElement());
}

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 Widget

This method is called immediately after a widget becomes attached to the browser's document.

void onLoad() {
}

void onUnload() #

inherited from Widget

This method is called immediately before a widget will be detached from the browser's document.

void onUnload() {
}

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 removeItem(int index) #

Removes the item at the specified index.

@param index the index of the item to be removed @throws IndexOutOfBoundsException if the index is out of range

void removeItem(int index) {
 _checkIndex(index);
 _getSelectElement().options[index].remove();
}

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 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 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 setItemSelected(int index, bool selected) #

Sets whether an individual list item is selected.

Note that setting the selection programmatically does not cause the {@link ChangeHandler#onChange(ChangeEvent)} event to be fired.

@param index the index of the item to be selected or unselected @param selected <code>true</code> to select the item @throws IndexOutOfBoundsException if the index is out of range

void setItemSelected(int index, bool selected) {
 _checkIndex(index);
 _getSelectElement().options[index].selected = selected;
}

void setItemText(int index, String text, TextDirection dir) #

Sets the text associated with the item at a given index.

@param index the index of the item to be set @param text the item's new text @param dir the item's direction. @throws IndexOutOfBoundsException if the index is out of range

void setItemText(int index, String text, TextDirection dir) {
 _checkIndex(index);
 if (text == null) {
   throw new Exception("NullPointer. Cannot set an option to have null text");
 }
 setOptionText(_getSelectElement().options[index], text, 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 setMultipleSelect(bool multiple) #

void setMultipleSelect(bool multiple) {
 _getSelectElement().multiple = multiple;
}

void setOptionText(OptionElement option, String text, [TextDirection dir = null]) #

Sets the text of an option element. If the direction of the text is opposite to the page's direction, also wraps it with Unicode bidi formatting characters to prevent garbling, and indicates that this was done by setting the option's <code>BIDIATTRNAME</code> custom attribute.

@param option an option element @param text text to be set to the element @param dir the text's direction. If {@code null} and direction estimation

     is turned off, direction is ignored.
void setOptionText(dart_html.OptionElement option, String text, [TextDirection dir = null]) {
//    if (dir == null && estimator != null) {
//      dir = estimator.estimateDirection(text);
//    }
 if (dir == null) {
   option.text = text;
   option.attributes.remove(BIDI_ATTR_NAME);
//    } else {
//      String formattedText = BidiFormatter.getInstanceForCurrentLocale().unicodeWrapWithKnownDir(dir, text, false /* isHtml */, false /* dirReset */);
//      option.setText(formattedText);
//      if (formattedText.length > text.length) {
//        option.attribute[BIDI_ATTR_NAME] = "";
//      } else {
//        option.attribute[BIDI_ATTR_NAME].remove();
//      }
 }
}

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 setSelectedIndex(int index) #

Sets the currently selected index.

After calling this method, only the specified item in the list will remain selected. For a ListBox with multiple selection enabled, see {@link #setItemSelected(int, boolean)} to select multiple items at a time.

Note that setting the selected index programmatically does not cause the {@link ChangeHandler#onChange(ChangeEvent)} event to be fired.

@param index the index of the item to be selected

void setSelectedIndex(int index) {
 _getSelectElement().selectedIndex = index;
}

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 setValue(int index, String value) #

Sets the value associated with the item at a given index. This value can be used for any purpose, but is also what is passed to the server when the list box is submitted as part of a {@link FormPanel}.

@param index the index of the item to be set @param value the item's new value; cannot be <code>null</code> @throws IndexOutOfBoundsException if the index is out of range

void setValue(int index, String value) {
 _checkIndex(index);
 _getSelectElement().options[index].value = value;
}

void setVisibleItemCount(int visibleItems) #

Sets the number of items that are visible. If only one item is visible, then the box will be displayed as a drop-down list.

@param visibleItems the visible item count

void setVisibleItemCount(int visibleItems) {
 _getSelectElement().size = visibleItems;
}

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) #

inherited from Widget

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);
 }
} 
void sinkEvents(int eventBitsToAdd) {
 if (isOrWasAttached()) {
   super.sinkEvents(eventsToSink);
 } else {
   eventsToSink |= 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));
}