com.globalmentor.swing.PasswordPanel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of globalmentor-swing Show documentation
GlobalMentor Java Swing library.
The newest version!
/*
 * Copyright © 1996-2009 GlobalMentor, Inc. 
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.globalmentor.swing;

import java.awt.GridBagConstraints;
import java.awt.Insets;
import java.util.Arrays;
import javax.swing.*;

import com.globalmentor.awt.BasicGridBagLayout;

/**
 * Allows entry and optional verification of a password.
 * @author Garret Wilson
 */
public class PasswordPanel extends BasicPanel {

	/** An object specifying insets for labels. */
	private static final Insets LABEL_INSETS = new Insets(0, 0, 0, 4);
	/** An object specifying insets for fields. */
	private static final Insets FIELD_INSETS = new Insets(0, 0, 8, 0);

	/** The label of the password entry. */
	protected final JLabel passwordLabel;
	/** The password text field. */
	protected final JPasswordField passwordField;

	/** @return The current password value. */
	public char[] getPassword() {
		return passwordField.getPassword();
	}

	/** The label of the password verifications entry. */
	protected final JLabel passwordVerificationLabel;
	/** The password verification text field. */
	protected final JPasswordField passwordVerificationField;

	/** Whether the entered password should be verified; defaults to false. */
	private boolean verifyPassword;

	/** @return Whether the entered password should be verified; defaults to false. */
	public boolean isVerifyPassword() {
		return verifyPassword;
	}

	/**
	 * Specifies whether the entered password should be verified.
	 * @param verify Whether the entered password should be verified.
	 */
	public void setVerifyPassword(final boolean verify) {
		verifyPassword = verify; //update the password verification
		updateStatus(); //show or hide the password verification
	}

	/** Default constructor with no password verification. */
	public PasswordPanel() {
		this(false); //construct the panel with no password verification
	}

	/**
	 * Verification constructor.
	 * @param verify The true if a password verification entry field should be provided.
	 */
	public PasswordPanel(final boolean verify) {
		super(new BasicGridBagLayout(), false); //construct the panel using a grid bag layout, but don't initialize the panel
		passwordLabel = new JLabel();
		passwordField = new JPasswordField();
		passwordVerificationLabel = new JLabel();
		passwordVerificationField = new JPasswordField();
		setDefaultFocusComponent(passwordField); //set the default focus component
		initialize(); //initialize the panel
		setVerifyPassword(verify); //set whether we should verify the password
	}

	/** Initializes the user interface. */
	public void initializeUI() {
		super.initializeUI(); //do the default user interface initialization
		passwordLabel.setText("Password"); //TODO i18n
		passwordField.setColumns(16);
		passwordVerificationLabel.setText("Password Verification"); //TODO i18n
		passwordVerificationLabel.setVisible(false); //start out assuming we shouldn't verify the password
		passwordVerificationField.setColumns(16);
		passwordVerificationField.setVisible(false); //start out assuming we shouldn't verify the password
		add(passwordLabel, new GridBagConstraints(0, 0, 1, 1, 0.0, 0.0, GridBagConstraints.NORTHWEST, GridBagConstraints.NONE, LABEL_INSETS, 0, 0));
		add(passwordField, new GridBagConstraints(1, 0, 1, 1, 0.0, 0.0, GridBagConstraints.NORTHWEST, GridBagConstraints.NONE, FIELD_INSETS, 0, 0));
		add(passwordVerificationLabel, new GridBagConstraints(0, 1, 1, 1, 0.0, 0.0, GridBagConstraints.NORTHWEST, GridBagConstraints.NONE, LABEL_INSETS, 0, 0));
		add(passwordVerificationField, new GridBagConstraints(1, 1, 1, 1, 0.0, 0.0, GridBagConstraints.NORTHWEST, GridBagConstraints.NONE, FIELD_INSETS, 0, 0));
	}

	/**
	 * Updates the states of the actions, including enabled/disabled status, proxied actions, etc.
	 */
	public void updateStatus() {
		super.updateStatus(); //do the default updating
		passwordVerificationLabel.setVisible(isVerifyPassword()); //only show the password verification if we should verify the password
		passwordVerificationField.setVisible(isVerifyPassword()); //only show the password verification if we should verify the password
	}

	/**
	 * Verifies the component.
	 * @return true if the component contents are valid, false if not.
	 */
	public boolean verify() {
		//if we should verify password and the passwords don't match
		if(isVerifyPassword() && !Arrays.equals(passwordField.getPassword(), passwordVerificationField.getPassword())) {
			JOptionPane.showMessageDialog(this, "Please verify the entered password by entering the same password in both fields.", "Invalid password",
					JOptionPane.ERROR_MESSAGE); //TODO i18n
			passwordVerificationField.requestFocusInWindow(); //focus on the password verificiation field
			return false; //show that verification failed			
		}
		return super.verify(); //if we couldn't find any problems, verify the parent class
	}

}