public class

SelectElement

extends Element
java.lang.Object
   ↳ com.google.gwt.core.client.JavaScriptObject
     ↳ com.google.gwt.dom.client.Node
       ↳ com.google.gwt.dom.client.Element
         ↳ com.google.gwt.dom.client.SelectElement

Class Overview

The select element allows the selection of an option. The contained options can be directly accessed through the select element as a collection.

Summary

[Expand]
Inherited Constants
From class com.google.gwt.dom.client.Node
Protected Constructors
SelectElement()
Public Methods
final void add(OptionElement option, OptionElement before)
Add a new element to the collection of OPTION elements for this SELECT.
static SelectElement as(Element elem)
Assert that the given Element is compatible with this class and automatically typecast it.
final void clear()
Removes all OPTION elements from this SELECT.
final String getDisabled()
This method is deprecated. use isDisabled() instead.
final FormElement getForm()
Returns the FORM element containing this control.
final int getLength()
The number of options in this SELECT.
final String getMultiple()
If true, multiple OPTION elements may be selected in this SELECT.
final String getName()
Form control or object name when submitted with a form.
final NodeList<OptionElement> getOptions()
The collection of OPTION elements contained by this element.
final int getSelectedIndex()
The ordinal index of the selected option, starting from 0.
final int getSize()
Number of visible rows.
final String getType()
The type of this form control.
final String getValue()
The current form control value (i.e., the value of the currently selected option), if multiple options are selected this is the value of the first selected option.
final boolean isDisabled()
The control is unavailable in this context.
final boolean isMultiple()
If true, multiple OPTION elements may be selected in this SELECT.
final void remove(int index)
Remove an element from the collection of OPTION elements for this SELECT.
final void setDisabled(String disabled)
The control is unavailable in this context.
final void setDisabled(boolean disabled)
The control is unavailable in this context.
final void setMultiple(boolean multiple)
If true, multiple OPTION elements may be selected in this SELECT.
final void setName(String name)
Form control or object name when submitted with a form.
final void setSelectedIndex(int index)
The ordinal index of the selected option, starting from 0.
final void setSize(int size)
Number of visible rows.
final void setType(String type)
The type of this form control.
final void setValue(String value)
The current form control value (i.e., the value of the currently selected option), if multiple options are selected this is the value of the first selected option.
[Expand]
Inherited Methods
From class com.google.gwt.dom.client.Element
From class com.google.gwt.dom.client.Node
From class com.google.gwt.core.client.JavaScriptObject
From class java.lang.Object

Protected Constructors

protected SelectElement ()

Public Methods

public final void add (OptionElement option, OptionElement before)

Add a new element to the collection of OPTION elements for this SELECT. This method is the equivalent of the appendChild method of the Node interface if the before parameter is null. It is equivalent to the insertBefore method on the parent of before in all other cases. This method may have no effect if the new element is not an OPTION or an OPTGROUP.

Parameters
option The element to add
before The element to insert before, or null for the tail of the list

public static SelectElement as (Element elem)

Assert that the given Element is compatible with this class and automatically typecast it.

public final void clear ()

Removes all OPTION elements from this SELECT.

public final String getDisabled ()

This method is deprecated.
use isDisabled() instead.

The control is unavailable in this context.

public final FormElement getForm ()

Returns the FORM element containing this control. Returns null if this control is not within the context of a form.

public final int getLength ()

The number of options in this SELECT.

public final String getMultiple ()

If true, multiple OPTION elements may be selected in this SELECT.

public final String getName ()

Form control or object name when submitted with a form.

public final NodeList<OptionElement> getOptions ()

The collection of OPTION elements contained by this element.

public final int getSelectedIndex ()

The ordinal index of the selected option, starting from 0. The value -1 is returned if no element is selected. If multiple options are selected, the index of the first selected option is returned.

public final int getSize ()

Number of visible rows.

public final String getType ()

The type of this form control. This is the string "select-multiple" when the multiple attribute is true and the string "select-one" when false.

public final String getValue ()

The current form control value (i.e., the value of the currently selected option), if multiple options are selected this is the value of the first selected option.

public final boolean isDisabled ()

The control is unavailable in this context.

public final boolean isMultiple ()

If true, multiple OPTION elements may be selected in this SELECT.

public final void remove (int index)

Remove an element from the collection of OPTION elements for this SELECT. Does nothing if no element has the given index.

Parameters
index The index of the item to remove, starting from 0.

public final void setDisabled (String disabled)

The control is unavailable in this context.

public final void setDisabled (boolean disabled)

The control is unavailable in this context.

public final void setMultiple (boolean multiple)

If true, multiple OPTION elements may be selected in this SELECT.

public final void setName (String name)

Form control or object name when submitted with a form.

public final void setSelectedIndex (int index)

The ordinal index of the selected option, starting from 0. The value -1 is returned if no element is selected. If multiple options are selected, the index of the first selected option is returned.

public final void setSize (int size)

Number of visible rows.

public final void setType (String type)

The type of this form control. This is the string "select-multiple" when the multiple attribute is true and the string "select-one" when false.

public final void setValue (String value)

The current form control value (i.e., the value of the currently selected option), if multiple options are selected this is the value of the first selected option.