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, EventListener, 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

Author:

Timothy Prinzing, Sunita Mani

Nested Class Summary

private class	FormView.BrowseFileAction BrowseFileAction is used for input type == file.
protected class	FormView.MouseEventListener MouseEventListener class to handle form submissions when an input with type equal to image is clicked on.
(package private) class	FormView.SubmitThread The SubmitThread is responsible for submitting the form.

Nested classes inherited from class javax.swing.text.ComponentView

Field Summary

private short	maxIsPreferred Used to indicate if the maximum span should be the same as the preferred span.
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.ComponentView

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.
private void	appendBuffer(StringBuffer buffer, String name, String value) Appends name / value pairs into the buffer.
protected Component	createComponent() Create the component.
private JComponent	createInputComponent(AttributeSet attr, Object model) Creates a component for an <INPUT> element based on the value of the "type" attribute.
(package private) void	getFormData(StringBuffer buffer) Iterates over the element hierarchy, extracting data from the models associated with the relevant form elements.
private Element	getFormElement() Returns the Element representing the FORM.
private String	getImageData(Point point) Extracts the value of the name attribute associated with the input element of type image.
private String	getInputElementData(AttributeSet attr) Returns the data associated with an <INPUT> form element.
float	getMaximumSpan(int axis) Determines the maximum span for this view along an axis.
private String	getTextAreaData(AttributeSet attr) Returns the data associated with the <TEXTAREA> form element.
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".
private boolean	isControl(Element elem) Returns true if the Element elem represents a control.
(package private) boolean	isLastTextOrPasswordField() Iterates over the element hierarchy to determine if the element parameter, which is assumed to be an <INPUT> element of type password or text, is the last one of either kind, in the form to which it belongs.
private void	loadElementDataIntoBuffer(Element elem, StringBuffer buffer) Loads the data associated with the element into the buffer.
private void	loadSelectData(AttributeSet attr, StringBuffer buffer) Loads the buffer with the data associated with the Select form element.
(package private) void	resetForm() Resets the form to its initial state by reinitializing the models associated with each form element to their initial values.
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, paint, setParent, viewToModel

Methods inherited from class javax.swing.text.View

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SUBMIT

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

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.

maxIsPreferred

private short maxIsPreferred

Used to indicate if the maximum span should be the same as the preferred span. This is used so that the Component's size doesn't change if there is extra room on a line. The first bit is used for the X direction, and the second for the y direction.

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 in class ComponentView

createInputComponent

private JComponent createInputComponent(AttributeSet attr,
                                        Object model)

Creates a component for an <INPUT> element based on the value of the "type" attribute.

Parameters:

model - the value of the StyleConstants.ModelAttribute

Returns:

the component.

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.

Throws:

IllegalArgumentException - for an invalid axis

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 in interface ActionListener

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 <INPUT> form element of type "image".

Parameters:

imageData - the mouse click coordinates.

getImageData

private String getImageData(Point point)

Extracts the value of the name attribute associated with the input element of type image. If name is defined it is encoded using the URLEncoder.encode() method and the image data is returned in the following format: name + ".x" +"="+ x +"&"+ name +".y"+"="+ y otherwise, "x="+ x +"&y="+ y

Parameters:

point - associated with the mouse click.

Returns:

the image data.

getFormElement

private Element getFormElement()

Returns the Element representing the FORM.

getFormData

void getFormData(StringBuffer buffer)

Iterates over the element hierarchy, extracting data from the models associated with the relevant form elements. "Relevant" means the form elements that are part of the same form whose element triggered the submit action.

Parameters:

buffer - the buffer that contains that data to submit

loadElementDataIntoBuffer

private void loadElementDataIntoBuffer(Element elem,
                                       StringBuffer buffer)

Loads the data associated with the element into the buffer. The format in which data is appended depends on the type of the form element. Essentially data is loaded in name/value pairs.

getInputElementData

private String getInputElementData(AttributeSet attr)

Returns the data associated with an <INPUT> form element. The value of "type" attributes is used to determine the type of the model associated with the element and then the relevant data is extracted.

getTextAreaData

private String getTextAreaData(AttributeSet attr)

Returns the data associated with the <TEXTAREA> form element. This is done by getting the text stored in the Document model.

loadSelectData

private void loadSelectData(AttributeSet attr,
                            StringBuffer buffer)

Loads the buffer with the data associated with the Select form element. Basically, only items that are selected and have their name attribute set are added to the buffer.

appendBuffer

private void appendBuffer(StringBuffer buffer,
                          String name,
                          String value)

Appends name / value pairs into the buffer. Both names and values are encoded using the URLEncoder.encode() method before being added to the buffer.

isControl

private boolean isControl(Element elem)

Returns true if the Element elem represents a control.

isLastTextOrPasswordField

boolean isLastTextOrPasswordField()

Iterates over the element hierarchy to determine if the element parameter, which is assumed to be an <INPUT> element of type password or text, is the last one of either kind, in the form to which it belongs.

resetForm

void resetForm()

Resets the form to its initial state by reinitializing the models associated with each form element to their initial values. param elem the element that triggered the reset