com.google.gwt.dom.client.OptionElement 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;
/**
* A selectable choice.
*
* @see W3C HTML Specification
*/
@TagName(OptionElement.TAG)
public class OptionElement extends Element {
public static final String TAG = "option";
/**
* Assert that the given {@link Element} is compatible with this class and
* automatically typecast it.
*/
public static OptionElement as(Element elem) {
assert is(elem);
return (OptionElement) 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 OptionElement() {
}
/**
* 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 index of this OPTION in its parent SELECT, starting from 0.
*/
public final native int getIndex() /*-{
return this.index;
}-*/;
/**
* Option label for use in hierarchical menus.
*
* @see W3C HTML Specification
*/
public final native String getLabel() /*-{
return this.label;
}-*/;
/**
* The text contained within the option element.
*/
public final native String getText() /*-{
return this.text;
}-*/;
/**
* The current form control value.
*
* @see W3C HTML Specification
*/
public final native String getValue() /*-{
return this.value;
}-*/;
/**
* Represents the value of the HTML selected attribute. The value of this
* attribute does not change if the state of the corresponding form control,
* in an interactive user agent, changes.
*
* @see W3C HTML Specification
*/
public final native boolean isDefaultSelected() /*-{
return !!this.defaultSelected;
}-*/;
/**
* The control is unavailable in this context.
*
* @see W3C HTML Specification
*/
public final native boolean isDisabled() /*-{
return !!this.disabled;
}-*/;
/**
* Represents the current state of the corresponding form control, in an
* interactive user agent. Changing this attribute changes the state of the
* form control, but does not change the value of the HTML selected attribute
* of the element.
*/
public final native boolean isSelected() /*-{
return !!this.selected;
}-*/;
/**
* Represents the value of the HTML selected attribute. The value of this
* attribute does not change if the state of the corresponding form control,
* in an interactive user agent, changes.
*
* @see W3C HTML Specification
*/
public final native void setDefaultSelected(boolean selected) /*-{
this.defaultSelected = selected;
}-*/;
/**
* The control is unavailable in this context.
*
* @see W3C HTML Specification
*/
public final native void setDisabled(boolean disabled) /*-{
this.disabled = disabled;
}-*/;
/**
* Option label for use in hierarchical menus.
*
* @see W3C HTML Specification
*/
public final native void setLabel(String label) /*-{
this.label = label;
}-*/;
/**
* Represents the current state of the corresponding form control, in an
* interactive user agent. Changing this attribute changes the state of the
* form control, but does not change the value of the HTML selected attribute
* of the element.
*/
public final native void setSelected(boolean selected) /*-{
this.selected = selected;
}-*/;
/**
* The text contained within the option element.
*/
public final native void setText(String text) /*-{
this.text = text;
}-*/;
/**
* The current form control value.
*
* @see W3C HTML Specification
*/
public final native void setValue(String value) /*-{
this.value = value;
}-*/;
}