FileDocCategorySizeDatePackage
PasswordView.javaAPI DocJava SE 5 API7360Fri Aug 26 14:58:16 BST 2005javax.swing.text

PasswordView

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).
author
Timothy Prinzing
version
1.20 04/15/04
see
View

Fields Summary
static char[]
ONE
Constructors Summary
public PasswordView(Element elem)
Constructs a new view wrapped on an element.

param
elem the element

	super(elem);
    
Methods Summary
protected intdrawEchoCharacter(java.awt.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.

param
g the graphics context
param
x the starting X coordinate >= 0
param
y the starting Y coordinate >= 0
param
c the echo character
return
the updated X position >= 0

	ONE[0] = c;
        SwingUtilities2.drawChars(Utilities.getJComponent(this),
                                  g, ONE, 0, 1, x, y);
	return x + g.getFontMetrics().charWidth(c);
    
protected intdrawSelectedText(java.awt.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.

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

	g.setColor(selected);
	Container c = getContainer();
	if (c instanceof JPasswordField) {
	    JPasswordField f = (JPasswordField) c;
	    if (! f.echoCharIsSet()) {
		return super.drawSelectedText(g, x, y, p0, p1);
	    }
	    char echoChar = f.getEchoChar();
	    int n = p1 - p0;
	    for (int i = 0; i < n; i++) {
		x = drawEchoCharacter(g, x, y, echoChar);
	    }
	}
	return x;
    
protected intdrawUnselectedText(java.awt.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().

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


	Container c = getContainer();
	if (c instanceof JPasswordField) {
	    JPasswordField f = (JPasswordField) c;
	    if (! f.echoCharIsSet()) {
		return super.drawUnselectedText(g, x, y, p0, p1);
	    }
            if (f.isEnabled()) {
                g.setColor(f.getForeground());
            }
            else {
                g.setColor(f.getDisabledTextColor());
            }
	    char echoChar = f.getEchoChar();
	    int n = p1 - p0;
	    for (int i = 0; i < n; i++) {
		x = drawEchoCharacter(g, x, y, echoChar);
	    }
	}
	return x;
    
public floatgetPreferredSpan(int axis)
Determines the preferred span for this view along an axis.

param
axis may be either View.X_AXIS or View.Y_AXIS
return
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.

	switch (axis) {
	case View.X_AXIS:
            Container c = getContainer();
            if (c instanceof JPasswordField) {
                JPasswordField f = (JPasswordField) c;
                if (f.echoCharIsSet()) {
                    char echoChar = f.getEchoChar();
                    FontMetrics m = f.getFontMetrics(f.getFont());
                    Document doc = getDocument();
                    return m.charWidth(echoChar) * getDocument().getLength();
                }
            }
        }
        return super.getPreferredSpan(axis);
    
public java.awt.ShapemodelToView(int pos, java.awt.Shape a, javax.swing.text.Position$Bias b)
Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.

param
pos the position to convert >= 0
param
a the allocated region to render into
return
the bounding box of the given position
exception
BadLocationException if the given position does not represent a valid location in the associated document
see
View#modelToView

	Container c = getContainer();
	if (c instanceof JPasswordField) {
	    JPasswordField f = (JPasswordField) c;
	    if (! f.echoCharIsSet()) {
		return super.modelToView(pos, a, b);
	    }
	    char echoChar = f.getEchoChar();
	    FontMetrics m = f.getFontMetrics(f.getFont());
	    
	    Rectangle alloc = adjustAllocation(a).getBounds();
	    int dx = (pos - getStartOffset()) * m.charWidth(echoChar);
	    alloc.x += dx;
	    alloc.width = 1;
	    return alloc;
	}
	return null;
    
public intviewToModel(float fx, float fy, java.awt.Shape a, javax.swing.text.Position$Bias[] bias)
Provides a mapping from the view coordinate space to the logical coordinate space of the model.

param
fx the X coordinate >= 0.0f
param
fy the Y coordinate >= 0.0f
param
a the allocated region to render into
return
the location within the model that best represents the given point in the view
see
View#viewToModel

	bias[0] = Position.Bias.Forward;
	int n = 0;
	Container c = getContainer();
	if (c instanceof JPasswordField) {
	    JPasswordField f = (JPasswordField) c;
	    if (! f.echoCharIsSet()) {
		return super.viewToModel(fx, fy, a, bias);
	    }
	    char echoChar = f.getEchoChar();
	    FontMetrics m = f.getFontMetrics(f.getFont());
	    a = adjustAllocation(a);
	    Rectangle alloc = (a instanceof Rectangle) ? (Rectangle)a :
                              a.getBounds();
	    n = ((int)fx - alloc.x) / m.charWidth(echoChar);
	    if (n < 0) {
		n = 0;
	    }
	    else if (n > (getStartOffset() + getDocument().getLength())) {
		n = getDocument().getLength() - getStartOffset();
	    }
	}
	return getStartOffset() + n;