org.apache.ecs.html
Class Form

java.lang.Object
  |
  +--org.apache.ecs.GenericElement
        |
        +--org.apache.ecs.ElementAttributes
              |
              +--org.apache.ecs.ConcreteElement
                    |
                    +--org.apache.ecs.MultiPartElement
                          |
                          +--org.apache.ecs.html.Form

All Implemented Interfaces:

Attributes, java.lang.Cloneable, Element, ElementRegistry, FormEvents, KeyEvents, MouseEvents, Printable, java.io.Serializable

public class Form

extends MultiPartElement

implements Printable, FormEvents, MouseEvents, KeyEvents

This class creates a <FORM> tag.

Version:

$Id: Form.java,v 1.5 2003/04/27 09:21:50 rdonkin Exp $

Author:

Stephan Nagy, Jon S. Stevens

See Also:

Serialized Form

Field Summary

static java.lang.String	ENC_DEFAULT
static java.lang.String	ENC_UPLOAD
static java.lang.String	get
static java.lang.String	GET
static java.lang.String	post
static java.lang.String	POST

Fields inherited from class org.apache.ecs.ConcreteElement

lineSeparator, registry, registryList

Fields inherited from class org.apache.ecs.ElementAttributes

attribute_equality_sign, attribute_filter, attribute_quote, attribute_quote_char, filter_attribute_state

Fields inherited from class org.apache.ecs.GenericElement

__text, _defaultFilter, begin_end_modifier, begin_end_modifier_defined, begin_start_modifier, begin_start_modifier_defined, case_type, codeset, element, element_type, end_element, end_end_modifier, end_end_modifier_defined, end_modifier_defined, end_start_modifier, end_start_modifier_defined, end_tag, filter, filter_state, position, pretty_print, start_modifier_defined, start_tag, tabLevel, VERSION

Fields inherited from interface org.apache.ecs.Attributes

NO_ATTRIBUTE_VALUE

Fields inherited from interface org.apache.ecs.Element

CENTER, LEFT, LOWERCASE, MIXEDCASE, RIGHT, UPPERCASE

Constructor Summary

Form()
Basic constructor.

Form(Element element)
Use the set* methods to set the values of the attributes.

Form(java.lang.String action)
Use the set* methods to set the values of the attributes.

Form(java.lang.String action, Element element)
Use the set* methods to set the values of the attributes.

Form(java.lang.String action, java.lang.String method)
Use the set* methods to set the values of the attributes.

Form(java.lang.String action, java.lang.String method, Element element)
Use the set* methods to set the values of the attributes.

Form(java.lang.String action, java.lang.String method, java.lang.String enctype)
Use the set* methods to set the values of the attributes.

Method Summary

(package private) void	() Private initialization routine.
Form	addElement(Element element) Adds an Element to the element.
Form	addElement(java.lang.String element) Adds an Element to the element.
Form	addElement(java.lang.String hashcode, Element element) Adds an Element to the element.
Form	addElement(java.lang.String hashcode, java.lang.String element) Adds an Element to the element.
Form	removeElement(java.lang.String hashcode) Removes an Element from the element.
Form	setAccept(java.lang.String accept) Sets the ACCEPT="" attribute
Form	setAcceptCharset(java.lang.String acceptcharset) Sets the ACCEPT-CHARSET="" attribute
Form	setAction(java.lang.String action) Sets the ACTION="" attribute
Form	setEncType(java.lang.String enctype) Sets the ENCTYPE="" attribute
Form	setMethod(java.lang.String method) Sets the METHOD="" attribute
Form	setName(java.lang.String name) Sets the NAME="" attribute
void	setOnChange(java.lang.String script) The onchange event occurs when a control loses the input focus and its value has been modified since gaining focus.
void	setOnClick(java.lang.String script) The onclick event occurs when the pointing device button is clicked over an element.
void	setOnDblClick(java.lang.String script) The ondblclick event occurs when the pointing device button is double clicked over an element.
void	setOnKeyDown(java.lang.String script) The onkeydown event occurs when a key is pressed down over an element.
void	setOnKeyPress(java.lang.String script) The onkeypress event occurs when a key is pressed and released over an element.
void	setOnKeyUp(java.lang.String script) The onkeyup event occurs when a key is released over an element.
void	setOnMouseDown(java.lang.String script) The onmousedown event occurs when the pointing device button is pressed over an element.
void	setOnMouseMove(java.lang.String script) The onmousemove event occurs when the pointing device is moved while it is over an element.
void	setOnMouseOut(java.lang.String script) The onmouseout event occurs when the pointing device is moved away from an element.
void	setOnMouseOver(java.lang.String script) The onmouseover event occurs when the pointing device is moved onto an element.
void	setOnMouseUp(java.lang.String script) The onmouseup event occurs when the pointing device button is released over an element.
void	setOnReset(java.lang.String script) The onreset event occurs when a form is reset.
void	setOnSelect(java.lang.String script) The onselect event occurs when a user selects some text in a text field.
void	setOnSubmit(java.lang.String script) The onsubmit event occurs when a form is submitted.
Form	setTarget(java.lang.String target) Sets the TARGET="" attribute

Methods inherited from class org.apache.ecs.ConcreteElement

addElementToRegistry, addElementToRegistry, addElementToRegistry, addElementToRegistry, addElementToRegistry, addElementToRegistry, addElementToRegistry, addElementToRegistry, clone, elements, getElement, isEmpty, keys, output, output, output, output, registryHasElement, registryHasElement, removeElementFromRegistry, removeElementFromRegistry

Methods inherited from class org.apache.ecs.ElementAttributes

addAttribute, addAttribute, addAttribute, addAttribute, attributes, createStartTag, getAttribute, getAttributeEqualitySign, getAttributeFilter, getAttributeFilterState, getAttributeQuote, getAttributeQuoteChar, hasAttribute, removeAttribute, setAttributeEqualitySign, setAttributeFilter, setAttributeFilterState, setAttributeQuote, setAttributeQuoteChar, setClass, setDir, setID, setLang, setStyle, setTitle

Methods inherited from class org.apache.ecs.GenericElement

alterCase, createEndTag, getBeginEndModifier, getBeginEndModifierDefined, getBeginStartModifier, getBeginStartModifierDefined, getCase, getCodeSet, getElementHashEntry, getElementType, getEndEndModifier, getEndEndModifierDefined, getEndStartModifier, getEndStartModifierDefined, getEndTagChar, getFilter, getFilterState, getNeedClosingTag, getNeedLineBreak, getPrettyPrint, getStartTagChar, getTabLevel, getTagPosition, getTagText, getVersion, putTabs, putTabs, removeBeginEndModifier, removeBeginStartModifier, removeEndEndModifier, removeEndStartModifier, setBeginEndModifier, setBeginEndModifierDefined, setBeginModifier, setBeginModifier, setBeginStartModifier, setBeginStartModifierDefined, setCase, setCodeSet, setElementType, setEndEndModifier, setEndEndModifierDefined, setEndModifier, setEndModifier, setEndStartModifier, setEndStartModifierDefined, setEndTagChar, setFilter, setFilterState, setNeedClosingTag, setPrettyPrint, setStartTagChar, setTabLevel, setTagPosition, setTagText, toString, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait

Field Detail

GET

public static final java.lang.String GET

get

public static final java.lang.String get

POST

public static final java.lang.String POST

post

public static final java.lang.String post

ENC_DEFAULT

public static final java.lang.String ENC_DEFAULT

ENC_UPLOAD

public static final java.lang.String ENC_UPLOAD

Constructor Detail

Form

public Form()

Basic constructor. You need to set the attributes using the set* methods.

Form

public Form(Element element)

Use the set* methods to set the values of the attributes.

Parameters:

element - set the value of <FORM>value</FORM>

Form

public Form(java.lang.String action)

Use the set* methods to set the values of the attributes.

Parameters:

action - set the value of ACTION=""

Form

public Form(java.lang.String action,
            Element element)

Use the set* methods to set the values of the attributes.

Parameters:

element - set the value of <FORM>value</FORM>

action - set the value of ACTION=""

Form

public Form(java.lang.String action,
            java.lang.String method,
            Element element)

Use the set* methods to set the values of the attributes.

Parameters:

action - set the value of ACTION=""

method - set the value of METHOD=""

element - set the value of <FORM>value</FORM>

Form

public Form(java.lang.String action,
            java.lang.String method)

Use the set* methods to set the values of the attributes.

Parameters:

action - set the value of ACTION=""

method - set the value of METHOD=""

Form

public Form(java.lang.String action,
            java.lang.String method,
            java.lang.String enctype)

Use the set* methods to set the values of the attributes.

Parameters:

action - set the value of ACTION=""

method - set the value of METHOD=""

enctype - set the value of ENCTYPE=""

Method Detail

void ()

Private initialization routine.

Overrides:

in class MultiPartElement

setAction

public Form setAction(java.lang.String action)

Sets the ACTION="" attribute

Parameters:

action - the ACTION="" attribute

setMethod

public Form setMethod(java.lang.String method)

Sets the METHOD="" attribute

Parameters:

method - the METHOD="" attribute

setEncType

public Form setEncType(java.lang.String enctype)

Sets the ENCTYPE="" attribute

Parameters:

enctype - the ENCTYPE="" attribute

setAccept

public Form setAccept(java.lang.String accept)

Sets the ACCEPT="" attribute

Parameters:

accept - the ACCEPT="" attribute

setName

public Form setName(java.lang.String name)

Sets the NAME="" attribute

Parameters:

name - the NAME="" attribute

setTarget

public Form setTarget(java.lang.String target)

Sets the TARGET="" attribute

Parameters:

target - the TARGET="" attribute

setAcceptCharset

public Form setAcceptCharset(java.lang.String acceptcharset)

Sets the ACCEPT-CHARSET="" attribute

Parameters:

accept - the ACCEPT-CHARSET="" attribute

addElement

public Form addElement(java.lang.String hashcode,
                       Element element)

Adds an Element to the element.

Parameters:

hashcode - name of element for hash table

element - Adds an Element to the element.

addElement

public Form addElement(java.lang.String hashcode,
                       java.lang.String element)

Adds an Element to the element.

Parameters:

hashcode - name of element for hash table

element - Adds an Element to the element.

addElement

public Form addElement(Element element)

Adds an Element to the element.

Parameters:

element - Adds an Element to the element.

addElement

public Form addElement(java.lang.String element)

Adds an Element to the element.

Parameters:

element - Adds an Element to the element.

removeElement

public Form removeElement(java.lang.String hashcode)

Removes an Element from the element.

Parameters:

hashcode - the name of the element to be removed.

setOnSubmit

public void setOnSubmit(java.lang.String script)

The onsubmit event occurs when a form is submitted. It only applies to the FORM element.

Specified by:

setOnSubmit in interface FormEvents

Parameters:

The - script

setOnReset

public void setOnReset(java.lang.String script)

The onreset event occurs when a form is reset. It only applies to the FORM element.

Specified by:

setOnReset in interface FormEvents

Parameters:

The - script

setOnSelect

public void setOnSelect(java.lang.String script)

The onselect event occurs when a user selects some text in a text field. This attribute may be used with the INPUT and TEXTAREA elements.

Specified by:

setOnSelect in interface FormEvents

Parameters:

The - script

setOnChange

public void setOnChange(java.lang.String script)

The onchange event occurs when a control loses the input focus and its value has been modified since gaining focus. This attribute applies to the following elements: INPUT, SELECT, and TEXTAREA.

Specified by:

setOnChange in interface FormEvents

Parameters:

The - script

setOnClick

public void setOnClick(java.lang.String script)

The onclick event occurs when the pointing device button is clicked over an element. This attribute may be used with most elements.

Specified by:

setOnClick in interface MouseEvents

Parameters:

The - script

setOnDblClick

public void setOnDblClick(java.lang.String script)

The ondblclick event occurs when the pointing device button is double clicked over an element. This attribute may be used with most elements.

Specified by:

setOnDblClick in interface MouseEvents

Parameters:

The - script

setOnMouseDown

public void setOnMouseDown(java.lang.String script)

The onmousedown event occurs when the pointing device button is pressed over an element. This attribute may be used with most elements.

Specified by:

setOnMouseDown in interface MouseEvents

Parameters:

The - script

setOnMouseUp

public void setOnMouseUp(java.lang.String script)

The onmouseup event occurs when the pointing device button is released over an element. This attribute may be used with most elements.

Specified by:

setOnMouseUp in interface MouseEvents

Parameters:

The - script

setOnMouseOver

public void setOnMouseOver(java.lang.String script)

The onmouseover event occurs when the pointing device is moved onto an element. This attribute may be used with most elements.

Specified by:

setOnMouseOver in interface MouseEvents

Parameters:

The - script

setOnMouseMove

public void setOnMouseMove(java.lang.String script)

The onmousemove event occurs when the pointing device is moved while it is over an element. This attribute may be used with most elements.

Specified by:

setOnMouseMove in interface MouseEvents

Parameters:

The - script

setOnMouseOut

public void setOnMouseOut(java.lang.String script)

The onmouseout event occurs when the pointing device is moved away from an element. This attribute may be used with most elements.

Specified by:

setOnMouseOut in interface MouseEvents

Parameters:

The - script

setOnKeyPress

public void setOnKeyPress(java.lang.String script)

The onkeypress event occurs when a key is pressed and released over an element. This attribute may be used with most elements.

Specified by:

setOnKeyPress in interface KeyEvents

Parameters:

The - script

setOnKeyDown

public void setOnKeyDown(java.lang.String script)

The onkeydown event occurs when a key is pressed down over an element. This attribute may be used with most elements.

Specified by:

setOnKeyDown in interface KeyEvents

Parameters:

The - script

setOnKeyUp

public void setOnKeyUp(java.lang.String script)

The onkeyup event occurs when a key is released over an element. This attribute may be used with most elements.

Specified by:

setOnKeyUp in interface KeyEvents

Parameters:

The - script