HTMLSelectElement (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.w3c.dom.html
interface HTMLSelectElement

All Superinterfaces:: Element, HTMLElement, Node

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

Field Summary

Fields inherited from class 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`

Fields inherited from class 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.
`HTMLCollection`	`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.
`void`	`remove(int index)` Remove an element from the collection of `OPTION` elements for this `SELECT` .
`void`	`setDisabled(boolean disabled)`
`void`	`setMultiple(boolean multiple)`
`void`	`setName(String name)`
`void`	`setSelectedIndex(int selectedIndex)`
`void`	`setSize(int size)`
`void`	`setTabIndex(int tabIndex)`
`void`	`setValue(String value)`

Methods inherited from class org.w3c.dom.html.HTMLElement
`getClassName, getDir, getId, getLang, getTitle, setClassName, setDir, setId, setLang, setTitle`

Methods inherited from class 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 class 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

Methods inherited from class 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 Detail

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.

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

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

getName

public String getName()

Form control or object name when submitted with a form. See the name attribute definition in HTML 4.0.

getOptions

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

getTabIndex

public int getTabIndex()

Index that represents the element's position in the tabbing order. See the tabindex attribute definition in HTML 4.0.

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.

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)

Parameters:: disabled

setMultiple

public void setMultiple(boolean multiple)

Parameters:: multiple

setName

public void setName(String name)

Parameters:: name

setSelectedIndex

public void setSelectedIndex(int selectedIndex)

Parameters:: selectedIndex

setSize

public void setSize(int size)

Parameters:: size

setTabIndex

public void setTabIndex(int tabIndex)

Parameters:: tabIndex

setValue

public void setValue(String value)

Parameters:: value