|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.gargoylesoftware.htmlunit.html.DomNode
com.gargoylesoftware.htmlunit.html.DomNamespaceNode
com.gargoylesoftware.htmlunit.html.DomElement
com.gargoylesoftware.htmlunit.html.HtmlElement
com.gargoylesoftware.htmlunit.html.StyledElement
com.gargoylesoftware.htmlunit.html.ClickableElement
com.gargoylesoftware.htmlunit.html.HtmlSelect
public class HtmlSelect
Wrapper for the HTML element "select".
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.gargoylesoftware.htmlunit.html.HtmlElement |
---|
HtmlElement.ChildElementsIterator |
Nested classes/interfaces inherited from class com.gargoylesoftware.htmlunit.html.DomNode |
---|
DomNode.ChildIterator, DomNode.DescendantElementsIterator |
Field Summary | |
---|---|
static java.lang.String |
TAG_NAME
The HTML tag represented by this element. |
Fields inherited from class com.gargoylesoftware.htmlunit.html.HtmlElement |
---|
TAB_INDEX_OUT_OF_BOUNDS |
Fields inherited from class com.gargoylesoftware.htmlunit.html.DomElement |
---|
ATTRIBUTE_NOT_DEFINED, ATTRIBUTE_VALUE_EMPTY |
Fields inherited from class com.gargoylesoftware.htmlunit.html.DomNode |
---|
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 |
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 | |
---|---|
DomNode |
appendChild(org.w3c.dom.Node node)
|
void |
appendOption(HtmlOption newOption)
Add a new option at the end. |
java.lang.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. |
java.lang.String |
getDefaultValue()
Returns the default value to use when this element gets reset, if applicable. |
java.lang.String |
getDisabledAttribute()
Returns the value of the attribute "disabled". |
java.lang.String |
getMultipleAttribute()
Returns the value of the attribute "multiple". |
java.lang.String |
getNameAttribute()
Returns the value of the attribute "name". |
java.lang.String |
getOnBlurAttribute()
Returns the value of the attribute "onblur". |
java.lang.String |
getOnChangeAttribute()
Returns the value of the attribute "onchange". |
java.lang.String |
getOnFocusAttribute()
Returns the value of the attribute "onfocus". |
HtmlOption |
getOption(int index)
Returns the indexed option. |
HtmlOption |
getOptionByText(java.lang.String text)
Returns the HtmlOption object that has the specified text. |
HtmlOption |
getOptionByValue(java.lang.String value)
Returns the HtmlOption object that corresponds to the specified value. |
java.util.List<HtmlOption> |
getOptions()
Returns all of the options in this select element. |
int |
getOptionSize()
Returns the number of options. |
java.util.List<HtmlOption> |
getSelectedOptions()
Returns all of the currently selected options. |
java.lang.String |
getSizeAttribute()
Returns the value of the attribute "size". |
org.apache.commons.httpclient.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. |
java.lang.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 |
setDefaultChecked(boolean defaultChecked)
Sets the default checked state to use when this element gets reset, if applicable. |
void |
setDefaultValue(java.lang.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)
Sets the "selected" state of the specified option. |
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. |
Page |
setSelectedAttribute(java.lang.String optionValue,
boolean isSelected)
Sets the "selected" state of the specified option. |
Methods inherited from class com.gargoylesoftware.htmlunit.html.StyledElement |
---|
getClassAttribute, getIdAttribute, getStyleAttribute, getTitleAttribute |
Methods inherited from class com.gargoylesoftware.htmlunit.html.DomElement |
---|
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 |
Methods inherited from class com.gargoylesoftware.htmlunit.html.DomNamespaceNode |
---|
getLocalName, getNamespaceURI, getPrefix, getQualifiedName, setPrefix |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.w3c.dom.Node |
---|
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 |
Field Detail |
---|
public static final java.lang.String TAG_NAME
Method Detail |
---|
protected void onAllChildrenAddedToPage(boolean postponed)
onAllChildrenAddedToPage
in class DomNode
postponed
- whether to use PostponedAction
or nopublic java.util.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 java.util.List<HtmlOption> getOptions()
public HtmlOption getOption(int index)
index
- the index
public 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(org.w3c.dom.Node node)
appendChild
in interface org.w3c.dom.Node
appendChild
in class DomNode
public Page setSelectedAttribute(java.lang.String optionValue, boolean isSelected)
isSelected
- true if the option is to become selectedoptionValue
- the value of the option that is to change
public Page setSelectedAttribute(HtmlOption selectedOption, boolean isSelected)
isSelected
- true if the option is to become selectedselectedOption
- the value of the option that is to change
public Page setSelectedAttribute(HtmlOption selectedOption, boolean isSelected, boolean invokeOnFocus)
isSelected
- true if the option is to become selectedselectedOption
- the value of the option that is to changeinvokeOnFocus
- whether to set focus or no.
public org.apache.commons.httpclient.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(java.lang.String defaultValue)
setDefaultValue
in interface SubmittableElement
defaultValue
- the default value to use when this element gets reset, if applicableSubmittableElement.setDefaultValue(String)
public java.lang.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(java.lang.String value) throws ElementNotFoundException
HtmlOption
object that corresponds to the specified value.
value
- the value to search by
HtmlOption
object that corresponds to the specified value
ElementNotFoundException
- If a particular element could not be found in the DOM modelpublic HtmlOption getOptionByText(java.lang.String text) throws ElementNotFoundException
HtmlOption
object that has the specified text.
text
- the text to search by
HtmlOption
object that has the specified text
ElementNotFoundException
- If a particular element could not be found in the DOM modelpublic java.lang.String asText()
asText
in class DomNode
public final java.lang.String getNameAttribute()
public final java.lang.String getSizeAttribute()
public final java.lang.String getMultipleAttribute()
public final java.lang.String getDisabledAttribute()
getDisabledAttribute
in interface DisabledElement
public final boolean isDisabled()
isDisabled
in interface DisabledElement
public final java.lang.String getTabIndexAttribute()
public final java.lang.String getOnFocusAttribute()
public final java.lang.String getOnBlurAttribute()
public final java.lang.String getOnChangeAttribute()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |