PasswordView (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.swing.text
class PasswordView

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

All Implemented Interfaces:: SwingConstants, TabExpander

public class PasswordView
extends FieldView

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

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`

Constructor Summary
`PasswordView(Element elem)` Constructs a new view wrapped on an element.

Method Summary
`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.
`protected int`	`drawSelectedText(Graphics g, int x, int y, int p0, int p1)` Renders the given range in the model as selected text.
`protected int`	`drawUnselectedText(Graphics g, int x, int y, int p0, int p1)` Renders the given range in the model as normal unselected text.
`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, 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.FieldView
`adjustAllocation, getFontMetrics, getPreferredSpan, getResizeWeight, insertUpdate, modelToView, paint, removeUpdate, viewToModel`

Methods inherited from class javax.swing.text.PlainView
`changedUpdate, damageLineRange, drawLine, drawSelectedText, drawUnselectedText, getLineBuffer, getPreferredSpan, getTabSize, insertUpdate, lineToRect, modelToView, nextTabStop, paint, removeUpdate, setSize, updateDamage, updateMetrics, viewToModel`

Methods inherited from class javax.swing.text.View
append, breakView, changedUpdate, createFragment, forwardUpdate, forwardUpdateToView, getAlignment, getAttributes, getBreakWeight, getChildAllocation, getContainer, getDocument, getElement, getEndOffset, getGraphics, getMaximumSpan, getMinimumSpan, getNextVisualPositionFrom, getParent, getPreferredSpan, getResizeWeight, getStartOffset, getToolTipText, getView, getViewCount, getViewFactory, getViewIndex, getViewIndex, insert, insertUpdate, isVisible, modelToView, modelToView, modelToView, paint, preferenceChanged, remove, removeAll, removeUpdate, replace, setParent, setSize, updateChildren, updateLayout, viewToModel, viewToModel

Methods inherited from class javax.swing.text.View


append, breakView, changedUpdate, createFragment, forwardUpdate, forwardUpdateToView, getAlignment, getAttributes, getBreakWeight, getChildAllocation, getContainer, getDocument, getElement, getEndOffset, getGraphics, getMaximumSpan, getMinimumSpan, getNextVisualPositionFrom, getParent, getPreferredSpan, getResizeWeight, getStartOffset, getToolTipText, getView, getViewCount, getViewFactory, getViewIndex, getViewIndex, insert, insertUpdate, isVisible, modelToView, modelToView, modelToView, paint, preferenceChanged, remove, removeAll, removeUpdate, replace, setParent, setSize, updateChildren, updateLayout, viewToModel, viewToModel

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

PasswordView

public PasswordView(Element elem)

Constructs a new view wrapped on an element.

Parameters:: elem - the element

Method Detail

drawEchoCharacter

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

drawSelectedText

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

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.

Overrides:: drawSelectedText in class PlainView
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

drawUnselectedText

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

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().

Overrides:: drawUnselectedText in class PlainView
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

getPreferredSpan

public float getPreferredSpan(int axis)

Determines the preferred span for this view along an axis.

Overrides:: getPreferredSpan in class FieldView
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.

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 in class FieldView
Parameters:: pos - the position to convert >= 0; a - the allocated region to render into; b
Returns:: the bounding box of the given position
Throws:: BadLocationException - if the given position does not represent a valid location in the associated document

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 in class FieldView
Parameters:: fx - the X coordinate >= 0.0f; fy - the Y coordinate >= 0.0f; a - the allocated region to render into; bias
Returns:: the location within the model that best represents the given point in the view