Package org.w3c.dom.html2
Interface HTMLSelectElement
- All Superinterfaces:
Element
,HTMLElement
,Node
- All Known Implementing Classes:
HTMLSelectElementImpl
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.
-
Field Summary
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
Modifier and TypeMethodDescriptionvoid
add
(HTMLElement element, HTMLElement before) Add a new element to the collection ofOPTION
elements for thisSELECT
.void
blur()
Removes keyboard focus from this element.void
focus()
Gives keyboard focus to this element.boolean
The control is unavailable in this context.getForm()
Returns theFORM
element containing this control.int
The number of options in thisSELECT
.boolean
If true, multipleOPTION
elements may be selected in thisSELECT
.getName()
Form control or object name when submitted with a form.The collection ofOPTION
elements contained by this element.int
The ordinal index of the selected option, starting from 0.int
getSize()
Number of visible rows.int
Index that represents the element's position in the tabbing order.getType()
The type of this form control.getValue()
The current form control value (i.e.void
remove
(int index) Remove an element from the collection ofOPTION
elements for thisSELECT
.void
setDisabled
(boolean disabled) The control is unavailable in this context.void
setLength
(int length) The number of options in thisSELECT
.void
setMultiple
(boolean multiple) If true, multipleOPTION
elements may be selected in thisSELECT
.void
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
The current form control value (i.e.Methods inherited from interface org.w3c.dom.Element
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS
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
-
getType
String getType()The type of this form control. This is the string "select-multiple" when the multiple attribute istrue
and the string "select-one" whenfalse
. -
getSelectedIndex
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. -
setSelectedIndex
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. -
getValue
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. -
setValue
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. -
getLength
int getLength()The number of options in thisSELECT
. -
setLength
The number of options in thisSELECT
.- Throws:
DOMException
- NOT_SUPPORTED_ERR: if setting the length is not allowed by the implementation.
-
getForm
HTMLFormElement getForm()Returns theFORM
element containing this control. Returnsnull
if this control is not within the context of a form. -
getOptions
HTMLOptionsCollection getOptions()The collection ofOPTION
elements contained by this element. -
getDisabled
boolean getDisabled()The control is unavailable in this context. See the disabled attribute definition in HTML 4.01. -
setDisabled
void setDisabled(boolean disabled) The control is unavailable in this context. See the disabled attribute definition in HTML 4.01. -
getMultiple
boolean getMultiple()If true, multipleOPTION
elements may be selected in thisSELECT
. See the multiple attribute definition in HTML 4.01. -
setMultiple
void setMultiple(boolean multiple) If true, multipleOPTION
elements may be selected in thisSELECT
. See the multiple attribute definition in HTML 4.01. -
getName
String getName()Form control or object name when submitted with a form. See the name attribute definition in HTML 4.01. -
setName
Form control or object name when submitted with a form. See the name attribute definition in HTML 4.01. -
getSize
int getSize()Number of visible rows. See the size attribute definition in HTML 4.01. -
setSize
void setSize(int size) Number of visible rows. See the size attribute definition in HTML 4.01. -
getTabIndex
int getTabIndex()Index that represents the element's position in the tabbing order. See the tabindex attribute definition in HTML 4.01. -
setTabIndex
void setTabIndex(int tabIndex) Index that represents the element's position in the tabbing order. See the tabindex attribute definition in HTML 4.01. -
add
Add a new element to the collection ofOPTION
elements for thisSELECT
. This method is the equivalent of theappendChild
method of theNode
interface if thebefore
parameter isnull
. It is equivalent to theinsertBefore
method on the parent ofbefore
in all other cases. This method may have no effect if the new element is not anOPTION
or anOPTGROUP
.- Parameters:
element
- The element to add.before
- The element to insert before, ornull
for the tail of the list.- Throws:
DOMException
- NOT_FOUND_ERR: Raised ifbefore
is not a descendant of theSELECT
element.
-
remove
void remove(int index) Remove an element from the collection ofOPTION
elements for thisSELECT
. Does nothing if no element has the given index.- Parameters:
index
- The index of the item to remove, starting from 0.
-
blur
void blur()Removes keyboard focus from this element. -
focus
void focus()Gives keyboard focus to this element.
-