All Packages Class Hierarchy This Package Previous Next Index
Class com.ibm.as400.util.html.HTMLForm
java.lang.Object
|
+----com.ibm.as400.util.html.HTMLForm
- public class HTMLForm
- extends Object
- implements HTMLTagElement, HTMLConstants, Serializable
The HTMLForm class represents an HTML form.
HTMLForm objects generate the following events:
- ElementEvent - The events fired are:
- elementAdded
- elementRemoved
- PropertyChangeEvent
- VetoableChangeEvent
This examples creates an HTMLForm object and adds some form input types to it.
// Create a text input form element for the system.
LabelFormElement sysPrompt = new LabelFormElement("System:");
TextFormInput system = new TextFormInput("System");
// Create a text input form element for the userId.
LabelFormElement userPrompt = new LabelFormElement("User:");
TextFormInput user = new TextFormInput("User");
// Create a password input form element for the password.
LabelFormElement passwordPrompt = new LabelFormElement("Password:");
PasswordFormInput password = new PasswordFormInput("Password");
// Create a properties object.
Properties prop = new Properties();
// Add customer name and ID values to the properties object.
prop.put("custName", "Mr. Toolbox");
prop.put("custID", "12345");
// Create the submit button to the form.
SubmitFormInput logonButton = new SubmitFormInput("logon", "Logon");
// Create HTMLForm object and add the panel to it.
HTMLForm form = new HTMLForm(servletURI);
form.setHiddenParameterList(prop);
form.addElement(sysPrompt);
form.addElement(system);
form.addElement(userPrompt);
form.addElement(user);
form.addElement(passwordPrompt);
form.addElement(password);
form.addElement(logonButton);
Here is an example of an HTMLForm tag:
<form action="servletURI" method="get">
System: <input type="text" name="System" />
User: <input type="text" name="User" />
Password: <input type="password" name="Password" />
<input type="submit" name="logon" value="Logon" />
<input type="hidden" name="custName" value="Mr. Toolbox" />
<input type="hidden" name="custID" value="12345" />
</form>
-
METHOD_GET
- HTTP GET Method for sending form contents to the server.
-
METHOD_POST
- HTTP POST Method for sending form contents to the server.
-
HTMLForm()
- Constructs a default HTMLForm object.
-
HTMLForm(String)
- Constructs an HTMLForm object with the specified URL.
-
addElement(HTMLTagElement)
- Adds a form element to the HTMLForm.
-
addElementListener(ElementListener)
- Adds an ElementListener.
-
addPropertyChangeListener(PropertyChangeListener)
- Adds a PropertyChangeListener.
-
addVetoableChangeListener(VetoableChangeListener)
- Adds the VetoableChangeListener.
-
getHiddenParameterList()
- Returns the form's hidden parameter list.
-
getMethod()
- Returns the HTTP method used for sending form contents to the server.
-
getTag()
- Returns the HTML form tag.
-
getTarget()
- Returns the target frame for the form response.
-
getURL()
- Returns the ACTION URL address of the server-side form handler.
-
isUseGet()
- Indicates if the GET method is used for sending the form contents to the server.
-
isUsePost()
- Indicates if the POST method is used for sending the form contents to the server.
-
removeElement(HTMLTagElement)
- Removes a form element from the HTMLForm.
-
removeElementListener(ElementListener)
- Removes this ElementListener from the internal list.
-
removePropertyChangeListener(PropertyChangeListener)
- Removes the PropertyChangeListener from the internal list.
-
removeVetoableChangeListener(VetoableChangeListener)
- Removes the VetoableChangeListener from the internal list.
-
setHiddenParameterList(Properties)
- Sets the form's hidden parameter list.
-
setMethod(int)
- Sets the HTTP method used to send form contents to the server.
-
setTarget(String)
- Sets the target frame for the form response.
-
setURL(String)
- Sets the ACTION URL address of the server-side form handler.
-
toString()
- Returns the HTMLForm tag as a String.
METHOD_GET
public static final int METHOD_GET
- HTTP GET Method for sending form contents to the server.
This is the default method used.
METHOD_POST
public static final int METHOD_POST
- HTTP POST Method for sending form contents to the server.
HTMLForm
public HTMLForm()
- Constructs a default HTMLForm object.
HTMLForm
public HTMLForm(String url)
- Constructs an HTMLForm object with the specified URL.
- Parameters:
- url - The URL address.
addElement
public void addElement(HTMLTagElement element)
- Adds a form element to the HTMLForm.
- Parameters:
- element - The form element.
addElementListener
public void addElementListener(ElementListener listener)
- Adds an ElementListener.
The ElementListener object is added to an internal list of ElementListeners;
it can be removed with removeElementListener.
- Parameters:
- listener - The ElementListener.
- See Also:
- removeElementListener
addPropertyChangeListener
public void addPropertyChangeListener(PropertyChangeListener listener)
- Adds a PropertyChangeListener. The specified
PropertyChangeListener's propertyChange
method is called each time the value of any
bound property is changed.
- Parameters:
- listener - The PropertyChangeListener.
- See Also:
- removePropertyChangeListener
addVetoableChangeListener
public void addVetoableChangeListener(VetoableChangeListener listener)
- Adds the VetoableChangeListener. The specified
VetoableChangeListener's vetoableChange
method is called each time the value of any
constrained property is changed.
- Parameters:
- listener - The VetoableChangeListener.
- See Also:
- removeVetoableChangeListener
getHiddenParameterList
public Properties getHiddenParameterList()
- Returns the form's hidden parameter list.
- Returns:
- The parameter list.
getMethod
public int getMethod()
- Returns the HTTP method used for sending form contents to the server.
- Returns:
- The HTTP method.
getTag
public String getTag()
- Returns the HTML form tag.
- Returns:
- The tag.
getTarget
public String getTarget()
- Returns the target frame for the form response.
- Returns:
- The target frame. One of the following constants
defined in HTMLConstants: TARGET_BLANK, TARGET_PARENT,
TARGET_SELF, TARGET_TOP, or a user defined target.
- See Also:
- HTMLConstants
getURL
public String getURL()
- Returns the ACTION URL address of the server-side form handler.
- Returns:
- The URL address.
isUseGet
public boolean isUseGet()
- Indicates if the GET method is used for sending the form contents to the server.
- Returns:
- true if GET is used; false otherwise.
isUsePost
public boolean isUsePost()
- Indicates if the POST method is used for sending the form contents to the server.
- Returns:
- true if POST is used; false otherwise.
removeElement
public void removeElement(HTMLTagElement element)
- Removes a form element from the HTMLForm.
- Parameters:
- element - The form element.
removeElementListener
public void removeElementListener(ElementListener listener)
- Removes this ElementListener from the internal list.
If the ElementListener is not on the list, nothing is done.
- Parameters:
- listener - The ElementListener.
- See Also:
- addElementListener
removePropertyChangeListener
public void removePropertyChangeListener(PropertyChangeListener listener)
- Removes the PropertyChangeListener from the internal list.
If the PropertyChangeListener is not on the list, nothing is done.
- Parameters:
- listener - The PropertyChangeListener.
- See Also:
- addPropertyChangeListener
removeVetoableChangeListener
public void removeVetoableChangeListener(VetoableChangeListener listener)
- Removes the VetoableChangeListener from the internal list.
If the VetoableChangeListener is not on the list, nothing is done.
- Parameters:
- listener - The VetoableChangeListener.
- See Also:
- addVetoableChangeListener
setHiddenParameterList
public void setHiddenParameterList(Properties parameterList) throws PropertyVetoException
- Sets the form's hidden parameter list.
- Parameters:
- parameterList - The parameter list.
- Throws: PropertyVetoException
- If a change is vetoed.
setMethod
public void setMethod(int method) throws PropertyVetoException
- Sets the HTTP method used to send form contents to the server.
- Parameters:
- method - The method.
- Throws: PropertyVetoException
- If a change is vetoed.
setTarget
public void setTarget(String target) throws PropertyVetoException
- Sets the target frame for the form response.
- Parameters:
- target - The target frame. One of the following constants
defined in HTMLConstants: TARGET_BLANK, TARGET_PARENT,
TARGET_SELF, TARGET_TOP, or a user defined target.
- Throws: PropertyVetoException
- If a change is vetoed.
- See Also:
- HTMLConstants
setURL
public void setURL(String url) throws PropertyVetoException
- Sets the ACTION URL address of the server-side form handler.
- Parameters:
- url - The URL address.
- Throws: PropertyVetoException
- If a change is vetoed.
toString
public String toString()
- Returns the HTMLForm tag as a String.
- Returns:
- The tag.
- Overrides:
- toString in class Object
All Packages Class Hierarchy This Package Previous Next Index