public class HtmlSelect extends HtmlElement implements DisabledElement, SubmittableElement, FormFieldWithNameHistory
HtmlElement.ChildElementsIterator
DomNode.ChildIterator, DomNode.DescendantElementsIterator<T extends DomNode>
Modifier and Type | Field and Description |
---|---|
static String |
TAG_NAME
The HTML tag represented by this element.
|
TAB_INDEX_OUT_OF_BOUNDS
ATTRIBUTE_NOT_DEFINED, ATTRIBUTE_VALUE_EMPTY
AS_TEXT_BLANK, AS_TEXT_BLOCK_SEPARATOR, AS_TEXT_NEW_LINE, AS_TEXT_TAB, PROPERTY_ELEMENT, READY_STATE_COMPLETE, READY_STATE_INTERACTIVE, READY_STATE_LOADED, READY_STATE_LOADING, READY_STATE_UNINITIALIZED
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
Modifier and Type | Method and Description |
---|---|
DomNode |
appendChild(Node node) |
void |
appendOption(HtmlOption newOption)
Add a new option at the end.
|
String |
asText()
Returns a text representation of this element that represents what would
be visible to the user if this page was shown in a web browser.
|
String |
getDefaultValue()
Returns the default value to use when this element gets reset, if applicable.
|
String |
getDisabledAttribute()
Returns the value of the attribute "disabled".
|
String |
getMultipleAttribute()
Returns the value of the attribute "multiple".
|
String |
getNameAttribute()
Returns the value of the attribute "name".
|
String |
getOnBlurAttribute()
Returns the value of the attribute "onblur".
|
String |
getOnChangeAttribute()
Returns the value of the attribute "onchange".
|
String |
getOnFocusAttribute()
Returns the value of the attribute "onfocus".
|
HtmlOption |
getOption(int index)
Returns the indexed option.
|
HtmlOption |
getOptionByText(String text)
Returns the
HtmlOption object that has the specified text. |
HtmlOption |
getOptionByValue(String value)
Returns the
HtmlOption object that corresponds to the specified value. |
List<HtmlOption> |
getOptions()
Returns all of the options in this select element.
|
int |
getOptionSize()
Returns the number of options.
|
String |
getOriginalName()
Gets the first value of the
name attribute of this field before any change. |
Collection<String> |
getPreviousNames()
Get all the names this field had before the current one.
|
List<HtmlOption> |
getSelectedOptions()
Returns all of the currently selected options.
|
String |
getSizeAttribute()
Returns the value of the attribute "size".
|
NameValuePair[] |
getSubmitKeyValuePairs()
Returns an array of
NameValuePair s that are the values that will be sent
back to the server whenever this element's containing form is submitted. |
String |
getTabIndexAttribute()
Returns the value of the attribute "tabindex".
|
boolean |
isDefaultChecked()
Returns the default checked state to use when this element gets reset, if applicable.
|
boolean |
isDisabled()
Returns true if the disabled attribute is set for this element.
|
boolean |
isMultipleSelectEnabled()
Returns true if this select is using "multiple select".
|
protected void |
onAllChildrenAddedToPage(boolean postponed)
If we were given an invalid size attribute, normalize it.
|
void |
removeOption(int index)
Remove an option at the given index.
|
void |
replaceOption(int index,
HtmlOption newOption)
Replace an option at the given index with a new option.
|
void |
reset()
Returns the value of this element to what it was at the time the page was loaded.
|
void |
setAttributeNS(String namespaceURI,
String qualifiedName,
String attributeValue)
Sets the value of the specified attribute.
|
void |
setDefaultChecked(boolean defaultChecked)
Sets the default checked state to use when this element gets reset, if applicable.
|
void |
setDefaultValue(String defaultValue)
Sets the default value to use when this element gets reset, if applicable.
|
void |
setOptionSize(int newLength)
Remove options by reducing the "length" property.
|
<P extends Page> |
setSelectedAttribute(HtmlOption selectedOption,
boolean isSelected)
Sets the "selected" state of the specified option.
|
<P extends Page> |
setSelectedAttribute(HtmlOption selectedOption,
boolean isSelected,
boolean invokeOnFocus)
INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
Sets the "selected" state of the specified option. |
<P extends Page> |
setSelectedAttribute(String optionValue,
boolean isSelected)
Sets the "selected" state of the specified option.
|
addHtmlAttributeChangeListener, appendChildIfNoneExists, blur, checkChildHierarchy, click, click, click, dblClick, dblClick, doClickAction, doType, fireEvent, fireEvent, fireHtmlAttributeAdded, fireHtmlAttributeRemoved, fireHtmlAttributeReplaced, focus, getCanonicalXPath, getChildElements, getElementById, getElementsByAttribute, getEnclosingElement, getEnclosingForm, getEnclosingFormOrDie, getEventTargetElement, getHtmlElementsByTagName, getHtmlElementsByTagNames, getId, getLangAttribute, getNodeName, getOnClickAttribute, getOnDblClickAttribute, getOneHtmlElementByAttribute, getOnKeyDownAttribute, getOnKeyPressAttribute, getOnKeyUpAttribute, getOnMouseDownAttribute, getOnMouseMoveAttribute, getOnMouseOutAttribute, getOnMouseOverAttribute, getOnMouseUpAttribute, getTabIndex, getTextDirectionAttribute, getXmlLangAttribute, hasEventHandlers, hasHtmlElementWithId, isAttributeCaseSensitive, isStateUpdateFirst, isSubmittableByEnter, mouseDown, mouseDown, mouseMove, mouseMove, mouseOut, mouseOut, mouseOver, mouseOver, mouseUp, mouseUp, preventDefault, querySelector, querySelectorAll, removeAttribute, removeChild, removeEventHandler, removeHtmlAttributeChangeListener, rightClick, rightClick, setEventHandler, setEventHandler, setId, toString, type, type, type, type
cloneNode, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributesMap, getElementsByTagName, getElementsByTagNameNS, getNodeType, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, hasAttributes, isEmptyXmlTagExpanded, namespaces, printOpeningTagContentAsXml, printXml, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS
getLocalName, getNamespaceURI, getPrefix, getQualifiedName, setPrefix
addDomChangeListener, asXml, compareDocumentPosition, fireNodeAdded, fireNodeDeleted, getAncestors, getBaseURI, getByXPath, getChildNodes, getChildren, getDescendants, getEndColumnNumber, getEndLineNumber, getFeature, getFirstByXPath, getFirstChild, getHtmlElementDescendants, getIndex, getLastChild, getNextSibling, getNodeValue, getOwnerDocument, getPage, getParentNode, getPreviousSibling, getReadyState, getScriptObject, getStartColumnNumber, getStartLineNumber, getTextContent, getUserData, hasChildNodes, insertBefore, insertBefore, isAncestorOf, isAncestorOfAny, isBlock, isDefaultNamespace, isDirectlyAttachedToPage, isDisplayed, isEqualNode, isSameNode, isSupported, isTrimmedText, lookupNamespaceURI, lookupPrefix, mayBeDisplayed, normalize, notifyIncorrectness, onAddedToPage, printChildrenAsXml, remove, removeAllChildren, removeChild, removeDomChangeListener, replace, replaceChild, setNextSibling, setNodeValue, setParentNode, setPreviousSibling, setReadyState, setScriptObject, setTextContent, setUserData
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
compareDocumentPosition, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData
public static final String TAG_NAME
protected void onAllChildrenAddedToPage(boolean postponed)
onAllChildrenAddedToPage
in class DomNode
postponed
- whether to use PostponedAction
or nopublic List<HtmlOption> getSelectedOptions()
Returns all of the currently selected options. The following special conditions can occur if the element is in single select mode:
public List<HtmlOption> getOptions()
public HtmlOption getOption(int index)
index
- the indexpublic int getOptionSize()
public void setOptionSize(int newLength)
newLength
- the new length property valuepublic void removeOption(int index)
index
- the index of the option to removepublic void replaceOption(int index, HtmlOption newOption)
index
- the index of the option to removenewOption
- the new option to replace to indexed optionpublic void appendOption(HtmlOption newOption)
newOption
- the new option to addpublic DomNode appendChild(Node node)
appendChild
in interface Node
appendChild
in class DomNode
public <P extends Page> P setSelectedAttribute(String optionValue, boolean isSelected)
P
- the page typeisSelected
- true if the option is to become selectedoptionValue
- the value of the option that is to changeWebClient.getCurrentWindow()
public <P extends Page> P setSelectedAttribute(HtmlOption selectedOption, boolean isSelected)
P
- the page typeisSelected
- true if the option is to become selectedselectedOption
- the value of the option that is to changeWebClient.getCurrentWindow()
public <P extends Page> P setSelectedAttribute(HtmlOption selectedOption, boolean isSelected, boolean invokeOnFocus)
P
- the page typeisSelected
- true if the option is to become selectedselectedOption
- the value of the option that is to changeinvokeOnFocus
- whether to set focus or no.WebClient.getCurrentWindow()
public NameValuePair[] getSubmitKeyValuePairs()
Returns an array of NameValuePair
s that are the values that will be sent
back to the server whenever this element's containing form is submitted.
THIS METHOD IS INTENDED FOR THE USE OF THE FRAMEWORK ONLY AND SHOULD NOT BE USED BY CONSUMERS OF HTMLUNIT. USE AT YOUR OWN RISK.
getSubmitKeyValuePairs
in interface SubmittableElement
public void reset()
reset
in interface SubmittableElement
public void setDefaultValue(String defaultValue)
setDefaultValue
in interface SubmittableElement
defaultValue
- the default value to use when this element gets reset, if applicableSubmittableElement.setDefaultValue(String)
public String getDefaultValue()
getDefaultValue
in interface SubmittableElement
SubmittableElement.setDefaultValue(String)
public void setDefaultChecked(boolean defaultChecked)
setDefaultChecked
in interface SubmittableElement
defaultChecked
- the default checked state to use when this element gets reset, if applicableSubmittableElement.setDefaultChecked(boolean)
,
HtmlRadioButtonInput.setDefaultChecked(boolean)
,
HtmlCheckBoxInput.setDefaultChecked(boolean)
public boolean isDefaultChecked()
isDefaultChecked
in interface SubmittableElement
SubmittableElement.isDefaultChecked()
,
HtmlRadioButtonInput.isDefaultChecked()
,
HtmlCheckBoxInput.isDefaultChecked()
public boolean isMultipleSelectEnabled()
public HtmlOption getOptionByValue(String value) throws ElementNotFoundException
HtmlOption
object that corresponds to the specified value.value
- the value to search byHtmlOption
object that corresponds to the specified valueElementNotFoundException
- If a particular element could not be found in the DOM modelpublic HtmlOption getOptionByText(String text) throws ElementNotFoundException
HtmlOption
object that has the specified text.text
- the text to search byHtmlOption
object that has the specified textElementNotFoundException
- If a particular element could not be found in the DOM modelpublic String asText()
public final String getNameAttribute()
public final String getSizeAttribute()
public final String getMultipleAttribute()
public final String getDisabledAttribute()
getDisabledAttribute
in interface DisabledElement
public final boolean isDisabled()
isDisabled
in interface DisabledElement
public final String getTabIndexAttribute()
public final String getOnFocusAttribute()
public final String getOnBlurAttribute()
public final String getOnChangeAttribute()
public void setAttributeNS(String namespaceURI, String qualifiedName, String attributeValue)
setAttributeNS
in interface Element
setAttributeNS
in class HtmlElement
namespaceURI
- the URI that identifies an XML namespacequalifiedName
- the qualified name of the attributeattributeValue
- the value of the attributepublic String getOriginalName()
name
attribute of this field before any change.getOriginalName
in interface FormFieldWithNameHistory
public Collection<String> getPreviousNames()
getPreviousNames
in interface FormFieldWithNameHistory
Copyright © 2002-2012 Gargoyle Software Inc.. All Rights Reserved.