org.controlsfx.control.textfield.TextFields Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of controlsfx Show documentation
Show all versions of controlsfx Show documentation
High quality UI controls and other tools to complement the core JavaFX distribution
/**
* Copyright (c) 2014, 2015, 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.autocompletion.AutoCompletionTextFieldBinding;
import impl.org.controlsfx.autocompletion.SuggestionProvider;
import java.util.Arrays;
import java.util.Collection;
import javafx.animation.FadeTransition;
import javafx.beans.InvalidationListener;
import javafx.beans.Observable;
import javafx.beans.property.ObjectProperty;
import javafx.scene.Cursor;
import javafx.scene.Node;
import javafx.scene.control.PasswordField;
import javafx.scene.control.TextField;
import javafx.scene.layout.Region;
import javafx.scene.layout.StackPane;
import javafx.util.Callback;
import javafx.util.Duration;
import javafx.util.StringConverter;
import org.controlsfx.control.textfield.AutoCompletionBinding.ISuggestionRequest;
/**
* A class containing useful customizations for the JavaFX {@link TextField}.
* Note that this class is experimental and the API may change in future
* releases. Note also that this class makes use of the {@link CustomTextField}
* class.
*
* @see CustomTextField
*/
public class TextFields {
private static final Duration FADE_DURATION = Duration.millis(350);
private TextFields() {
// no-op
}
/***************************************************************************
* *
* Search fields *
* *
**************************************************************************/
/**
* Creates a TextField that shows a clear button inside the TextField (on
* the right hand side of it) when text is entered by the user.
*/
public static TextField createClearableTextField() {
CustomTextField inputField = new CustomTextField();
setupClearButtonField(inputField, inputField.rightProperty());
return inputField;
}
/**
* Creates a PasswordField that shows a clear button inside the PasswordField
* (on the right hand side of it) when text is entered by the user.
*/
public static PasswordField createClearablePasswordField() {
CustomPasswordField inputField = new CustomPasswordField();
setupClearButtonField(inputField, inputField.rightProperty());
return inputField;
}
private static void setupClearButtonField(TextField inputField, ObjectProperty rightProperty) {
inputField.getStyleClass().add("clearable-field"); //$NON-NLS-1$
Region clearButton = new Region();
clearButton.getStyleClass().addAll("graphic"); //$NON-NLS-1$
StackPane clearButtonPane = new StackPane(clearButton);
clearButtonPane.getStyleClass().addAll("clear-button"); //$NON-NLS-1$
clearButtonPane.setOpacity(0.0);
clearButtonPane.setCursor(Cursor.DEFAULT);
clearButtonPane.setOnMouseReleased(e -> inputField.clear());
clearButtonPane.managedProperty().bind(inputField.editableProperty());
clearButtonPane.visibleProperty().bind(inputField.editableProperty());
rightProperty.set(clearButtonPane);
final FadeTransition fader = new FadeTransition(FADE_DURATION, clearButtonPane);
fader.setCycleCount(1);
inputField.textProperty().addListener(new InvalidationListener() {
@Override public void invalidated(Observable arg0) {
String text = inputField.getText();
boolean isTextEmpty = text == null || text.isEmpty();
boolean isButtonVisible = fader.getNode().getOpacity() > 0;
if (isTextEmpty && isButtonVisible) {
setButtonVisible(false);
} else if (!isTextEmpty && !isButtonVisible) {
setButtonVisible(true);
}
}
private void setButtonVisible( boolean visible ) {
fader.setFromValue(visible? 0.0: 1.0);
fader.setToValue(visible? 1.0: 0.0);
fader.play();
}
});
}
/***************************************************************************
* *
* Auto-completion *
* *
**************************************************************************/
/**
* Create a new auto-completion binding between the given textField and the
* given suggestion provider.
*
* The {@link TextFields} API has some suggestion-provider builder methods
* for simple use cases.
*
* @param textField The {@link TextField} to which auto-completion shall be added
* @param suggestionProvider A suggestion-provider strategy to use
* @param converter The converter to be used to convert suggestions to strings
*/
public static AutoCompletionBinding bindAutoCompletion(TextField textField,
Callback> suggestionProvider,
StringConverter converter) {
return new AutoCompletionTextFieldBinding<>(textField,
suggestionProvider, converter);
}
/**
* Create a new auto-completion binding between the given textField and the
* given suggestion provider.
*
* The {@link TextFields} API has some suggestion-provider builder methods
* for simple use cases.
*
* @param textField The {@link TextField} to which auto-completion shall be added
* @param suggestionProvider A suggestion-provider strategy to use
* @return The AutoCompletionBinding
*/
public static AutoCompletionBinding bindAutoCompletion(TextField textField,
Callback> suggestionProvider){
return new AutoCompletionTextFieldBinding<>(textField, suggestionProvider);
}
/**
* Create a new auto-completion binding between the given {@link TextField}
* using the given auto-complete suggestions
*
* @param textField The {@link TextField} to which auto-completion shall be added
* @param possibleSuggestions Possible auto-complete suggestions
* @return The AutoCompletionBinding
*/
public static AutoCompletionBinding bindAutoCompletion(
TextField textField, @SuppressWarnings("unchecked") T... possibleSuggestions) {
return bindAutoCompletion(textField, Arrays.asList(possibleSuggestions));
}
public static AutoCompletionBinding bindAutoCompletion(
TextField textField, Collection possibleSuggestions) {
return new AutoCompletionTextFieldBinding<>(textField,
SuggestionProvider.create(possibleSuggestions));
}
}