FormView (Java 2 Platform SE 5.0) (original) (raw)

javax.swing.text.html

Class FormView

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

All Implemented Interfaces:

ActionListener, EventListener, SwingConstants

public class FormView

Component decorator that implements the view interface for form elements, , . 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 byHTMLDocument.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 Deprecated. As of 1.3, value comes from UIManager UIManager property FormView.resetButtonText
static String	SUBMIT Deprecated. As of 1.3, value now comes from UIManager property FormView.submitButtonText

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

Fields inherited from interface javax.swing.SwingConstants
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

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 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
getAlignment, getComponent, getMinimumSpan, getPreferredSpan, [modelToView](../../../../javax/swing/text/ComponentView.html#modelToView%28int, java.awt.Shape, javax.swing.text.Position.Bias%29), [paint](../../../../javax/swing/text/ComponentView.html#paint%28java.awt.Graphics, java.awt.Shape%29), setParent, [viewToModel](../../../../javax/swing/text/ComponentView.html#viewToModel%28float, float, java.awt.Shape, javax.swing.text.Position.Bias[]%29)

Methods inherited from class javax.swing.text.ComponentView

getAlignment, getComponent, getMinimumSpan, getPreferredSpan, [modelToView](../../../../javax/swing/text/ComponentView.html#modelToView%28int, java.awt.Shape, javax.swing.text.Position.Bias%29), [paint](../../../../javax/swing/text/ComponentView.html#paint%28java.awt.Graphics, java.awt.Shape%29), setParent, [viewToModel](../../../../javax/swing/text/ComponentView.html#viewToModel%28float, float, java.awt.Shape, javax.swing.text.Position.Bias[]%29)

Methods inherited from class javax.swing.text.View
append, [breakView](../../../../javax/swing/text/View.html#breakView%28int, int, float, float%29), [changedUpdate](../../../../javax/swing/text/View.html#changedUpdate%28javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory%29), [createFragment](../../../../javax/swing/text/View.html#createFragment%28int, int%29), [forwardUpdate](../../../../javax/swing/text/View.html#forwardUpdate%28javax.swing.event.DocumentEvent.ElementChange, javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory%29), [forwardUpdateToView](../../../../javax/swing/text/View.html#forwardUpdateToView%28javax.swing.text.View, javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory%29), getAttributes, [getBreakWeight](../../../../javax/swing/text/View.html#getBreakWeight%28int, float, float%29), [getChildAllocation](../../../../javax/swing/text/View.html#getChildAllocation%28int, java.awt.Shape%29), getContainer, getDocument, getElement, getEndOffset, getGraphics, [getNextVisualPositionFrom](../../../../javax/swing/text/View.html#getNextVisualPositionFrom%28int, javax.swing.text.Position.Bias, java.awt.Shape, int, javax.swing.text.Position.Bias[]%29), getParent, getResizeWeight, getStartOffset, [getToolTipText](../../../../javax/swing/text/View.html#getToolTipText%28float, float, java.awt.Shape%29), getView, getViewCount, getViewFactory, [getViewIndex](../../../../javax/swing/text/View.html#getViewIndex%28float, float, java.awt.Shape%29), [getViewIndex](../../../../javax/swing/text/View.html#getViewIndex%28int, javax.swing.text.Position.Bias%29), [insert](../../../../javax/swing/text/View.html#insert%28int, javax.swing.text.View%29), [insertUpdate](../../../../javax/swing/text/View.html#insertUpdate%28javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory%29), isVisible, [modelToView](../../../../javax/swing/text/View.html#modelToView%28int, javax.swing.text.Position.Bias, int, javax.swing.text.Position.Bias, java.awt.Shape%29), [modelToView](../../../../javax/swing/text/View.html#modelToView%28int, java.awt.Shape%29), [preferenceChanged](../../../../javax/swing/text/View.html#preferenceChanged%28javax.swing.text.View, boolean, boolean%29), remove, removeAll, [removeUpdate](../../../../javax/swing/text/View.html#removeUpdate%28javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory%29), [replace](../../../../javax/swing/text/View.html#replace%28int, int, javax.swing.text.View[]%29), [setSize](../../../../javax/swing/text/View.html#setSize%28float, float%29), [updateChildren](../../../../javax/swing/text/View.html#updateChildren%28javax.swing.event.DocumentEvent.ElementChange, javax.swing.event.DocumentEvent, javax.swing.text.ViewFactory%29), [updateLayout](../../../../javax/swing/text/View.html#updateLayout%28javax.swing.event.DocumentEvent.ElementChange, javax.swing.event.DocumentEvent, java.awt.Shape%29), [viewToModel](../../../../javax/swing/text/View.html#viewToModel%28float, float, java.awt.Shape%29)

Methods inherited from class javax.swing.text.View

append, [breakView](../../../../javax/swing/text/View.html#breakView%28int, int, float, float%29), [changedUpdate](../../../../javax/swing/text/View.html#changedUpdate%28javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory%29), [createFragment](../../../../javax/swing/text/View.html#createFragment%28int, int%29), [forwardUpdate](../../../../javax/swing/text/View.html#forwardUpdate%28javax.swing.event.DocumentEvent.ElementChange, javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory%29), [forwardUpdateToView](../../../../javax/swing/text/View.html#forwardUpdateToView%28javax.swing.text.View, javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory%29), getAttributes, [getBreakWeight](../../../../javax/swing/text/View.html#getBreakWeight%28int, float, float%29), [getChildAllocation](../../../../javax/swing/text/View.html#getChildAllocation%28int, java.awt.Shape%29), getContainer, getDocument, getElement, getEndOffset, getGraphics, [getNextVisualPositionFrom](../../../../javax/swing/text/View.html#getNextVisualPositionFrom%28int, javax.swing.text.Position.Bias, java.awt.Shape, int, javax.swing.text.Position.Bias[]%29), getParent, getResizeWeight, getStartOffset, [getToolTipText](../../../../javax/swing/text/View.html#getToolTipText%28float, float, java.awt.Shape%29), getView, getViewCount, getViewFactory, [getViewIndex](../../../../javax/swing/text/View.html#getViewIndex%28float, float, java.awt.Shape%29), [getViewIndex](../../../../javax/swing/text/View.html#getViewIndex%28int, javax.swing.text.Position.Bias%29), [insert](../../../../javax/swing/text/View.html#insert%28int, javax.swing.text.View%29), [insertUpdate](../../../../javax/swing/text/View.html#insertUpdate%28javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory%29), isVisible, [modelToView](../../../../javax/swing/text/View.html#modelToView%28int, javax.swing.text.Position.Bias, int, javax.swing.text.Position.Bias, java.awt.Shape%29), [modelToView](../../../../javax/swing/text/View.html#modelToView%28int, java.awt.Shape%29), [preferenceChanged](../../../../javax/swing/text/View.html#preferenceChanged%28javax.swing.text.View, boolean, boolean%29), remove, removeAll, [removeUpdate](../../../../javax/swing/text/View.html#removeUpdate%28javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory%29), [replace](../../../../javax/swing/text/View.html#replace%28int, int, javax.swing.text.View[]%29), [setSize](../../../../javax/swing/text/View.html#setSize%28float, float%29), [updateChildren](../../../../javax/swing/text/View.html#updateChildren%28javax.swing.event.DocumentEvent.ElementChange, javax.swing.event.DocumentEvent, javax.swing.text.ViewFactory%29), [updateLayout](../../../../javax/swing/text/View.html#updateLayout%28javax.swing.event.DocumentEvent.ElementChange, javax.swing.event.DocumentEvent, java.awt.Shape%29), [viewToModel](../../../../javax/swing/text/View.html#viewToModel%28float, float, java.awt.Shape%29)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, [wait](../../../../java/lang/Object.html#wait%28long, int%29)

Field Detail

SUBMIT

@Deprecated public static final String SUBMIT

Deprecated. As of 1.3, value now comes from UIManager property FormView.submitButtonText

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

RESET

@Deprecated public static final String RESET

Deprecated. As of 1.3, value comes from UIManager UIManager property FormView.resetButtonText

If a value attribute is not specified for a FORM input element of type "reset", 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

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](../../../../javax/swing/text/ComponentView.html#createComponent%28%29) in class [ComponentView](../../../../javax/swing/text/ComponentView.html "class in javax.swing.text")

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](../../../../javax/swing/text/ComponentView.html#getMaximumSpan%28int%29) in class [ComponentView](../../../../javax/swing/text/ComponentView.html "class in javax.swing.text")

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.

Throws:

[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang") - for an invalid axis

See Also:

View.getPreferredSpan(int)

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.

Specified by:

[actionPerformed](../../../../java/awt/event/ActionListener.html#actionPerformed%28java.awt.event.ActionEvent%29) in interface [ActionListener](../../../../java/awt/event/ActionListener.html "interface in java.awt.event")

Parameters:

evt - the ActionEvent.

submitData

protected void submitData(String data)

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

imageSubmit

protected void imageSubmit(String imageData)

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

Parameters:

imageData - the mouse click coordinates.

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.