org.controlsfx.control.textfield.CustomPasswordField Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of controlsfx Show documentation
High quality UI controls and other tools to complement the core JavaFX distribution
There is a newer version: 11.2.1
/**
 * Copyright (c) 2014, ControlsFX
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *     * Neither the name of ControlsFX, any associated website, nor the
 * names of its contributors may be used to endorse or promote products
 * derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL CONTROLSFX BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.controlsfx.control.textfield;

import impl.org.controlsfx.skin.CustomTextFieldSkin;
import javafx.beans.property.ObjectProperty;
import javafx.beans.property.SimpleObjectProperty;
import javafx.scene.Node;
import javafx.scene.control.PasswordField;
import javafx.scene.control.Skin;

/**
 * A base class for people wanting to customize a {@link PasswordField} to contain nodes
 * inside the input field area itself, without being on top of the users typed-in text.
 * 
 * Whilst not exactly the same, refer to the {@link CustomTextField} javadoc
 * for a screenshot and more detail. The obvious difference is that of course
 * the CustomPasswordField masks the input from users, but in all other ways
 * is equivalent to {@link CustomTextField}.
 * 
 * @see CustomPasswordField
 * @see TextFields
 */
public class CustomPasswordField extends PasswordField {

    /**************************************************************************
     * 
     * Private fields
     * 
     **************************************************************************/
    

    
    
    /**************************************************************************
     * 
     * Constructors
     * 
     **************************************************************************/
    
    /**
     * Instantiates a default CustomPasswordField.
     */
    public CustomPasswordField() {
        getStyleClass().addAll("custom-text-field", "custom-password-field"); //$NON-NLS-1$ //$NON-NLS-2$
    }

    
    
    /**************************************************************************
     * 
     * Properties
     * 
     **************************************************************************/
    
    // --- left
    private ObjectProperty left = new SimpleObjectProperty<>(this, "left"); //$NON-NLS-1$
    
    /**
     * Property representing the {@link Node} that is placed on the left of
     * the password field.
     * @return An ObjectProperty.
     */
    public final ObjectProperty leftProperty() {
        return left;
    }
    
    /**
     * 
     * @return The {@link Node} that is placed on the left of
     * the password field.
     */
    public final Node getLeft() {
        return left.get();
    }
    
    /**
     * Sets the {@link Node} that is placed on the left of
     * the password field.
     * @param value 
     */
    public final void setLeft(Node value) {
        left.set(value);
    }
    
    
    // --- right
    private ObjectProperty right = new SimpleObjectProperty<>(this, "right"); //$NON-NLS-1$
    
    /**
     * Property representing the {@link Node} that is placed on the right of
     * the password field.
     * @return An ObjectProperty.
     */
    public final ObjectProperty rightProperty() {
        return right;
    }
    
    /**
     * 
     * @return The {@link Node} that is placed on the right of
     * the password field.
     */
    public final Node getRight() {
        return right.get();
    }
    
    /**
     * Sets the {@link Node} that is placed on the right of
     * the password field.
     * @param value 
     */
    public final void setRight(Node value) {
        right.set(value);
    }
    
    
    
    /**************************************************************************
     * 
     * Public API
     * 
     **************************************************************************/
    
    /**
     * {@inheritDoc}
     */
    @Override protected Skin createDefaultSkin() {
        return new CustomTextFieldSkin(this) {
            @Override public ObjectProperty leftProperty() {
                return CustomPasswordField.this.leftProperty();
            }
            
            @Override public ObjectProperty rightProperty() {
                return CustomPasswordField.this.rightProperty();
            }
        };
    }
    
    /**
     * {@inheritDoc}
     */
    @Override public String getUserAgentStylesheet() {
        return CustomTextField.class.getResource("customtextfield.css").toExternalForm(); //$NON-NLS-1$
    }
    
}