public class HtmlSelect extends FocusableElement implements DisabledElement, SubmittableElement
HtmlElement.ChildElementsIterator, HtmlElement.MapEntryWrappingIterator
DomNode.ChildIterator, DomNode.DescendantElementsIterator
Modifier and Type | Field and Description |
---|---|
static String |
TAG_NAME
the HTML tag represented by this element
|
ATTRIBUTE_NOT_DEFINED, ATTRIBUTE_VALUE_EMPTY, TAB_INDEX_OUT_OF_BOUNDS
ATTRIBUTE_NODE, COMMENT_NODE, DOCUMENT_NODE, ELEMENT_NODE, PROPERTY_ELEMENT, READY_STATE_COMPLETE, READY_STATE_INTERACTIVE, READY_STATE_LOADED, READY_STATE_LOADING, READY_STATE_UNINITIALIZED, TEXT_NODE
Constructor and Description |
---|
HtmlSelect(HtmlPage page,
Map attributes)
Deprecated.
You should not directly construct HtmlSelect.
|
Modifier and Type | Method and Description |
---|---|
DomNode |
appendDomChild(DomNode node)
append a child node to the end of the current list
|
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.
|
void |
fakeSelectedAttribute(String optionValue)
Deprecated.
|
void |
fakeSelectedAttribute(String[] optionValues)
Deprecated.
|
String |
getDefaultValue()
Returns the default value to use when this element gets reset, if applicable.
|
String |
getDisabledAttribute()
Return the value of the attribute "disabled".
|
String |
getMultipleAttribute()
Return the value of the attribute "multiple".
|
String |
getNameAttribute()
Return the value of the attribute "name".
|
String |
getOnBlurAttribute()
Return the value of the attribute "onblur".
|
String |
getOnChangeAttribute()
Return the value of the attribute "onchange".
|
String |
getOnFocusAttribute()
Return the value of the attribute "onfocus".
|
HtmlOption |
getOption(int index)
Return the indexed option.
|
HtmlOption |
getOptionByValue(String value)
Return the HtmlOption object that corresponds to the specified value
|
List |
getOptions()
Return a List containing all the options
|
int |
getOptionSize()
Return the number of options
|
List |
getSelectedOptions()
Return a List containing all of the currently selected options.
|
String |
getSizeAttribute()
Return the value of the attribute "size".
|
KeyValuePair[] |
getSubmitKeyValuePairs()
Return an array of KeyValuePairs that are the values that will be sent
back to the server whenever the current form is submitted.
|
String |
getTabIndexAttribute()
Return the value of the attribute "tabindex".
|
boolean |
isDefaultChecked()
Returns the default checked state to use when this element gets reset, if applicable.
|
boolean |
isDisabled()
Return true if the disabled attribute is set for this element.
|
boolean |
isMultipleSelectEnabled()
Return true if this select is using "multiple select"
|
protected void |
onAllChildrenAddedToPage()
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()
Return the value of this element to what it was at the time the page was loaded.
|
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.
|
Page |
setSelectedAttribute(HtmlOption selectedOption,
boolean isSelected)
Set the "selected" state of the specified option.
|
Page |
setSelectedAttribute(String optionValue,
boolean isSelected)
Set the "selected" state of the specified option.
|
click, click, click, dblClick, dblClick, doClickAction, getLangAttribute, getOnClickAttribute, getOnDblClickAttribute, getOnKeyDownAttribute, getOnKeyPressAttribute, getOnKeyUpAttribute, getOnMouseDownAttribute, getOnMouseMoveAttribute, getOnMouseOutAttribute, getOnMouseOverAttribute, getOnMouseUpAttribute, getTextDirectionAttribute, getXmlLangAttribute, isStateUpdateFirst
getClassAttribute, getIdAttribute, getStyleAttribute, getTitleAttribute, isRenderedVisible
addHtmlAttributeChangeListener, appendChildIfNoneExists, assertNotEmpty, blur, cloneDomNode, cloneNode, fireEvent, fireEvent, fireHtmlAttributeAdded, fireHtmlAttributeRemoved, fireHtmlAttributeReplaced, focus, getAttribute, getAttributeEntriesIterator, getAttributeNS, getAttributeValue, getChildElementsIterator, getEnclosingElement, getEnclosingForm, getEnclosingFormOrDie, getEventHandler, getHtmlElementById, getHtmlElementsByAttribute, getHtmlElementsByTagName, getHtmlElementsByTagNames, getId, getNodeName, getNodeType, getOneHtmlElementByAttribute, getTabIndex, getTagName, hasAttribute, hasAttributeNS, hasAttributes, hasHtmlElementWithId, isAttributeDefined, isEmptyXmlTagExpanded, isSubmittableByEnter, keyDown, keyDown, mouseDown, mouseDown, mouseMove, mouseMove, mouseOut, mouseOut, mouseOver, mouseOver, mouseUp, mouseUp, notImplemented, preventDefault, printOpeningTagContentAsXml, printXml, removeAttribute, removeAttributeNS, removeChild, removeEventHandler, removeHtmlAttributeChangeListener, rightClick, rightClick, setAttribute, setAttributeNS, setAttributeValue, setAttributeValue, setEventHandler, setEventHandler, setId, toString, type, type, type, type
getLocalName, getNamespaceURI, getPrefix, getQualifiedName, setPrefix
addDomChangeListener, addPropertyChangeListener, appendChild, asXml, fireNodeAdded, fireNodeDeleted, firePropertyChange, getAllHtmlChildElements, getByXPath, getChildIterator, getChildrenAsText, getEndColumnNumber, getEndLineNumber, getFirstByXPath, getFirstChild, getFirstDomChild, getLastChild, getLastDomChild, getLog, getNativePage, getNextDomSibling, getNextSibling, getNodeValue, getPage, getParentDomNode, getParentNode, getPreviousDomSibling, getPreviousSibling, getReadyState, getScriptObject, getStartColumnNumber, getStartLineNumber, insertBefore, isAncestorOf, isTrimmedText, notifyIncorrectness, onAddedToPage, printChildrenAsXml, reduceWhitespace, remove, removeAllChildren, removeDomChangeListener, removePropertyChangeListener, replace, setNextSibling, setNodeValue, setParentNode, setPreviousSibling, setReadyState, setScriptObject
public static final String TAG_NAME
protected void onAllChildrenAddedToPage()
onAllChildrenAddedToPage
in class DomNode
public List getSelectedOptions()
public List 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 appendDomChild(DomNode node)
appendDomChild
in class DomNode
node
- the node to appendDomNode.appendDomChild(DomNode)
public Page setSelectedAttribute(String optionValue, boolean isSelected)
Only options that are actually in the document may be selected. If you
need to select an option that really isn't there (ie testing error
cases) then use fakeSelectedAttribute(String)
or fakeSelectedAttribute(String[])
instead.
isSelected
- true if the option is to become selectedoptionValue
- The value of the option that is to changepublic Page setSelectedAttribute(HtmlOption selectedOption, boolean isSelected)
Only options that are actually in the document may be selected. If you
need to select an option that really isn't there (ie testing error
cases) then use fakeSelectedAttribute(String)
or fakeSelectedAttribute(String[])
instead.
isSelected
- true if the option is to become selectedselectedOption
- The value of the option that is to changepublic void fakeSelectedAttribute(String optionValue)
optionValue
- The value of the new "selected" optionpublic void fakeSelectedAttribute(String[] optionValues)
optionValues
- The values of the new "selected" optionspublic KeyValuePair[] getSubmitKeyValuePairs()
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 applicable.SubmittableElement.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 applicable.SubmittableElement.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
value
- The value to search byElementNotFoundException
- If a particular xml 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()
Copyright © 2002-2012 Gargoyle Software Inc.. All Rights Reserved.