org.apache.directory.studio.connection.ui.dialogs.PasswordDialog.java Source code

Introduction

Here is the source code for org.apache.directory.studio.connection.ui.dialogs.PasswordDialog.java

Source

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you 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 org.apache.directory.studio.connection.ui.dialogs;

import org.apache.commons.lang.StringUtils;
import org.apache.directory.studio.common.ui.CommonUIUtils;
import org.apache.directory.studio.common.ui.widgets.BaseWidgetUtils;
import org.eclipse.jface.dialogs.Dialog;
import org.eclipse.jface.dialogs.IDialogConstants;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.Text;

/**
 * The PasswordDialog is used to ask the user for password (credentials).
 * <p>
 * It has a useful checkbox that can show/hide the typed password.
 * <pre>
 * .--------------------------------------------------.
 * |            Enter password for "xxxxx"            |
 * +--------------------------------------------------+
 * | Please enter password of user "yyyyyyyyyyyyy"    |
 * | [----------------------------------------------] |
 * | [ ] Show password                                |
 * |                                                  |
 * |                                (Cancel) (  OK  ) |
 * .__________________________________________________.
 * </pre>
 *
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 */
public class PasswordDialog extends Dialog {
    /** The title of the dialog */
    private String title;

    /** The message to display, or <code>null</code> if none */
    private String message;

    /** The input value; the empty string by default */
    private String value = StringUtils.EMPTY;//$NON-NLS-1$

    // UI Widgets
    /** The password Text widget */
    private Text passwordText;

    /** The Show Password text widget */
    private Button showPasswordCheckbox;

    /**
     * Creates a new instance of CredentialsDialog.
     * 
     * @param parentShell the parent shell
     * @param title the title
     * @param message the dialog message
     * @param initialValue the initial value
     */
    public PasswordDialog(Shell parentShell, String title, String message, String initialValue) {
        super(parentShell);
        this.title = title;
        this.message = message;

        if (initialValue == null) {
            value = StringUtils.EMPTY;//$NON-NLS-1$
        } else {
            value = initialValue;
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    protected void configureShell(Shell shell) {
        super.configureShell(shell);

        shell.setText(CommonUIUtils.getTextValue(title));
    }

    /**
     * {@inheritDoc}
     */
    @Override
    protected void buttonPressed(int buttonId) {
        if (buttonId == IDialogConstants.OK_ID) {
            value = passwordText.getText();
        } else {
            value = null;
        }

        super.buttonPressed(buttonId);
    }

    /**
     * The listener for the ShowPassword checkbox
     */
    private SelectionAdapter showPasswordCheckboxListener = new SelectionAdapter() {
        /**
         * {@inheritDoc}
         */
        @Override
        public void widgetSelected(SelectionEvent event) {
            if (showPasswordCheckbox.getSelection()) {
                passwordText.setEchoChar('\0');
            } else {
                passwordText.setEchoChar('\u2022');
            }
        }
    };

    /**
     * {@inheritDoc}
     */
    @Override
    protected Control createDialogArea(Composite parent) {
        // Composite
        Composite composite = new Composite(parent, SWT.NONE);
        GridLayout layout = new GridLayout();
        layout.marginHeight = convertVerticalDLUsToPixels(IDialogConstants.VERTICAL_MARGIN);
        layout.marginWidth = convertHorizontalDLUsToPixels(IDialogConstants.HORIZONTAL_MARGIN);
        layout.verticalSpacing = convertVerticalDLUsToPixels(IDialogConstants.VERTICAL_SPACING);
        layout.horizontalSpacing = convertHorizontalDLUsToPixels(IDialogConstants.HORIZONTAL_SPACING);
        composite.setLayout(layout);
        GridData compositeGridData = new GridData(SWT.FILL, SWT.FILL, true, true);
        compositeGridData.widthHint = convertHorizontalDLUsToPixels(IDialogConstants.MINIMUM_MESSAGE_AREA_WIDTH);
        composite.setLayoutData(compositeGridData);

        // Message
        if (message != null) {
            Label messageLabel = BaseWidgetUtils.createWrappedLabel(composite, message, 1);
            GridData messageLabelGridData = new GridData(SWT.FILL, SWT.CENTER, true, true);
            messageLabelGridData.widthHint = convertHorizontalDLUsToPixels(
                    IDialogConstants.MINIMUM_MESSAGE_AREA_WIDTH);
            messageLabel.setLayoutData(messageLabelGridData);
        }

        // Password Text
        passwordText = BaseWidgetUtils.createText(composite, value, 1);
        passwordText.setEchoChar('\u2022');

        // Show Password Checkbox
        showPasswordCheckbox = BaseWidgetUtils.createCheckbox(composite,
                Messages.getString("PasswordDialog.ShowPassword"), 1); //$NON-NLS-1$
        showPasswordCheckbox.addSelectionListener(showPasswordCheckboxListener);

        // Setting focus
        passwordText.setFocus();
        applyDialogFont(composite);

        return composite;
    }

    /**
     * Returns the string typed into this password dialog.
     * 
     * @return the input string
     */
    public String getPassword() {
        return value;
    }
}