org.w3c.dom.html2

Interface HTMLSelectElement

All Superinterfaces:
Element, HTMLElement, Node
Known Implementing Classes:
DomHTMLSelectElement

public interface HTMLSelectElement
extends HTMLElement

The select element allows the selection of an option. The contained options can be directly accessed through the select element as a collection. See the SELECT element definition in HTML 4.01.

See also the Document Object Model (DOM) Level 2 HTML Specification.

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Method Summary

void
add(HTMLElement element, HTMLElement before)
Add a new element to the collection of OPTION elements for this SELECT.
void
blur()
Removes keyboard focus from this element.
void
focus()
Gives keyboard focus to this element.
boolean
getDisabled()
The control is unavailable in this context.
HTMLFormElement
getForm()
Returns the FORM element containing this control.
int
getLength()
The number of options in this SELECT.
boolean
getMultiple()
If true, multiple OPTION elements may be selected in this SELECT.
String
getName()
Form control or object name when submitted with a form.
HTMLOptionsCollection
getOptions()
The collection of OPTION elements contained by this element.
int
getSelectedIndex()
The ordinal index of the selected option, starting from 0.
int
getSize()
Number of visible rows.
int
getTabIndex()
Index that represents the element's position in the tabbing order.
String
getType()
The type of this form control.
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.
void
remove(int index)
Remove an element from the collection of OPTION elements for this SELECT.
void
setDisabled(boolean disabled)
The control is unavailable in this context.
void
setLength(int length)
The number of options in this SELECT.
void
setMultiple(boolean multiple)
If true, multiple OPTION elements may be selected in this SELECT.
void
setName(String name)
Form control or object name when submitted with a form.
void
setSelectedIndex(int selectedIndex)
The ordinal index of the selected option, starting from 0.
void
setSize(int size)
Number of visible rows.
void
setTabIndex(int tabIndex)
Index that represents the element's position in the tabbing order.
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.

Methods inherited from interface org.w3c.dom.Element

getAttribute, getAttributeNS, getAttributeNode, getAttributeNodeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNS, removeAttributeNode, setAttribute, setAttributeNS, setAttributeNode, setAttributeNodeNS, setIdAttribute, setIdAttributeNS, setIdAttributeNode

Methods inherited from interface org.w3c.dom.html2.HTMLElement

getClassName, getDir, getId, getLang, getTitle, setClassName, setDir, setId, setLang, setTitle

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Method Details

add

public void add(HTMLElement element,
                HTMLElement before)
            throws DOMException
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:
element - The element to add.
before - The element to insert before, or null for the tail of the list.
Throws:
DOMException - NOT_FOUND_ERR: Raised if before is not a descendant of the SELECT element.

blur

public void blur()
Removes keyboard focus from this element.

focus

public void focus()
Gives keyboard focus to this element.

getDisabled

public boolean getDisabled()
The control is unavailable in this context. See the disabled attribute definition in HTML 4.01.

getForm

public HTMLFormElement getForm()
Returns the FORM element containing this control. Returns null if this control is not within the context of a form.

getLength

public int getLength()
The number of options in this SELECT.

getMultiple

public boolean getMultiple()
If true, multiple OPTION elements may be selected in this SELECT. See the multiple attribute definition in HTML 4.01.

getName

public String getName()
Form control or object name when submitted with a form. See the name attribute definition in HTML 4.01.

getOptions

public HTMLOptionsCollection getOptions()
The collection of OPTION elements contained by this element.

getSelectedIndex

public 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.

getSize

public int getSize()
Number of visible rows. See the size attribute definition in HTML 4.01.

getTabIndex

public int getTabIndex()
Index that represents the element's position in the tabbing order. See the tabindex attribute definition in HTML 4.01.

getType

public 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.

getValue

public 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.

remove

public 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.

setDisabled

public void setDisabled(boolean disabled)
The control is unavailable in this context. See the disabled attribute definition in HTML 4.01.

setLength

public void setLength(int length)
            throws DOMException
The number of options in this SELECT.
Throws:
DOMException - NOT_SUPPORTED_ERR: if setting the length is not allowed by the implementation.

setMultiple

public void setMultiple(boolean multiple)
If true, multiple OPTION elements may be selected in this SELECT. See the multiple attribute definition in HTML 4.01.

setName

public void setName(String name)
Form control or object name when submitted with a form. See the name attribute definition in HTML 4.01.

setSelectedIndex

public void setSelectedIndex(int selectedIndex)
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.

setSize

public void setSize(int size)
Number of visible rows. See the size attribute definition in HTML 4.01.

setTabIndex

public void setTabIndex(int tabIndex)
Index that represents the element's position in the tabbing order. See the tabindex attribute definition in HTML 4.01.

setValue

public 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.

* Copyright (c) 2003 World Wide Web Consortium, * (Massachusetts Institute of Technology, Institut National de * Recherche en Informatique et en Automatique, Keio University). All * Rights Reserved. This program is distributed under the W3C's Software * Intellectual Property License. This program is distributed in the * hope that it will be useful, but WITHOUT ANY WARRANTY; without even * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR * PURPOSE. * See W3C License http://www.w3.org/Consortium/Legal/ for more details.