impl.org.controlsfx.autocompletion.AutoCompletionTextFieldBinding 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 impl.org.controlsfx.autocompletion;
import java.util.Collection;
import javafx.beans.value.ChangeListener;
import javafx.beans.value.ObservableValue;
import javafx.scene.control.TextField;
import javafx.util.Callback;
import javafx.util.StringConverter;
import org.controlsfx.control.textfield.AutoCompletionBinding;
/**
* Represents a binding between a text field and a auto-completion popup
*
* @param
*/
public class AutoCompletionTextFieldBinding extends AutoCompletionBinding{
/***************************************************************************
* *
* Static properties and methods *
* *
**************************************************************************/
private static StringConverter defaultStringConverter() {
return new StringConverter() {
@Override public String toString(T t) {
return t == null ? null : t.toString();
}
@SuppressWarnings("unchecked")
@Override public T fromString(String string) {
return (T) string;
}
};
}
/***************************************************************************
* *
* Private fields *
* *
**************************************************************************/
/**
* String converter to be used to convert suggestions to strings.
*/
private StringConverter converter;
/***************************************************************************
* *
* Constructors *
* *
**************************************************************************/
/**
* Creates a new auto-completion binding between the given textField
* and the given suggestion provider.
*
* @param textField
* @param suggestionProvider
*/
public AutoCompletionTextFieldBinding(final TextField textField,
Callback> suggestionProvider) {
this(textField, suggestionProvider, AutoCompletionTextFieldBinding
.defaultStringConverter());
}
/**
* Creates a new auto-completion binding between the given textField
* and the given suggestion provider.
*
* @param textField
* @param suggestionProvider
*/
public AutoCompletionTextFieldBinding(final TextField textField,
Callback> suggestionProvider,
final StringConverter converter) {
super(textField, suggestionProvider, converter);
this.converter = converter;
getCompletionTarget().textProperty().addListener(textChangeListener);
getCompletionTarget().focusedProperty().addListener(focusChangedListener);
}
/***************************************************************************
* *
* Public API *
* *
**************************************************************************/
/** {@inheritDoc} */
@Override public TextField getCompletionTarget(){
return (TextField)super.getCompletionTarget();
}
/** {@inheritDoc} */
@Override public void dispose(){
getCompletionTarget().textProperty().removeListener(textChangeListener);
getCompletionTarget().focusedProperty().removeListener(focusChangedListener);
}
/** {@inheritDoc} */
@Override protected void completeUserInput(T completion){
String newText = converter.toString(completion);
getCompletionTarget().setText(newText);
getCompletionTarget().positionCaret(newText.length());
}
/***************************************************************************
* *
* Event Listeners *
* *
**************************************************************************/
private final ChangeListener textChangeListener = new ChangeListener() {
@Override public void changed(ObservableValue obs, String oldText, String newText) {
if (getCompletionTarget().isFocused()) {
setUserInput(newText);
}
}
};
private final ChangeListener focusChangedListener = new ChangeListener() {
@Override public void changed(ObservableValue obs, Boolean oldFocused, Boolean newFocused) {
if(newFocused == false)
hidePopup();
}
};
}