ch.randelshofer.quaqua.QuaquaPasswordView Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of Quaqua Show documentation
A Mavenisation of the Quaqua Mac OSX Swing Look and Feel (Java library) Quaqua Look and Feel (C) 2003-2010, Werner Randelshofer. Mavenisation by Matt Gumbley, DevZendo.org - for problems with Mavenisation, see Matt; for issues with Quaqua, see the Quaqua home page. For full license details, see http://randelshofer.ch/quaqua/license.html
The newest version!
/*
 * @(#)QuaquaPasswordView.java  
 *
 * Copyright (c) 2005-2010 Werner Randelshofer, Immensee, Switzerland.
 * All rights reserved.
 *
 * You may not use, copy or modify this file, except in compliance with the
 * license agreement you entered into with Werner Randelshofer.
 * For details see accompanying license terms.
 */

package ch.randelshofer.quaqua;

import java.awt.*;
import javax.swing.*;
import javax.swing.text.*;
/**
 * QuaquaPasswordView paints a filled circle instead of the echo char returned
 * by the JPasswordField.
 *
 * @author  Werner Randelshofer
 * @version $Id: QuaquaPasswordView.java 361 2010-11-21 11:19:20Z wrandelshofer $
 */
public class QuaquaPasswordView extends FieldView {
    
    /** Creates a new instance. */
    public QuaquaPasswordView(Element element) {
        super(element);
    }
    
    protected char getEchoChar(JPasswordField field) {
        return field.getEchoChar() == '*' ?
            '\u2022': // Unicode BULLET
            field.getEchoChar();
        }
    
   /**
     * 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
     */
    @Override
    protected int drawUnselectedText(Graphics g, int x, int y,
				     int p0, int p1) throws BadLocationException {

	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 = getEchoChar(f);
	    int n = p1 - p0;
	    for (int i = 0; i < n; i++) {
		x = drawEchoCharacter(g, x, y, echoChar);
	    }
	}
	return x;
    }
    protected Color unselected;
    protected Color selected;
    
    @Override
    public void paint(Graphics g, Shape a) {
	JTextComponent host = (JTextComponent) getContainer();
        unselected = (host.isEnabled()) ? 
            host.getForeground() : host.getDisabledTextColor();
	Caret c = host.getCaret();
        selected = c.isSelectionVisible() ? host.getSelectedTextColor() : unselected;
        super.paint(g, a);
}
    /**
     * 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
     */
    @Override
    protected int drawSelectedText(Graphics g, int x,
				   int y, int p0, int p1) throws BadLocationException {
	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 = getEchoChar(f);
	    int n = p1 - p0;
	    for (int i = 0; i < n; i++) {
		x = drawEchoCharacter(g, x, y, echoChar);
	    }
	}
	return x;
    }

    /**
     * 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
     */
    protected int drawEchoCharacter(Graphics g, int x, int y, char c) {
	ONE[0] = c;
	g.drawChars(ONE, 0, 1, x, y);
	return x + g.getFontMetrics().charWidth(c);
    }

    /**
     * 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
     */
    @Override
    public Shape modelToView(int pos, Shape a, Position.Bias b) throws BadLocationException {
	Container c = getContainer();
	if (c instanceof JPasswordField) {
	    JPasswordField f = (JPasswordField) c;
	    if (! f.echoCharIsSet()) {
		return super.modelToView(pos, a, b);
	    }
	    char echoChar = getEchoChar(f);
	    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;
    }

    /**
     * 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
     */
    @Override
    public int viewToModel(float fx, float fy, Shape a, Position.Bias[] bias) {
	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 = getEchoChar(f);
	    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;
    }

    /**
     * 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.
     */
    @Override
    public float getPreferredSpan(int axis) {
	switch (axis) {
	case View.X_AXIS:
            Container c = getContainer();
            if (c instanceof JPasswordField) {
                JPasswordField f = (JPasswordField) c;
                if (f.echoCharIsSet()) {
                    char echoChar = getEchoChar(f);
                    FontMetrics m = f.getFontMetrics(f.getFont());
                    Document doc = getDocument();
                    return m.charWidth(echoChar) * doc.getLength();
                }
            }
        }
        return super.getPreferredSpan(axis);
    }

    static char[] ONE = new char[1];
}