com.google.gwt.dom.client.SelectElement Maven / Gradle / Ivy
/*
* Copyright 2008 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.google.gwt.dom.client;
import com.google.gwt.core.client.JavaScriptObject;
/**
* The select element allows the selection of an option.
*
* The contained options can be directly accessed through the select element as
* a collection.
*
* @see W3C HTML Specification
*/
@TagName(SelectElement.TAG)
public class SelectElement extends Element {
public static final String TAG = "select";
/**
* Assert that the given {@link Element} is compatible with this class and
* automatically typecast it.
*/
public static SelectElement as(Element elem) {
assert is(elem);
return (SelectElement) elem;
}
/**
* Determines whether the given {@link JavaScriptObject} can be cast to
* this class. A null object will cause this method to
* return false.
*/
public static boolean is(JavaScriptObject o) {
if (Element.is(o)) {
return is((Element) o);
}
return false;
}
/**
* Determine whether the given {@link Node} can be cast to this class.
* A null node will cause this method to return
* false.
*/
public static boolean is(Node node) {
if (Element.is(node)) {
return is((Element) node);
}
return false;
}
/**
* Determine whether the given {@link Element} can be cast to this class.
* A null node will cause this method to return
* false.
*/
public static boolean is(Element elem) {
return elem != null && elem.hasTagName(TAG);
}
protected SelectElement() {
}
/**
* 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.
*
* @param option The element to add
* @param before The element to insert before, or null for the tail of the
* list
*/
public final void add(OptionElement option, OptionElement before) {
DOMImpl.impl.selectAdd(this, option, before);
}
/**
* Removes all OPTION elements from this SELECT.
*/
public final void clear() {
DOMImpl.impl.selectClear(this);
}
/**
* The control is unavailable in this context.
*
* @see W3C HTML Specification
* @deprecated use {@link #isDisabled()} instead.
*/
@Deprecated
public final native String getDisabled() /*-{
return this.disabled;
}-*/;
/**
* Returns the FORM element containing this control. Returns null if this
* control is not within the context of a form.
*/
public final native FormElement getForm() /*-{
return this.form;
}-*/;
/**
* The number of options in this SELECT.
*/
public final int getLength() {
return DOMImpl.impl.selectGetLength(this);
}
/**
* If true, multiple OPTION elements may be selected in this SELECT.
*
* @see W3C HTML Specification
*/
public final native String getMultiple() /*-{
return this.multiple;
}-*/;
/**
* Form control or object name when submitted with a form.
*
* @see W3C HTML Specification
*/
public final native String getName() /*-{
return this.name;
}-*/;
/**
* The collection of OPTION elements contained by this element.
*/
public final NodeList getOptions() {
return DOMImpl.impl.selectGetOptions(this);
}
/**
* 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 native int getSelectedIndex() /*-{
return this.selectedIndex;
}-*/;
/**
* Number of visible rows.
*
* @see W3C HTML Specification
*/
public final native int getSize() /*-{
return this.size;
}-*/;
/**
* 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 native String getType() /*-{
return this.type;
}-*/;
/**
* 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 native String getValue() /*-{
return this.value;
}-*/;
/**
* The control is unavailable in this context.
*
* @see W3C HTML Specification
*/
public final native boolean isDisabled() /*-{
return !!this.disabled;
}-*/;
/**
* If true, multiple OPTION elements may be selected in this SELECT.
*
* @see W3C HTML Specification
*/
public final native boolean isMultiple() /*-{
return !!this.multiple;
}-*/;
/**
* Remove an element from the collection of OPTION elements for this SELECT.
* Does nothing if no element has the given index.
*
* @param index The index of the item to remove, starting from 0.
*/
public final void remove(int index) {
DOMImpl.impl.selectRemoveOption(this, index);
}
/**
* The control is unavailable in this context.
*
* @see W3C HTML Specification
*/
public final native void setDisabled(boolean disabled) /*-{
this.disabled = disabled;
}-*/;
/**
* The control is unavailable in this context.
*
* @see W3C HTML Specification
*/
public final native void setDisabled(String disabled) /*-{
this.disabled = disabled;
}-*/;
/**
* If true, multiple OPTION elements may be selected in this SELECT.
*
* @see W3C HTML Specification
*/
public final native void setMultiple(boolean multiple) /*-{
this.multiple = multiple;
}-*/;
/**
* Form control or object name when submitted with a form.
*
* @see W3C HTML Specification
*/
public final native void setName(String name) /*-{
this.name = name;
}-*/;
/**
* 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 native void setSelectedIndex(int index) /*-{
this.selectedIndex = index;
}-*/;
/**
* Number of visible rows.
*
* @see W3C HTML Specification
*/
public final native void setSize(int size) /*-{
this.size = size;
}-*/;
/**
* 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 native void setType(String type) /*-{
this.type = type;
}-*/;
/**
* 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 native void setValue(String value) /*-{
this.value = value;
}-*/;
}