Class FormView
java.lang.Object
javax.swing.text.View
javax.swing.text.ComponentView
javax.swing.text.html.FormView
- All Implemented Interfaces:
ActionListener, EventListener, SwingConstants
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 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
Nested ClassesModifier and TypeClassDescriptionprotected class
MouseEventListener class to handle form submissions when an input with type equal to image is clicked on. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Deprecated.As of 1.3, value comes from UIManager UIManager property FormView.resetButtonTextstatic final String
Deprecated.As of 1.3, value now comes from UIManager property FormView.submitButtonTextFields declared in class View
BadBreakWeight, ExcellentBreakWeight, ForcedBreakWeight, GoodBreakWeight, X_AXIS, Y_AXIS
Modifier and TypeFieldDescriptionstatic final int
The weight to indicate a view is a bad break opportunity for the purpose of formatting.static final int
The weight to indicate a view supports breaking, and this represents a very attractive place to break.static final int
The weight to indicate a view supports breaking, and must be broken to be represented properly when placed in a view that formats its children by breaking them.static final int
The weight to indicate a view supports breaking, but better opportunities probably exist.static final int
Axis for format/break operations.static final int
Axis for format/break operations.Fields declared in interface SwingConstants
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST
Modifier and TypeFieldDescriptionstatic final int
Box-orientation constant used to specify the bottom of a box.static final int
The central position in an area.static final int
Compass-direction east (right).static final int
Horizontal orientation.static final int
Identifies the leading edge of text for use with left-to-right and right-to-left languages.static final int
Box-orientation constant used to specify the left side of a box.static final int
Identifies the next direction in a sequence.static final int
Compass-direction North (up).static final int
Compass-direction north-east (upper right).static final int
Compass-direction north west (upper left).static final int
Identifies the previous direction in a sequence.static final int
Box-orientation constant used to specify the right side of a box.static final int
Compass-direction south (down).static final int
Compass-direction south-east (lower right).static final int
Compass-direction south-west (lower left).static final int
Box-orientation constant used to specify the top of a box.static final int
Identifies the trailing edge of text for use with left-to-right and right-to-left languages.static final int
Vertical orientation.static final int
Compass-direction west (left). -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Responsible for processing the ActionEvent.protected Component
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 declared in class ComponentView
getAlignment, getComponent, getMinimumSpan, getPreferredSpan, modelToView, paint, setParent, viewToModel
Modifier and TypeMethodDescriptionfloat
getAlignment
(int axis) Determines the desired alignment for this view along an axis.final Component
Fetch the component associated with the view.float
getMinimumSpan
(int axis) Determines the minimum span for this view along an axis.float
getPreferredSpan
(int axis) Determines the preferred span for this view along an axis.modelToView
(int pos, Shape a, Position.Bias b) Provides a mapping from the coordinate space of the model to that of the view.void
The real paint behavior occurs naturally from the association that the component has with its parent container (the same container hosting this view).void
Sets the parent for a child view.int
viewToModel
(float x, float y, Shape a, Position.Bias[] bias) Provides a mapping from the view coordinate space to the logical coordinate space of the model.Methods declared in class 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
Modifier and TypeMethodDescriptionvoid
Appends a single child view.breakView
(int axis, int offset, float pos, float len) Tries to break this view on the given axis.void
changedUpdate
(DocumentEvent e, Shape a, ViewFactory f) Gives notification from the document that attributes were changed in a location that this view is responsible for.createFragment
(int p0, int p1) Creates a view that represents a portion of the element.protected void
Forwards the givenDocumentEvent
to the child views that need to be notified of the change to the model.protected void
forwardUpdateToView
(View v, DocumentEvent e, Shape a, ViewFactory f) Forwards theDocumentEvent
to the give child view.Fetches the attributes to use when rendering.int
getBreakWeight
(int axis, float pos, float len) Determines how attractive a break opportunity in this view is.getChildAllocation
(int index, Shape a) Fetches the allocation for the given child view.Fetches the container hosting the view.Fetches the model associated with the view.Fetches the structural portion of the subject that this view is mapped to.int
Fetches the portion of the model for which this view is responsible.Fetch aGraphics
for rendering.int
getNextVisualPositionFrom
(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) Provides a way to determine the next visually represented model location at which one might place a caret.Returns the parent of the view.int
getResizeWeight
(int axis) Determines the resizability of the view along the given axis.int
Fetches the portion of the model for which this view is responsible.getToolTipText
(float x, float y, Shape allocation) Returns the tooltip text at the specified location.getView
(int n) Gets the nth child view.int
Returns the number of views in this view.Fetches theViewFactory
implementation that is feeding the view hierarchy.int
getViewIndex
(float x, float y, Shape allocation) Returns the child view index representing the given position in the view.int
getViewIndex
(int pos, Position.Bias b) Returns the child view index representing the given position in the model.void
Inserts a single child view.void
insertUpdate
(DocumentEvent e, Shape a, ViewFactory f) Gives notification that something was inserted into the document in a location that this view is responsible for.boolean
Returns a boolean that indicates whether the view is visible or not.modelToView
(int pos, Shape a) Deprecated.modelToView
(int p0, Position.Bias b0, int p1, Position.Bias b1, Shape a) Provides a mapping, for a given region, from the document model coordinate space to the view coordinate space.void
preferenceChanged
(View child, boolean width, boolean height) Child views can call this on the parent to indicate that the preference has changed and should be reconsidered for layout.void
remove
(int i) Removes one of the children at the given position.void
Removes all of the children.void
removeUpdate
(DocumentEvent e, Shape a, ViewFactory f) Gives notification that something was removed from the document in a location that this view is responsible for.void
Replaces child views.void
setSize
(float width, float height) Sets the size of the view.protected boolean
Updates the child views in response to receiving notification that the model changed, and there is change record for the element this view is responsible for.protected void
Updates the layout in response to receiving notification of change from the model.int
viewToModel
(float x, float y, Shape a) Deprecated.Methods declared in class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Modifier and TypeMethodDescriptionprotected Object
clone()
Creates and returns a copy of this object.boolean
Indicates whether some other object is "equal to" this one.protected void
finalize()
Deprecated, for removal: This API element is subject to removal in a future version.Finalization is deprecated and subject to removal in a future release.final Class
<?> getClass()
Returns the runtime class of thisObject
.int
hashCode()
Returns a hash code value for this object.final void
notify()
Wakes up a single thread that is waiting on this object's monitor.final void
Wakes up all threads that are waiting on this object's monitor.toString()
Returns a string representation of the object.final void
wait()
Causes the current thread to wait until it is awakened, typically by being notified or interrupted.final void
wait
(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.final void
wait
(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
-
Field Details
-
SUBMIT
Deprecated.As of 1.3, value now comes from UIManager property FormView.submitButtonTextIf a value attribute is not specified for a FORM input element of type "submit", then this default string is used. -
RESET
Deprecated.As of 1.3, value comes from UIManager UIManager property FormView.resetButtonTextIf a value attribute is not specified for a FORM input element of type "reset", then this default string is used.
-
-
Constructor Details
-
FormView
Creates a new FormView object.- Parameters:
elem
- the element to decorate
-
-
Method Details
-
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 classComponentView
- Returns:
- the component that is associated with this view
-
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 classComponentView
- 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- See Also:
-
actionPerformed
Responsible for processing 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 interfaceActionListener
- Parameters:
evt
- the ActionEvent.
-
submitData
This method is responsible for submitting the form data. A thread is forked to undertake the submission.- Parameters:
data
- data to submit
-
imageSubmit
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.
-