org.eclipse.nebula.widgets.nattable.core/src/org/eclipse/nebula/widgets/nattable/edit/editor/PasswordCellEditor.java

/*******************************************************************************
 * Copyright (c) 2012, 2020 Original authors and others.
 *
 * This program and the accompanying materials are made
 * available under the terms of the Eclipse Public License 2.0
 * which is available at https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     Original authors and others - initial API and implementation
 ******************************************************************************/
package org.eclipse.nebula.widgets.nattable.edit.editor;

import org.eclipse.nebula.widgets.nattable.painter.cell.PasswordTextPainter;
import org.eclipse.nebula.widgets.nattable.style.CellStyleAttributes;
import org.eclipse.nebula.widgets.nattable.style.HorizontalAlignmentEnum;
import org.eclipse.nebula.widgets.nattable.widget.EditModeEnum;
import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Text;

/**
 * Specialised {@link TextCellEditor} that sets the echo char of the text
 * control used by this editor to a configured character. You can configure the
 * echo character by setting the attribute
 * {@link CellStyleAttributes#PASSWORD_ECHO_CHAR} to the cell style to use. If
 * there is no echo character configured, the bullet character will be used.
 *
 * <p>
 * As the anonymization of the inserted value only relates to the {@link Text}
 * control, ensure to also register the {@link PasswordTextPainter} so the value
 * is not shown in clear text after commit.
 *
 * @see PasswordTextPainter
 */
public class PasswordCellEditor extends TextCellEditor {

    /**
     * Creates a PasswordCellEditor that will not commit a value on pressing the
     * up or the down key.
     */
    public PasswordCellEditor() {
        this(false);
    }

    /**
     * Creates a PasswordCellEditor.
     *
     * @param commitOnUpDown
     *            Flag to configure whether the editor should commit and move
     *            the selection in the corresponding way if the up or down key
     *            is pressed.
     */
    public PasswordCellEditor(boolean commitOnUpDown) {
        super(commitOnUpDown);
    }

    @Override
    public Text createEditorControl(Composite parent) {
        int style = HorizontalAlignmentEnum.getSWTStyle(this.cellStyle)
                | SWT.PASSWORD;
        if (this.editMode == EditModeEnum.DIALOG) {
            style = style | SWT.BORDER;
        }

        final Text textControl = super.createEditorControl(parent, style);

        // search for the configured echo character within the ConfigRegistry
        Character configEchoChar = this.cellStyle
                .getAttributeValue(CellStyleAttributes.PASSWORD_ECHO_CHAR);
        // set the echo char of the Text control to the configured one or if
        // there is
        // none configured, set the bullet char
        textControl.setEchoChar(configEchoChar != null ? configEchoChar
                : '\u2022');

        return textControl;
    }

}