com.ibm.as400.util.html
Class ButtonFormInput

java.lang.Object
  extended by com.ibm.as400.util.html.HTMLTagAttributes
      extended by com.ibm.as400.util.html.FormInput
          extended by com.ibm.as400.util.html.ButtonFormInput
All Implemented Interfaces:
HTMLTagElement, Serializable

public class ButtonFormInput
extends FormInput

The ButtonFormInput class represents a button input type in an HTML form. The trailing slash "/" on the ButtonFormInput tag allows it to conform to the XHTML specification.

Here is an example of a ButtonFormInput tag calling a javascript defined within a HTML page:
<input type="button" name="button1" value="Press Me" onclick="test()" />

Here is a sample javascript which displays an alert box with the specified message:

  <head>
  <script language="javascript">
     function test()
     {
        alert("This is a sample script executed with a ButtonFormInput.")
     }
  </script>
  </head>
  

ButtonFormInput objects generate the following events:

See Also:
Serialized Form

Constructor Summary
Constructor and Description
ButtonFormInput()
          Constructs a default ButtonFormInput object.
ButtonFormInput(String name)
          Constructs a ButtonFormInput object with the specified control name.
ButtonFormInput(String name, String value)
          Constructs a ButtonFormInput object with the specified control name and viewable text value of the button.
ButtonFormInput(String name, String value, String action)
          Constructs a ButtonFormInput object with the specified control name, viewable text value of the button, and the action to perform when the button is pressed.
 
Method Summary
Modifier and Type Method and Description
 String getAction()
          Returns the action being performed by the button.
 String getFOTag()
          Returns a comment tag.
 String getTag()
          Returns the tag for the button form input type.
 void setAction(String action)
          Sets the action to perform when the button is clicked.
 
Methods inherited from class com.ibm.as400.util.html.FormInput
addVetoableChangeListener, getDirection, getLanguage, getName, getSize, getValue, removeVetoableChangeListener, setDirection, setLanguage, setName, setSize, setValue, toString
 
Methods inherited from class com.ibm.as400.util.html.HTMLTagAttributes
addPropertyChangeListener, getAttributes, getAttributeString, removePropertyChangeListener, setAttributes
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ButtonFormInput

public ButtonFormInput()
Constructs a default ButtonFormInput object.


ButtonFormInput

public ButtonFormInput(String name)
Constructs a ButtonFormInput object with the specified control name.

Parameters:
name - The control name of the input field.

ButtonFormInput

public ButtonFormInput(String name,
                       String value)
Constructs a ButtonFormInput object with the specified control name and viewable text value of the button.

Parameters:
name - The control name of the input field.
value - The viewable text value of the button.

ButtonFormInput

public ButtonFormInput(String name,
                       String value,
                       String action)
Constructs a ButtonFormInput object with the specified control name, viewable text value of the button, and the action to perform when the button is pressed.

Parameters:
name - The control name of the input field.
value - The viewable text value of the button.
action - The script to execute.
Method Detail

getAction

public String getAction()
Returns the action being performed by the button.

Returns:
The script being executed.

getFOTag

public String getFOTag()
Returns a comment tag. This method should not be called. There is no XSL-FO support for this class.

Returns:
The comment tag.

getTag

public String getTag()
Returns the tag for the button form input type.

Returns:
The tag.

setAction

public void setAction(String action)
               throws PropertyVetoException
Sets the action to perform when the button is clicked. Buttons have no default behavior. Each button may have client-side scripts associated with the element's event attributes. When an event occurs (the user presses the button), the associated script is triggered.

Parameters:
action - The script to execute.
Throws:
PropertyVetoException - If a change is vetoed.