public class

PasswordView

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

Class Overview

Implements a View suitable for use in JPasswordField UI implementations. This is basically a field ui that renders its contents as the echo character specified in the associated component (if it can narrow the component to a JPasswordField).

See Also

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
PasswordView(Element elem)
Constructs a new view wrapped on an element.
Public Methods
float getPreferredSpan(int axis)
Determines the preferred span for this view along an axis.
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.
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
int drawEchoCharacter(Graphics g, int x, int y, char c)
Renders the echo character, or whatever graphic should be used to display the password characters.
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.
[Expand]
Inherited Methods
From class javax.swing.text.FieldView
From class javax.swing.text.PlainView
From class javax.swing.text.View
From class java.lang.Object
From interface javax.swing.text.TabExpander

Public Constructors

public PasswordView (Element elem)

Constructs a new view 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 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 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 int drawEchoCharacter (Graphics g, int x, int y, char c)

Renders the echo character, or whatever graphic should be used to display the password characters. The color in the Graphics object is set to the appropriate foreground color for selected or unselected text.

Parameters
g the graphics context
x the starting X coordinate >= 0
y the starting Y coordinate >= 0
c the echo character
Returns
  • the updated X position >= 0

protected int drawSelectedText (Graphics g, int x, int y, int p0, int p1)

Renders the given range in the model as selected text. This is implemented to render the text in the color specified in the hosting component. It assumes the highlighter will render the selected background. Uses the result of getEchoChar() to display the characters.

Parameters
g the graphics context
x the starting X coordinate >= 0
y the starting Y coordinate >= 0
p0 the starting offset in the model >= 0
p1 the ending offset in the model >= p0
Returns
  • the X location of the end of the range >= 0
Throws
BadLocationException if p0 or p1 are out of range

protected int drawUnselectedText (Graphics g, int x, int y, int p0, int p1)

Renders the given range in the model as normal unselected text. This sets the foreground color and echos the characters using the value returned by getEchoChar().

Parameters
g the graphics context
x the starting X coordinate >= 0
y the starting Y coordinate >= 0
p0 the starting offset in the model >= 0
p1 the ending offset in the model >= p0
Returns
  • the X location of the end of the range >= 0
Throws
BadLocationException if p0 or p1 are out of range