PasswordView.java

/*
 * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation. Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
packagejavax.swing.text;

importsun.swing.SwingUtilities2;
importjava.awt.*;
importjava.awt.font.FontRenderContext;
importjavax.swing.JPasswordField;

/**
 * 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
 * @see View
 */
publicclassPasswordViewextendsFieldView {

/**
 * Constructs a new view wrapped on an element.
 *
 * @param elem the element
 */
publicPasswordView(Elementelem) {
super(elem);
 }

/**
 * 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
 * @throws BadLocationException if p0 or p1 are out of range
 *
 * @deprecated replaced by
 * {@link #drawUnselectedText(Graphics2D, float, float, int, int)}
 */
@Deprecated(since = "9")
@Override
protectedintdrawUnselectedText(Graphicsg, intx, inty,
intp0, intp1) throwsBadLocationException {
return (int) drawUnselectedTextImpl(g, x, y, p0, p1, false);
 }

@Override
protectedfloatdrawUnselectedText(Graphics2Dg, floatx, floaty,
intp0, intp1)
throwsBadLocationException
 {
returndrawUnselectedTextImpl(g, x, y, p0, p1, true);
 }

@SuppressWarnings("deprecation")
privatefloatdrawUnselectedTextImpl(Graphicsg, floatx, floaty,
intp0, intp1,
booleanuseFPAPI)
throwsBadLocationException
 {
Containerc = getContainer();
if (cinstanceofJPasswordField) {
JPasswordFieldf = (JPasswordField) c;
if (!f.echoCharIsSet()) {
booleanuseDrawUnselectedFPAPI = useFPAPI
 && drawUnselectedTextOverridden
 && ginstanceofGraphics2D;
return (useDrawUnselectedFPAPI )
 ? super.drawUnselectedText((Graphics2D) g, x, y, p0, p1)
 : super.drawUnselectedText(g, (int) x, (int) y, p0, p1);
 }
if (f.isEnabled()) {
g.setColor(f.getForeground());
 }
else {
g.setColor(f.getDisabledTextColor());
 }
charechoChar = f.getEchoChar();
intn = p1 - p0;
booleanuseEchoCharFPAPI = useFPAPI
 && drawEchoCharacterOverridden
 && ginstanceofGraphics2D;
for (inti = 0; i < n; i++) {
x = (useEchoCharFPAPI)
 ? drawEchoCharacter((Graphics2D) g, x, y, echoChar)
 : drawEchoCharacter(g, (int) x, (int) y, echoChar);
 }
 }
returnx;
 }

/**
 * 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 &gt;= 0
 * @param y the starting Y coordinate &gt;= 0
 * @param p0 the starting offset in the model &gt;= 0
 * @param p1 the ending offset in the model &gt;= p0
 * @return the X location of the end of the range &gt;= 0
 * @throws BadLocationException if p0 or p1 are out of range
 *
 * @deprecated replaced by
 * {@link #drawSelectedText(Graphics2D, float, float, int, int)}
 */
@Deprecated(since = "9")
@Override
protectedintdrawSelectedText(Graphicsg, intx,
inty, intp0, intp1) throwsBadLocationException {
return (int) drawSelectedTextImpl(g, x, y, p0, p1, false);
 }

@Override
protectedfloatdrawSelectedText(Graphics2Dg, floatx, floaty,
intp0, intp1) throwsBadLocationException
 {
returndrawSelectedTextImpl(g, x, y, p0, p1, true);
 }

@SuppressWarnings("deprecation")
privatefloatdrawSelectedTextImpl(Graphicsg, floatx, floaty,
intp0, intp1,
booleanuseFPAPI)
throwsBadLocationException {
g.setColor(selected);
Containerc = getContainer();
if (cinstanceofJPasswordField) {
JPasswordFieldf = (JPasswordField) c;
if (!f.echoCharIsSet()) {
booleanuseDrawUnselectedFPAPI = useFPAPI
 && drawSelectedTextOverridden
 && ginstanceofGraphics2D;
return (useFPAPI)
 ? super.drawSelectedText((Graphics2D) g, x, y, p0, p1)
 : super.drawSelectedText(g, (int) x, (int) y, p0, p1);
 }
charechoChar = f.getEchoChar();
intn = p1 - p0;
booleanuseEchoCharFPAPI = useFPAPI
 && drawEchoCharacterOverridden
 && ginstanceofGraphics2D;
for (inti = 0; i < n; i++) {
x = (useEchoCharFPAPI)
 ? drawEchoCharacter((Graphics2D) g, x, y, echoChar)
 : drawEchoCharacter(g, (int) x, (int) y, echoChar);

 }
 }
returnx;
 }

/**
 * 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 &gt;= 0
 * @param y the starting Y coordinate &gt;= 0
 * @param c the echo character
 * @return the updated X position &gt;= 0
 *
 * @deprecated replaced by
 * {@link #drawEchoCharacter(Graphics2D, float, float, char)}
 */
@Deprecated(since = "9")
protectedintdrawEchoCharacter(Graphicsg, intx, inty, charc) {
return (int) drawEchoCharacterImpl(g, x, y, c, false);
 }

/**
 * 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 {@code >= 0}
 * @param y the starting Y coordinate {@code >= 0}
 * @param c the echo character
 * @return the updated X position {@code >= 0}
 *
 * @since 9
 */
protectedfloatdrawEchoCharacter(Graphics2Dg, floatx, floaty, charc) {
returndrawEchoCharacterImpl(g, x, y, c, true);
 }

privatefloatdrawEchoCharacterImpl(Graphicsg, floatx, floaty,
charc, booleanuseFPAPI) {
ONE[0] = c;
SwingUtilities2.drawChars(Utilities.getJComponent(this),
g, ONE, 0, 1, x, y);
if (useFPAPI) {
returnx + g.getFontMetrics().charWidth(c);
 } else {
FontRenderContextfrc = g.getFontMetrics().getFontRenderContext();
returnx + (float) g.getFont().getStringBounds(ONE, 0, 1, frc).getWidth();
 }
 }

/**
 * 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 &gt;= 0
 * @param a the allocated region to render into
 * @return the bounding box of the given position
 * @throws BadLocationException if the given position does not
 * represent a valid location in the associated document
 * @see View#modelToView
 */
publicShapemodelToView(intpos, Shapea, Position.Biasb) throwsBadLocationException {
Containerc = getContainer();
if (cinstanceofJPasswordField) {
JPasswordFieldf = (JPasswordField) c;
if (! f.echoCharIsSet()) {
returnsuper.modelToView(pos, a, b);
 }
charechoChar = f.getEchoChar();
FontMetricsm = f.getFontMetrics(f.getFont());

Rectanglealloc = adjustAllocation(a).getBounds();
intdx = (pos - getStartOffset()) * m.charWidth(echoChar);
alloc.x += dx;
alloc.width = 1;
returnalloc;
 }
returnnull;
 }

/**
 * Provides a mapping from the view coordinate space to the logical
 * coordinate space of the model.
 *
 * @param fx the X coordinate &gt;= 0.0f
 * @param fy the Y coordinate &gt;= 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
 */
publicintviewToModel(floatfx, floatfy, Shapea, Position.Bias[] bias) {
bias[0] = Position.Bias.Forward;
intn = 0;
Containerc = getContainer();
if (cinstanceofJPasswordField) {
JPasswordFieldf = (JPasswordField) c;
if (! f.echoCharIsSet()) {
returnsuper.viewToModel(fx, fy, a, bias);
 }
charechoChar = f.getEchoChar();
intcharWidth = f.getFontMetrics(f.getFont()).charWidth(echoChar);
a = adjustAllocation(a);
Rectanglealloc = (ainstanceofRectangle) ? (Rectangle)a :
a.getBounds();
n = (charWidth > 0 ?
 ((int)fx - alloc.x) / charWidth : Integer.MAX_VALUE);
if (n < 0) {
n = 0;
 }
elseif (n > (getStartOffset() + getDocument().getLength())) {
n = getDocument().getLength() - getStartOffset();
 }
 }
returngetStartOffset() + 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 &gt;= 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.
 */
publicfloatgetPreferredSpan(intaxis) {
switch (axis) {
caseView.X_AXIS:
Containerc = getContainer();
if (cinstanceofJPasswordField) {
JPasswordFieldf = (JPasswordField) c;
if (f.echoCharIsSet()) {
charechoChar = f.getEchoChar();
FontMetricsm = f.getFontMetrics(f.getFont());
Documentdoc = getDocument();
returnm.charWidth(echoChar) * getDocument().getLength();
 }
 }
 }
returnsuper.getPreferredSpan(axis);
 }

staticchar[] ONE = newchar[1];

privatefinalbooleandrawEchoCharacterOverridden =
getFPMethodOverridden(getClass(), "drawEchoCharacter", FPMethodArgs.GNNC);
}