PasswordView (Java 2 Platform SE 5.0) (original) (raw)
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:
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).
See Also:
| 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 |
|---|
| PasswordView(Element elem) Constructs a new view wrapped on an element. |
| Method Summary | |
|---|---|
| protected int | [drawEchoCharacter](../../../javax/swing/text/PasswordView.html#drawEchoCharacter%28java.awt.Graphics, int, int, char%29)(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](../../../javax/swing/text/PasswordView.html#drawSelectedText%28java.awt.Graphics, int, int, int, int%29)(Graphics g, int x, int y, int p0, int p1) Renders the given range in the model as selected text. |
| protected int | [drawUnselectedText](../../../javax/swing/text/PasswordView.html#drawUnselectedText%28java.awt.Graphics, int, int, int, int%29)(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](../../../javax/swing/text/PasswordView.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. |
| int | [viewToModel](../../../javax/swing/text/PasswordView.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.FieldView |
|---|
| adjustAllocation, getFontMetrics, getResizeWeight, [insertUpdate](../../../javax/swing/text/FieldView.html#insertUpdate%28javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory%29), [paint](../../../javax/swing/text/FieldView.html#paint%28java.awt.Graphics, java.awt.Shape%29), [removeUpdate](../../../javax/swing/text/FieldView.html#removeUpdate%28javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory%29) |
| 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), 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 java.lang.Object |
|---|
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, [wait](../../../java/lang/Object.html#wait%28long, int%29) |
| Constructor Detail |
|---|
PasswordView
public PasswordView(Element elem)
Constructs a new view wrapped on an element.
Parameters:
elem - the element
| Method Detail |
|---|
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](../../../javax/swing/text/PlainView.html#drawUnselectedText%28java.awt.Graphics, int, int, int, int%29) in class [PlainView](../../../javax/swing/text/PlainView.html "class in javax.swing.text")
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](../../../javax/swing/text/BadLocationException.html "class in javax.swing.text") - if p0 or p1 are out of range
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](../../../javax/swing/text/PlainView.html#drawSelectedText%28java.awt.Graphics, int, int, int, int%29) in class [PlainView](../../../javax/swing/text/PlainView.html "class in javax.swing.text")
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](../../../javax/swing/text/BadLocationException.html "class in javax.swing.text") - if p0 or p1 are out of range
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
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/FieldView.html#modelToView%28int, java.awt.Shape, javax.swing.text.Position.Bias%29) in class [FieldView](../../../javax/swing/text/FieldView.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.ForwardPosition.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/FieldView.html#viewToModel%28float, float, java.awt.Shape, javax.swing.text.Position.Bias[]%29) in class [FieldView](../../../javax/swing/text/FieldView.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)
getPreferredSpan
public float getPreferredSpan(int axis)
Determines the preferred span for this view along an axis.
Overrides:
[getPreferredSpan](../../../javax/swing/text/FieldView.html#getPreferredSpan%28int%29) in class [FieldView](../../../javax/swing/text/FieldView.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:
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.
Copyright © 2004, 2010 Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.