com.gargoylesoftware.htmlunit.html
Class HtmlIsIndex

java.lang.Object
  com.gargoylesoftware.htmlunit.html.DomNode
      com.gargoylesoftware.htmlunit.html.DomNamespaceNode
          com.gargoylesoftware.htmlunit.html.HtmlElement
              com.gargoylesoftware.htmlunit.html.StyledElement
                  com.gargoylesoftware.htmlunit.html.HtmlIsIndex

All Implemented Interfaces:

SubmittableElement, java.io.Serializable, java.lang.Cloneable

public class HtmlIsIndex
extends StyledElement
implements SubmittableElement

Wrapper for the html element "isindex". Note that this element has been deprecated in the HTML spec.

Version:

$Revision: 1.3 $

Author:

Mike Bowler, David K. Taylor, Christian Sell, Daniel Gredler, Ahmed Ashour

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.gargoylesoftware.htmlunit.html.HtmlElement

HtmlElement.MapEntryWrappingIterator

Field Summary

static java.lang.String

TAG_NAME the HTML tag represented by this element

Fields inherited from class com.gargoylesoftware.htmlunit.html.HtmlElement

ATTRIBUTE_NOT_DEFINED, ATTRIBUTE_VALUE_EMPTY

Fields inherited from class com.gargoylesoftware.htmlunit.html.DomNode

PROPERTY_ELEMENT, READY_STATE_COMPLETE, READY_STATE_INTERACTIVE, READY_STATE_LOADED, READY_STATE_LOADING, READY_STATE_UNINITIALIZED

Method Summary

java.lang.String	getDefaultValue() Returns the default value to use when this element gets reset, if applicable.
java.lang.String	getLangAttribute() Return the value of the attribute "lang".
java.lang.String	getPromptAttribute() Return the value of the attribute "prompt".
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.
java.lang.String	getTextDirectionAttribute() Return the value of the attribute "dir".
java.lang.String	getValue() Return the value that would be send during submission of a form.
java.lang.String	getXmlLangAttribute() Return the value of the attribute "xml:lang".
boolean	isDefaultChecked() Returns the default checked state to use when this element gets reset, if applicable. This implementation returns false; only checkboxes and radio buttons really care what the default checked value is.
void	reset() Return the value of this element to the default value or checked state (usually what it was at the time the page was loaded, unless it has been modified via JavaScript).
void	setDefaultChecked(boolean defaultChecked) Sets the default checked state to use when this element gets reset, if applicable. This implementation is empty; only checkboxes and radio buttons really care what the default checked value is.
void	setDefaultValue(java.lang.String defaultValue) Sets the default value to use when this element gets reset, if applicable.
void	setValue(java.lang.String newValue) Set the value that will be returned during submission of a form.

Methods inherited from class com.gargoylesoftware.htmlunit.html.StyledElement

getClassAttribute, getIdAttribute, getStyleAttribute, getTitleAttribute

Methods inherited from class com.gargoylesoftware.htmlunit.html.HtmlElement

addHtmlAttributeChangeListener, appendChildIfNoneExists, cloneDomNode, fireEvent, fireEvent, getAttributeEntriesIterator, getAttributeValue, getChildElementsIterator, getEnclosingElement, getEnclosingForm, getEnclosingFormOrDie, getEventHandler, getHtmlElementById, getHtmlElementsByAttribute, getHtmlElementsByTagName, getHtmlElementsByTagNames, getId, getNodeName, getNodeType, getOneHtmlElementByAttribute, getTagName, hasHtmlElementWithId, isAttributeDefined, keyDown, keyDown, mouseDown, mouseDown, mouseMove, mouseMove, mouseOut, mouseOut, mouseOver, mouseOver, mouseUp, mouseUp, removeAttribute, removeChild, removeEventHandler, removeHtmlAttributeChangeListener, rightClick, rightClick, setAttributeValue, setEventHandler, setEventHandler, setId, toString

Methods inherited from class com.gargoylesoftware.htmlunit.html.DomNamespaceNode

getLocalName, getNamespaceURI, getPrefix, getQualifiedName, setPrefix

Methods inherited from class com.gargoylesoftware.htmlunit.html.DomNode

addDomChangeListener, appendDomChild, asText, asXml, getAllHtmlChildElements, getByXPath, getChildIterator, getEndColumnNumber, getEndLineNumber, getFirstDomChild, getLastDomChild, getNextDomSibling, getNodeValue, getPage, getParentDomNode, getPreviousDomSibling, getReadyState, getScriptObject, getStartColumnNumber, getStartLineNumber, insertBefore, remove, removeAllChildren, removeDomChangeListener, replace, setNodeValue, setReadyState, setScriptObject

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TAG_NAME

public static final java.lang.String TAG_NAME

the HTML tag represented by this element

See Also:

Constant Field Values

Method Detail

getDefaultValue

public java.lang.String getDefaultValue()

Returns the default value to use when this element gets reset, if applicable.

Specified by:

getDefaultValue in interface SubmittableElement

Returns:

the default value to use when this element gets reset, if applicable.

See Also:

SubmittableElement.setDefaultValue(String)

getLangAttribute

public final java.lang.String getLangAttribute()

Return the value of the attribute "lang". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

The value of the attribute "lang" or an empty string if that attribute isn't defined.

getPromptAttribute

public final java.lang.String getPromptAttribute()

Return the value of the attribute "prompt". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

The value of the attribute "prompt" or an empty string if that attribute isn't defined.

getSubmitKeyValuePairs

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

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.

Specified by:

getSubmitKeyValuePairs in interface SubmittableElement

Returns:

See above

getTextDirectionAttribute

public final java.lang.String getTextDirectionAttribute()

Return the value of the attribute "dir". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

The value of the attribute "dir" or an empty string if that attribute isn't defined.

getValue

public java.lang.String getValue()

Return the value that would be send during submission of a form.

Returns:

The value

getXmlLangAttribute

public final java.lang.String getXmlLangAttribute()

Return the value of the attribute "xml:lang". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

The value of the attribute "xml:lang" or an empty string if that attribute isn't defined.

isDefaultChecked

public boolean isDefaultChecked()

Returns the default checked state to use when this element gets reset, if applicable. This implementation returns false; only checkboxes and radio buttons really care what the default checked value is.

Specified by:

isDefaultChecked in interface SubmittableElement

Returns:

The default checked state to use when this element gets reset, if applicable.

See Also:

SubmittableElement.isDefaultChecked(), HtmlRadioButtonInput.isDefaultChecked(), HtmlCheckBoxInput.isDefaultChecked()

reset

public void reset()

Return the value of this element to the default value or checked state (usually what it was at the time the page was loaded, unless it has been modified via JavaScript).

Specified by:

reset in interface SubmittableElement

See Also:

SubmittableElement.reset()

setDefaultChecked

public void setDefaultChecked(boolean defaultChecked)

Sets the default checked state to use when this element gets reset, if applicable. This implementation is empty; only checkboxes and radio buttons really care what the default checked value is.

Specified by:

setDefaultChecked in interface SubmittableElement

Parameters:

defaultChecked - The default checked state to use when this element gets reset, if applicable.

See Also:

SubmittableElement.setDefaultChecked(boolean), HtmlRadioButtonInput.setDefaultChecked(boolean), HtmlCheckBoxInput.setDefaultChecked(boolean)

setDefaultValue

public void setDefaultValue(java.lang.String defaultValue)

Sets the default value to use when this element gets reset, if applicable.

Specified by:

setDefaultValue in interface SubmittableElement

Parameters:

defaultValue - The default value to use when this element gets reset, if applicable.

See Also:

SubmittableElement.setDefaultValue(String)

setValue

public void setValue(java.lang.String newValue)

Set the value that will be returned during submission of a form.

Parameters:

newValue - The value.