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

javax.swing.text

Class FieldView

java.lang.Object extended by 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
metrics

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
FieldView(Element elem) Constructs a new FieldView wrapped on an element.

Method Summary
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](../../../javax/swing/text/FieldView.html#insertUpdate%28javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory%29)(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](../../../javax/swing/text/FieldView.html#modelToView%28int, java.awt.Shape, javax.swing.text.Position.Bias%29)(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](../../../javax/swing/text/FieldView.html#paint%28java.awt.Graphics, java.awt.Shape%29)(Graphics g,Shape a) Renders using the given rendering surface and area on that surface.
void	[removeUpdate](../../../javax/swing/text/FieldView.html#removeUpdate%28javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory%29)(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](../../../javax/swing/text/FieldView.html#viewToModel%28float, float, java.awt.Shape, javax.swing.text.Position.Bias[]%29)(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
[changedUpdate](../../../javax/swing/text/PlainView.html#changedUpdate%28javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory%29), [damageLineRange](../../../javax/swing/text/PlainView.html#damageLineRange%28int, int, java.awt.Shape, java.awt.Component%29), [drawLine](../../../javax/swing/text/PlainView.html#drawLine%28int, java.awt.Graphics, int, int%29), [drawSelectedText](../../../javax/swing/text/PlainView.html#drawSelectedText%28java.awt.Graphics, int, int, int, int%29), [drawUnselectedText](../../../javax/swing/text/PlainView.html#drawUnselectedText%28java.awt.Graphics, int, int, int, int%29), getLineBuffer, getTabSize, [lineToRect](../../../javax/swing/text/PlainView.html#lineToRect%28java.awt.Shape, int%29), [nextTabStop](../../../javax/swing/text/PlainView.html#nextTabStop%28float, int%29), [setSize](../../../javax/swing/text/PlainView.html#setSize%28float, float%29), [updateDamage](../../../javax/swing/text/PlainView.html#updateDamage%28javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory%29), updateMetrics

Methods inherited from class javax.swing.text.PlainView

[changedUpdate](../../../javax/swing/text/PlainView.html#changedUpdate%28javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory%29), [damageLineRange](../../../javax/swing/text/PlainView.html#damageLineRange%28int, int, java.awt.Shape, java.awt.Component%29), [drawLine](../../../javax/swing/text/PlainView.html#drawLine%28int, java.awt.Graphics, int, int%29), [drawSelectedText](../../../javax/swing/text/PlainView.html#drawSelectedText%28java.awt.Graphics, int, int, int, int%29), [drawUnselectedText](../../../javax/swing/text/PlainView.html#drawUnselectedText%28java.awt.Graphics, int, int, int, int%29), getLineBuffer, getTabSize, [lineToRect](../../../javax/swing/text/PlainView.html#lineToRect%28java.awt.Shape, int%29), [nextTabStop](../../../javax/swing/text/PlainView.html#nextTabStop%28float, int%29), [setSize](../../../javax/swing/text/PlainView.html#setSize%28float, float%29), [updateDamage](../../../javax/swing/text/PlainView.html#updateDamage%28javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory%29), updateMetrics

Methods inherited from class javax.swing.text.View
append, [breakView](../../../javax/swing/text/View.html#breakView%28int, int, float, float%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), getAlignment, 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, getMaximumSpan, getMinimumSpan, [getNextVisualPositionFrom](../../../javax/swing/text/View.html#getNextVisualPositionFrom%28int, javax.swing.text.Position.Bias, java.awt.Shape, int, javax.swing.text.Position.Bias[]%29), getParent, 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), 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, [replace](../../../javax/swing/text/View.html#replace%28int, int, javax.swing.text.View[]%29), setParent, [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), [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), getAlignment, 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, getMaximumSpan, getMinimumSpan, [getNextVisualPositionFrom](../../../javax/swing/text/View.html#getNextVisualPositionFrom%28int, javax.swing.text.Position.Bias, java.awt.Shape, int, javax.swing.text.Position.Bias[]%29), getParent, 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), 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, [replace](../../../javax/swing/text/View.html#replace%28int, int, javax.swing.text.View[]%29), setParent, [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)

Constructor Detail

FieldView

public FieldView(Element elem)

Constructs a new FieldView wrapped on an element.

Parameters:

elem - the element

Method Detail

getFontMetrics

protected FontMetrics getFontMetrics()

Fetches the font metrics associated with the component hosting this view.

Returns:

the metrics

adjustAllocation

protected Shape adjustAllocation(Shape 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 g, Shape 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%28java.awt.Graphics, java.awt.Shape%29) 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%28java.awt.Graphics, java.awt.Shape%29)

getPreferredSpan

public float getPreferredSpan(int axis)

Determines the preferred span for this view along an axis.

Overrides:

[getPreferredSpan](../../../javax/swing/text/PlainView.html#getPreferredSpan%28int%29) 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)

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%28int%29) 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 modelToView(int pos, Shape a, Position.Bias b) throws BadLocationException

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%28int, java.awt.Shape, javax.swing.text.Position.Bias%29) 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%28int, java.awt.Shape, javax.swing.text.Position.Bias%29)

viewToModel

public 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.

Overrides:

[viewToModel](../../../javax/swing/text/PlainView.html#viewToModel%28float, float, java.awt.Shape, javax.swing.text.Position.Bias[]%29) 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%28float, float, java.awt.Shape, javax.swing.text.Position.Bias[]%29)

insertUpdate

public 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.

Overrides:

[insertUpdate](../../../javax/swing/text/PlainView.html#insertUpdate%28javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory%29) 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%28javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory%29)

removeUpdate

public 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.

Overrides:

[removeUpdate](../../../javax/swing/text/PlainView.html#removeUpdate%28javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory%29) 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%28javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory%29)

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.