public class

FieldView

extends PlainView

java.lang.Object
↳	javax.swing.text.View
	↳	javax.swing.text.PlainView
		↳	javax.swing.text.FieldView

Known Direct Subclasses

PasswordView

Class Overview

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.

Summary

[Expand]

Inherited Constants

From class javax.swing.text.View

From interface javax.swing.SwingConstants

[Expand]

Inherited Fields

From class javax.swing.text.PlainView

Public Constructors
	FieldView(Element elem) Constructs a new FieldView wrapped on an element.

Public Methods
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, Bias[] bias) Provides a mapping from the view coordinate space to the logical coordinate space of the model.

Protected Methods
Shape	adjustAllocation(Shape a) Adjusts the allocation given to the view to be a suitable allocation for a text field.
FontMetrics	getFontMetrics() Fetches the font metrics associated with the component hosting this view.

[Expand]

Inherited Methods

From class javax.swing.text.PlainView

void	changedUpdate(DocumentEvent changes, Shape a, ViewFactory f) Gives notification from the document that attributes were changed in a location that this view is responsible for.
void	damageLineRange(int line0, int line1, Shape a, Component host) Repaint the given line range.
void	drawLine(int lineIndex, Graphics g, int x, int y) Renders a line of text, suppressing whitespace at the end and expanding any tabs.
int	drawSelectedText(Graphics g, int x, int y, int p0, int p1) Renders the given range in the model as selected text.
int	drawUnselectedText(Graphics g, int x, int y, int p0, int p1) Renders the given range in the model as normal unselected text.
final Segment	getLineBuffer() Gives access to a buffer that can be used to fetch text from the associated document.
float	getPreferredSpan(int axis) Determines the preferred span for this view along an axis.
int	getTabSize() Returns the tab size set for the document, defaulting to 8.
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.
Rectangle	lineToRect(Shape a, int line) Determine the rectangle that represents the given line.
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.
float	nextTabStop(float x, int tabOffset) Returns the next tab stop position after a given reference position.
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.
void	setSize(float width, float height) Sets the size of the view.
void	updateDamage(DocumentEvent changes, Shape a, ViewFactory f) Repaint the region of change covered by the given document event.
void	updateMetrics() Checks to see if the font metrics and longest line are up-to-date.
int	viewToModel(float fx, float fy, Shape a, Bias[] bias) Provides a mapping from the view coordinate space to the logical coordinate space of the model.

From class javax.swing.text.View

void	append(View v) Appends a single child view.
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.
View	createFragment(int p0, int p1) Creates a view that represents a portion of the element.
void	forwardUpdate(DocumentEvent.ElementChange ec, DocumentEvent e, Shape a, ViewFactory f) Forwards the given `DocumentEvent` to the child views that need to be notified of the change to the model.
void	forwardUpdateToView(View v, DocumentEvent e, Shape a, ViewFactory f) Forwards the `DocumentEvent` to the give child view.
float	getAlignment(int axis) Determines the desired alignment for this view along an axis.
AttributeSet	getAttributes() 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.
Shape	getChildAllocation(int index, Shape a) Fetches the allocation for the given child view.
Container	getContainer() Fetches the container hosting the view.
Document	getDocument() Fetches the model associated with the view.
Element	getElement() Fetches the structural portion of the subject that this view is mapped to.
int	getEndOffset() Fetches the portion of the model for which this view is responsible.
Graphics	getGraphics() Fetch a `Graphics` for rendering.
float	getMaximumSpan(int axis) Determines the maximum span for this view along an axis.
float	getMinimumSpan(int axis) Determines the minimum span for this view along an axis.
int	getNextVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Bias[] biasRet) Provides a way to determine the next visually represented model location at which one might place a caret.
View	getParent() Returns the parent of the view.
abstract 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.
int	getStartOffset() Fetches the portion of the model for which this view is responsible.
String	getToolTipText(float x, float y, Shape allocation) Returns the tooltip text at the specified location.
View	getView(int n) Gets the nth child view.
int	getViewCount() Returns the number of views in this view.
ViewFactory	getViewFactory() Fetches the `ViewFactory` 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	insert(int offs, View v) 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	isVisible() Returns a boolean that indicates whether the view is visible or not.
Shape	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.
Shape	modelToView(int pos, Shape a) This method is deprecated. No replacement.
abstract Shape	modelToView(int pos, Shape a, Position.Bias b) Provides a mapping, for a given character, from the document model coordinate space to the view coordinate space.
abstract void	paint(Graphics g, Shape allocation) Renders using the given rendering surface and area on that surface.
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	removeAll() 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	replace(int offset, int length, View[] views) Replaces child views.
void	setParent(View parent) Establishes the parent view for this view.
void	setSize(float width, float height) Sets the size of the view.
boolean	updateChildren(DocumentEvent.ElementChange ec, DocumentEvent e, ViewFactory f) 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.
void	updateLayout(DocumentEvent.ElementChange ec, DocumentEvent e, Shape a) Updates the layout in response to receiving notification of change from the model.
int	viewToModel(float x, float y, Shape a) This method is deprecated. No replacement.
abstract int	viewToModel(float x, float y, Shape a, Bias[] biasReturn) Provides a mapping from the view coordinate space to the logical coordinate space of the model.

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

From interface javax.swing.text.TabExpander

Public Constructors

public FieldView (Element elem)

Constructs a new FieldView wrapped on an element.

Parameters

elem	the element

Public Methods

public float getPreferredSpan (int axis)

Determines the preferred span for this view along an axis.

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.

public int getResizeWeight (int axis)

Determines the resizability of the view along the given axis. A value of 0 or less is not resizable.

Parameters

axis	View.X_AXIS or View.Y_AXIS

Returns

the weight -> 1 for View.X_AXIS, else 0

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.

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

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

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	if the given position does not represent a valid location in the associated document

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.

Parameters

g	the rendering surface to use
a	the allocated region to render into

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.

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

public int viewToModel (float fx, float fy, Shape a, Bias[] bias)

Provides a mapping from the view coordinate space to the logical coordinate space of the model.

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

Protected Methods

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.

protected FontMetrics getFontMetrics ()

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

Returns

the metrics

Interfaces

Classes

Exceptions

FieldView

Class Overview

See Also

Summary

Public Constructors

public FieldView (Element elem)

Parameters

Public Methods

public float getPreferredSpan (int axis)

Parameters

Returns

public int getResizeWeight (int axis)

Parameters

Returns

public void insertUpdate (DocumentEvent changes, Shape a, ViewFactory f)

Parameters

See Also

public Shape modelToView (int pos, Shape a, Position.Bias b)

Parameters

Returns

Throws

See Also

public void paint (Graphics g, Shape a)

Parameters

See Also

public void removeUpdate (DocumentEvent changes, Shape a, ViewFactory f)

Parameters

See Also

public int viewToModel (float fx, float fy, Shape a, Bias[] bias)

Parameters

Returns

See Also

Protected Methods

protected Shape adjustAllocation (Shape a)

Parameters

Returns

protected FontMetrics getFontMetrics ()

Returns