FormView (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.swing.text.html
class FormView

java.lang.Object
  javax.swing.text.View
      javax.swing.text.ComponentView
          javax.swing.text.html.FormView

All Implemented Interfaces:: ActionListener, SwingConstants

public class FormView
extends ComponentView
implements ActionListener

Component decorator that implements the view interface for form elements, <input>, <textarea>, and <select>. The model for the component is stored as an attribute of the the element (using StyleConstants.ModelAttribute), and is used to build the component of the view. The type of the model is assumed to of the type that would be set by HTMLDocument.HTMLReader.FormAction. If there are multiple views mapped over the document, they will share the embedded component models.

The following table shows what components get built by this view.

Element Type	Component built
input, type button	JButton
input, type checkbox	JCheckBox
input, type image	JButton
input, type password	JPasswordField
input, type radio	JRadioButton
input, type reset	JButton
input, type submit	JButton
input, type text	JTextField
select, size > 1 or multiple attribute defined	JList in a JScrollPane
select, size unspecified or 1	JComboBox
textarea	JTextArea in a JScrollPane
input, type file	JTextField

Nested Class Summary
`protected class`	`FormView.MouseEventListener` MouseEventListener class to handle form submissions when an input with type equal to image is clicked on.

Field Summary
`static String`	`RESET` If a value attribute is not specified for a FORM input element of type "reset", then this default string is used.
`static String`	`SUBMIT` If a value attribute is not specified for a FORM input element of type "submit", then this default string is used.

Fields inherited from class javax.swing.text.View
`BadBreakWeight, ExcellentBreakWeight, ForcedBreakWeight, GoodBreakWeight, X_AXIS, Y_AXIS`

Constructor Summary
`FormView(Element elem)` Creates a new FormView object.

Method Summary
`void`	`actionPerformed(ActionEvent evt)` Responsible for processeing the ActionEvent.
`protected Component`	`createComponent()` Create the component.
`float`	`getMaximumSpan(int axis)` Determines the maximum span for this view along an axis.
`protected void`	`imageSubmit(String imageData)` This method is called to submit a form in response to a click on an image -- an <INPUT> form element of type "image".
`protected void`	`submitData(String data)` This method is responsible for submitting the form data.

Methods inherited from class javax.swing.text.ComponentView
`createComponent, getAlignment, getComponent, getMaximumSpan, getMinimumSpan, getPreferredSpan, modelToView, paint, setParent, viewToModel`

Methods inherited from class javax.swing.text.View
append, breakView, changedUpdate, createFragment, forwardUpdate, forwardUpdateToView, getAlignment, getAttributes, getBreakWeight, getChildAllocation, getContainer, getDocument, getElement, getEndOffset, getGraphics, getMaximumSpan, getMinimumSpan, getNextVisualPositionFrom, getParent, getPreferredSpan, getResizeWeight, getStartOffset, getToolTipText, getView, getViewCount, getViewFactory, getViewIndex, getViewIndex, insert, insertUpdate, isVisible, modelToView, modelToView, modelToView, paint, preferenceChanged, remove, removeAll, removeUpdate, replace, setParent, setSize, updateChildren, updateLayout, viewToModel, viewToModel

Methods inherited from class javax.swing.text.View


append, breakView, changedUpdate, createFragment, forwardUpdate, forwardUpdateToView, getAlignment, getAttributes, getBreakWeight, getChildAllocation, getContainer, getDocument, getElement, getEndOffset, getGraphics, getMaximumSpan, getMinimumSpan, getNextVisualPositionFrom, getParent, getPreferredSpan, getResizeWeight, getStartOffset, getToolTipText, getView, getViewCount, getViewFactory, getViewIndex, getViewIndex, insert, insertUpdate, isVisible, modelToView, modelToView, modelToView, paint, preferenceChanged, remove, removeAll, removeUpdate, replace, setParent, setSize, updateChildren, updateLayout, viewToModel, viewToModel

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

RESET

public static final String RESET

If a value attribute is not specified for a FORM input element of type "reset", then this default string is used.

SUBMIT

public static final String SUBMIT

If a value attribute is not specified for a FORM input element of type "submit", then this default string is used.

Constructor Detail

FormView

public FormView(Element elem)

Creates a new FormView object.

Parameters:: elem - the element to decorate

Method Detail

actionPerformed

public void actionPerformed(ActionEvent evt)

Responsible for processeing the ActionEvent. If the element associated with the FormView, has a type of "submit", "reset", "text" or "password" then the action is processed. In the case of a "submit" the form is submitted. In the case of a "reset" the form is reset to its original state. In the case of "text" or "password", if the element is the last one of type "text" or "password", the form is submitted. Otherwise, focus is transferred to the next component in the form.

Parameters:: evt - the ActionEvent.

createComponent

protected Component createComponent()

Create the component. This is basically a big switch statement based upon the tag type and html attributes of the associated element.

Overrides:: createComponent in class ComponentView

getMaximumSpan

public float getMaximumSpan(int axis)

Determines the maximum span for this view along an axis. For certain components, the maximum and preferred span are the same. For others this will return the value returned by Component.getMaximumSize along the axis of interest.

Overrides:: getMaximumSpan in class ComponentView
Parameters:: axis - may be either View.X_AXIS or View.Y_AXIS
Returns:: the span the view would like to be rendered into >= 0. Typically the view is told to render into the span that is returned, although there is no guarantee. The parent may choose to resize or break the view.

imageSubmit

protected void imageSubmit(String imageData)

This method is called to submit a form in response to a click on an image -- an <INPUT> form element of type "image".

Parameters:: imageData - the mouse click coordinates.

submitData

protected void submitData(String data)

This method is responsible for submitting the form data. A thread is forked to undertake the submission.

Parameters:: data