FieldView (Java Platform SE 8 ) (original) (raw)

java.lang.Object
- javax.swing.text.View
- - javax.swing.text.PlainView
    - - javax.swing.text.FieldView
All Implemented Interfaces:
SwingConstants, TabExpander
Direct Known Subclasses:
PasswordView

public class FieldView
extends PlainView
Extends the multi-line plain text view to be suitable for a single-line editor view. If the view is allocated extra space, the field must adjust for it. If the hosting component is a JTextField, this view will manage the ranges of the associated BoundedRangeModel and will adjust the horizontal allocation to match the current visibility settings of the JTextField.
See Also:
View

Field Summary

 * ### Fields inherited from class javax.swing.text.[PlainView](../../../javax/swing/text/PlainView.html "class in javax.swing.text")  
 `[metrics](../../../javax/swing/text/PlainView.html#metrics)`  
 * ### Fields inherited from class javax.swing.text.[View](../../../javax/swing/text/View.html "class in javax.swing.text")  
 `[BadBreakWeight](../../../javax/swing/text/View.html#BadBreakWeight), [ExcellentBreakWeight](../../../javax/swing/text/View.html#ExcellentBreakWeight), [ForcedBreakWeight](../../../javax/swing/text/View.html#ForcedBreakWeight), [GoodBreakWeight](../../../javax/swing/text/View.html#GoodBreakWeight), [X_AXIS](../../../javax/swing/text/View.html#X%5FAXIS), [Y_AXIS](../../../javax/swing/text/View.html#Y%5FAXIS)`  
 * ### Fields inherited from interface javax.swing.[SwingConstants](../../../javax/swing/SwingConstants.html "interface in javax.swing")  
 `[BOTTOM](../../../javax/swing/SwingConstants.html#BOTTOM), [CENTER](../../../javax/swing/SwingConstants.html#CENTER), [EAST](../../../javax/swing/SwingConstants.html#EAST), [HORIZONTAL](../../../javax/swing/SwingConstants.html#HORIZONTAL), [LEADING](../../../javax/swing/SwingConstants.html#LEADING), [LEFT](../../../javax/swing/SwingConstants.html#LEFT), [NEXT](../../../javax/swing/SwingConstants.html#NEXT), [NORTH](../../../javax/swing/SwingConstants.html#NORTH), [NORTH_EAST](../../../javax/swing/SwingConstants.html#NORTH%5FEAST), [NORTH_WEST](../../../javax/swing/SwingConstants.html#NORTH%5FWEST), [PREVIOUS](../../../javax/swing/SwingConstants.html#PREVIOUS), [RIGHT](../../../javax/swing/SwingConstants.html#RIGHT), [SOUTH](../../../javax/swing/SwingConstants.html#SOUTH), [SOUTH_EAST](../../../javax/swing/SwingConstants.html#SOUTH%5FEAST), [SOUTH_WEST](../../../javax/swing/SwingConstants.html#SOUTH%5FWEST), [TOP](../../../javax/swing/SwingConstants.html#TOP), [TRAILING](../../../javax/swing/SwingConstants.html#TRAILING), [VERTICAL](../../../javax/swing/SwingConstants.html#VERTICAL), [WEST](../../../javax/swing/SwingConstants.html#WEST)`

Constructor Summary

Constructors

Constructor	Description
FieldView(Element elem)	Constructs a new FieldView wrapped on an element.

Method Summary

All Methods Instance Methods Concrete Methods

Modifier and Type	Method	Description
protected Shape	adjustAllocation(Shape a)	Adjusts the allocation given to the view to be a suitable allocation for a text field.
protected FontMetrics	getFontMetrics()	Fetches the font metrics associated with the component hosting this view.
float	getPreferredSpan(int axis)	Determines the preferred span for this view along an axis.
int	getResizeWeight(int axis)	Determines the resizability of the view along the given axis.
void	insertUpdate(DocumentEvent changes,Shape a,ViewFactory f)	Gives notification that something was inserted into the document in a location that this view is responsible for.
Shape	modelToView(int pos,Shape a,Position.Bias b)	Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.
void	paint(Graphics g,Shape a)	Renders using the given rendering surface and area on that surface.
void	removeUpdate(DocumentEvent changes,Shape a,ViewFactory f)	Gives notification that something was removed from the document in a location that this view is responsible for.
int	viewToModel(float fx, float fy,Shape a,Position.Bias[] bias)	Provides a mapping from the view coordinate space to the logical coordinate space of the model.

   * ### Methods inherited from class javax.swing.text.[PlainView](../../../javax/swing/text/PlainView.html "class in javax.swing.text")  
   `[changedUpdate](../../../javax/swing/text/PlainView.html#changedUpdate-javax.swing.event.DocumentEvent-java.awt.Shape-javax.swing.text.ViewFactory-), [damageLineRange](../../../javax/swing/text/PlainView.html#damageLineRange-int-int-java.awt.Shape-java.awt.Component-), [drawLine](../../../javax/swing/text/PlainView.html#drawLine-int-java.awt.Graphics-int-int-), [drawSelectedText](../../../javax/swing/text/PlainView.html#drawSelectedText-java.awt.Graphics-int-int-int-int-), [drawUnselectedText](../../../javax/swing/text/PlainView.html#drawUnselectedText-java.awt.Graphics-int-int-int-int-), [getLineBuffer](../../../javax/swing/text/PlainView.html#getLineBuffer--), [getTabSize](../../../javax/swing/text/PlainView.html#getTabSize--), [lineToRect](../../../javax/swing/text/PlainView.html#lineToRect-java.awt.Shape-int-), [nextTabStop](../../../javax/swing/text/PlainView.html#nextTabStop-float-int-), [setSize](../../../javax/swing/text/PlainView.html#setSize-float-float-), [updateDamage](../../../javax/swing/text/PlainView.html#updateDamage-javax.swing.event.DocumentEvent-java.awt.Shape-javax.swing.text.ViewFactory-), [updateMetrics](../../../javax/swing/text/PlainView.html#updateMetrics--)`  
   * ### Methods inherited from class javax.swing.text.[View](../../../javax/swing/text/View.html "class in javax.swing.text")  
   `[append](../../../javax/swing/text/View.html#append-javax.swing.text.View-), [breakView](../../../javax/swing/text/View.html#breakView-int-int-float-float-), [createFragment](../../../javax/swing/text/View.html#createFragment-int-int-), [forwardUpdate](../../../javax/swing/text/View.html#forwardUpdate-javax.swing.event.DocumentEvent.ElementChange-javax.swing.event.DocumentEvent-java.awt.Shape-javax.swing.text.ViewFactory-), [forwardUpdateToView](../../../javax/swing/text/View.html#forwardUpdateToView-javax.swing.text.View-javax.swing.event.DocumentEvent-java.awt.Shape-javax.swing.text.ViewFactory-), [getAlignment](../../../javax/swing/text/View.html#getAlignment-int-), [getAttributes](../../../javax/swing/text/View.html#getAttributes--), [getBreakWeight](../../../javax/swing/text/View.html#getBreakWeight-int-float-float-), [getChildAllocation](../../../javax/swing/text/View.html#getChildAllocation-int-java.awt.Shape-), [getContainer](../../../javax/swing/text/View.html#getContainer--), [getDocument](../../../javax/swing/text/View.html#getDocument--), [getElement](../../../javax/swing/text/View.html#getElement--), [getEndOffset](../../../javax/swing/text/View.html#getEndOffset--), [getGraphics](../../../javax/swing/text/View.html#getGraphics--), [getMaximumSpan](../../../javax/swing/text/View.html#getMaximumSpan-int-), [getMinimumSpan](../../../javax/swing/text/View.html#getMinimumSpan-int-), [getNextVisualPositionFrom](../../../javax/swing/text/View.html#getNextVisualPositionFrom-int-javax.swing.text.Position.Bias-java.awt.Shape-int-javax.swing.text.Position.Bias:A-), [getParent](../../../javax/swing/text/View.html#getParent--), [getStartOffset](../../../javax/swing/text/View.html#getStartOffset--), [getToolTipText](../../../javax/swing/text/View.html#getToolTipText-float-float-java.awt.Shape-), [getView](../../../javax/swing/text/View.html#getView-int-), [getViewCount](../../../javax/swing/text/View.html#getViewCount--), [getViewFactory](../../../javax/swing/text/View.html#getViewFactory--), [getViewIndex](../../../javax/swing/text/View.html#getViewIndex-float-float-java.awt.Shape-), [getViewIndex](../../../javax/swing/text/View.html#getViewIndex-int-javax.swing.text.Position.Bias-), [insert](../../../javax/swing/text/View.html#insert-int-javax.swing.text.View-), [isVisible](../../../javax/swing/text/View.html#isVisible--), [modelToView](../../../javax/swing/text/View.html#modelToView-int-javax.swing.text.Position.Bias-int-javax.swing.text.Position.Bias-java.awt.Shape-), [modelToView](../../../javax/swing/text/View.html#modelToView-int-java.awt.Shape-), [preferenceChanged](../../../javax/swing/text/View.html#preferenceChanged-javax.swing.text.View-boolean-boolean-), [remove](../../../javax/swing/text/View.html#remove-int-), [removeAll](../../../javax/swing/text/View.html#removeAll--), [replace](../../../javax/swing/text/View.html#replace-int-int-javax.swing.text.View:A-), [setParent](../../../javax/swing/text/View.html#setParent-javax.swing.text.View-), [updateChildren](../../../javax/swing/text/View.html#updateChildren-javax.swing.event.DocumentEvent.ElementChange-javax.swing.event.DocumentEvent-javax.swing.text.ViewFactory-), [updateLayout](../../../javax/swing/text/View.html#updateLayout-javax.swing.event.DocumentEvent.ElementChange-javax.swing.event.DocumentEvent-java.awt.Shape-), [viewToModel](../../../javax/swing/text/View.html#viewToModel-float-float-java.awt.Shape-)`  
   * ### Methods inherited from class java.lang.[Object](../../../java/lang/Object.html "class in java.lang")  
   `[clone](../../../java/lang/Object.html#clone--), [equals](../../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../../java/lang/Object.html#finalize--), [getClass](../../../java/lang/Object.html#getClass--), [hashCode](../../../java/lang/Object.html#hashCode--), [notify](../../../java/lang/Object.html#notify--), [notifyAll](../../../java/lang/Object.html#notifyAll--), [toString](../../../java/lang/Object.html#toString--), [wait](../../../java/lang/Object.html#wait--), [wait](../../../java/lang/Object.html#wait-long-), [wait](../../../java/lang/Object.html#wait-long-int-)`

Constructor Detail

 * #### FieldView  
 public FieldView([Element](../../../javax/swing/text/Element.html "interface in javax.swing.text") elem)  
 Constructs a new FieldView wrapped on an element.  
 Parameters:  
 `elem` \- the element

Method Detail

* #### getFontMetrics  
protected [FontMetrics](../../../java/awt/FontMetrics.html "class in java.awt") getFontMetrics()  
Fetches the font metrics associated with the component hosting this view.  
Returns:  
the metrics  
* #### adjustAllocation  
protected [Shape](../../../java/awt/Shape.html "interface in java.awt") adjustAllocation([Shape](../../../java/awt/Shape.html "interface in java.awt") a)  
Adjusts the allocation given to the view to be a suitable allocation for a text field. If the view has been allocated more than the preferred span vertically, the allocation is changed to be centered vertically. Horizontally the view is adjusted according to the horizontal alignment property set on the associated JTextField (if that is the type of the hosting component).  
Parameters:  
`a` \- the allocation given to the view, which may need to be adjusted.  
Returns:  
the allocation that the superclass should use.  
* #### paint  
public void paint([Graphics](../../../java/awt/Graphics.html "class in java.awt") g,  
                  [Shape](../../../java/awt/Shape.html "interface in java.awt") a)  
Renders using the given rendering surface and area on that surface. The view may need to do layout and create child views to enable itself to render into the given allocation.  
Overrides:  
`[paint](../../../javax/swing/text/PlainView.html#paint-java.awt.Graphics-java.awt.Shape-)` in class `[PlainView](../../../javax/swing/text/PlainView.html "class in javax.swing.text")`  
Parameters:  
`g` \- the rendering surface to use  
`a` \- the allocated region to render into  
See Also:  
[View.paint(java.awt.Graphics, java.awt.Shape)](../../../javax/swing/text/View.html#paint-java.awt.Graphics-java.awt.Shape-)  
* #### getPreferredSpan  
public float getPreferredSpan(int axis)  
Determines the preferred span for this view along an axis.  
Overrides:  
`[getPreferredSpan](../../../javax/swing/text/PlainView.html#getPreferredSpan-int-)` in class `[PlainView](../../../javax/swing/text/PlainView.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.  
See Also:  
[View.getPreferredSpan(int)](../../../javax/swing/text/View.html#getPreferredSpan-int-)  
* #### getResizeWeight  
public int getResizeWeight(int axis)  
Determines the resizability of the view along the given axis. A value of 0 or less is not resizable.  
Overrides:  
`[getResizeWeight](../../../javax/swing/text/View.html#getResizeWeight-int-)` in class `[View](../../../javax/swing/text/View.html "class in javax.swing.text")`  
Parameters:  
`axis` \- View.X\_AXIS or View.Y\_AXIS  
Returns:  
the weight -> 1 for View.X\_AXIS, else 0  
* #### modelToView  
public [Shape](../../../java/awt/Shape.html "interface in java.awt") modelToView(int pos,  
                         [Shape](../../../java/awt/Shape.html "interface in java.awt") a,  
                         [Position.Bias](../../../javax/swing/text/Position.Bias.html "class in javax.swing.text") b)  
                  throws [BadLocationException](../../../javax/swing/text/BadLocationException.html "class in javax.swing.text")  
Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.  
Overrides:  
`[modelToView](../../../javax/swing/text/PlainView.html#modelToView-int-java.awt.Shape-javax.swing.text.Position.Bias-)` in class `[PlainView](../../../javax/swing/text/PlainView.html "class in javax.swing.text")`  
Parameters:  
`pos` \- the position to convert >= 0  
`a` \- the allocated region to render into  
`b` \- the bias toward the previous character or the next character represented by the offset, in case the position is a boundary of two views; `b` will have one of these values:  
         * `Position.Bias.Forward`  
         * `Position.Bias.Backward`  
Returns:  
the bounding box of the given position  
Throws:  
`[BadLocationException](../../../javax/swing/text/BadLocationException.html "class in javax.swing.text")` \- if the given position does not represent a valid location in the associated document  
See Also:  
[View.modelToView(int, java.awt.Shape, javax.swing.text.Position.Bias)](../../../javax/swing/text/View.html#modelToView-int-java.awt.Shape-javax.swing.text.Position.Bias-)  
* #### viewToModel  
public int viewToModel(float fx,  
                       float fy,  
                       [Shape](../../../java/awt/Shape.html "interface in java.awt") a,  
                       [Position.Bias](../../../javax/swing/text/Position.Bias.html "class in javax.swing.text")[] bias)  
Provides a mapping from the view coordinate space to the logical coordinate space of the model.  
Overrides:  
`[viewToModel](../../../javax/swing/text/PlainView.html#viewToModel-float-float-java.awt.Shape-javax.swing.text.Position.Bias:A-)` in class `[PlainView](../../../javax/swing/text/PlainView.html "class in javax.swing.text")`  
Parameters:  
`fx` \- the X coordinate >= 0.0f  
`fy` \- the Y coordinate >= 0.0f  
`a` \- the allocated region to render into  
Returns:  
the location within the model that best represents the given point in the view  
See Also:  
[View.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias\[\])](../../../javax/swing/text/View.html#viewToModel-float-float-java.awt.Shape-javax.swing.text.Position.Bias:A-)  
* #### insertUpdate  
public void insertUpdate([DocumentEvent](../../../javax/swing/event/DocumentEvent.html "interface in javax.swing.event") changes,  
                         [Shape](../../../java/awt/Shape.html "interface in java.awt") a,  
                         [ViewFactory](../../../javax/swing/text/ViewFactory.html "interface in javax.swing.text") f)  
Gives notification that something was inserted into the document in a location that this view is responsible for.  
Overrides:  
`[insertUpdate](../../../javax/swing/text/PlainView.html#insertUpdate-javax.swing.event.DocumentEvent-java.awt.Shape-javax.swing.text.ViewFactory-)` in class `[PlainView](../../../javax/swing/text/PlainView.html "class in javax.swing.text")`  
Parameters:  
`changes` \- the change information from the associated document  
`a` \- the current allocation of the view  
`f` \- the factory to use to rebuild if the view has children  
See Also:  
[View.insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)](../../../javax/swing/text/View.html#insertUpdate-javax.swing.event.DocumentEvent-java.awt.Shape-javax.swing.text.ViewFactory-)  
* #### removeUpdate  
public void removeUpdate([DocumentEvent](../../../javax/swing/event/DocumentEvent.html "interface in javax.swing.event") changes,  
                         [Shape](../../../java/awt/Shape.html "interface in java.awt") a,  
                         [ViewFactory](../../../javax/swing/text/ViewFactory.html "interface in javax.swing.text") f)  
Gives notification that something was removed from the document in a location that this view is responsible for.  
Overrides:  
`[removeUpdate](../../../javax/swing/text/PlainView.html#removeUpdate-javax.swing.event.DocumentEvent-java.awt.Shape-javax.swing.text.ViewFactory-)` in class `[PlainView](../../../javax/swing/text/PlainView.html "class in javax.swing.text")`  
Parameters:  
`changes` \- the change information from the associated document  
`a` \- the current allocation of the view  
`f` \- the factory to use to rebuild if the view has children  
See Also:  
[View.removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)](../../../javax/swing/text/View.html#removeUpdate-javax.swing.event.DocumentEvent-java.awt.Shape-javax.swing.text.ViewFactory-)

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

FieldView (Java Platform SE 8 ) (original) (raw)

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail