org.w3c.dom.html2
Interface HTMLSelectElement

All Superinterfaces:
Element, Node, HTMLElement

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.

Since:
BlackBerry API 5.0.0

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
 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.html2.HTMLElement
getClassName, getDir, getId, getLang, getTitle, setClassName, setDir, setId, setLang, setTitle
 
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.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

getType

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.

Since:
BlackBerry API 5.0.0

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.

Since:
BlackBerry API 5.0.0

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.

Since:
BlackBerry API 5.0.0

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.

Since:
BlackBerry API 5.0.0

setValue

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.

Since:
BlackBerry API 5.0.0

getLength

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

Since:
BlackBerry API 5.0.0

setLength

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.
Since:
BlackBerry API 5.0.0

getForm

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

Since:
BlackBerry API 5.0.0

getOptions

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

Since:
BlackBerry API 5.0.0

getDisabled

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

Since:
BlackBerry API 5.0.0

setDisabled

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

Since:
BlackBerry API 5.0.0

getMultiple

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

Since:
BlackBerry API 5.0.0

setMultiple

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

Since:
BlackBerry API 5.0.0

getName

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

Since:
BlackBerry API 5.0.0

setName

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

Since:
BlackBerry API 5.0.0

getSize

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

Since:
BlackBerry API 5.0.0

setSize

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

Since:
BlackBerry API 5.0.0

getTabIndex

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

Since:
BlackBerry API 5.0.0

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.

Since:
BlackBerry API 5.0.0

add

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.
Since:
BlackBerry API 5.0.0

remove

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.
Since:
BlackBerry API 5.0.0

blur

void blur()
Removes keyboard focus from this element.

Since:
BlackBerry API 5.0.0

focus

void focus()
Gives keyboard focus to this element.

Since:
BlackBerry API 5.0.0





Copyright 1999-2010 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.