public Class SearchTextField

Determines whether the text of the text field should be added to the history when the user presses the Enter key.

Returns:BooleanProperty

true if the text should be added to the history on Enter, false otherwise

Determines whether the text of the text field should be added to the history when the field losses its focus.

Returns:BooleanProperty

true if the text should be added to the history on focus lost, false otherwise

Overrides org.controlsfx.control.textfield.CustomTextField.getUserAgentStylesheet.

Doc from org.controlsfx.control.textfield.CustomTextField.getUserAgentStylesheet.

An implementation may specify its own user-agent styles for this Region, and its children, by overriding this method. These styles are used in addition to whatever user-agent stylesheets are in use. This provides a mechanism for third parties to introduce styles for custom controls.

The URL is a hierarchical URI of the form [scheme:][//authority][path]. If the URL does not have a [scheme:] component, the URL is considered to be the [path] component only. Any leading '/' character of the [path] is ignored and the [path] is treated as a path relative to the root of the application's classpath.

Subclasses overriding this method should not assume any particular implementation approach as to the number and frequency with which it is called. For this reason, attempting any kind of dynamic implementation (i.e. returning different user agent stylesheet values) based on some state change is highly discouraged, as there is no guarantee when, or even if, this method will be called. Some JavaFX CSS implementations may choose to cache this response for an indefinite period of time, and therefore there should be no expectation around when this method is called.

package com.example.javafx.app;

import javafx.application.Application;
import javafx.scene.Group;
import javafx.scene.Scene;
import javafx.stage.Stage;

public class MyApp extends Application {

    @Override public void start(Stage stage) {
        Scene scene = new Scene(new Group());
        scene.getStylesheets().add("/com/example/javafx/app/mystyles.css");
        stage.setScene(scene);
        stage.show();
    }

    public static void main(String[] args) {
        launch(args);
    }
}

Annotations

@Override

The history manager that is used to manage the history of the search text field.

If its value is null, the history feature will not be enabled, which means only the magnifying glass icon will be displayed, and the dropdown arrow next to the magnifying glass will not be shown.

If its value is not null, the history feature will be enabled, meaning that both the magnifying glass icon and the dropdown arrow will be displayed. Clicking the magnifying glass icon button will display the history popup.

To enable the history feature, you need to set an instance of HistoryManager. Typically, you would use an instance of StringHistoryManager, which is an implementation of HistoryManager that manages string-type history records.

Returns:ObjectProperty<HistoryManager<String>>

the property representing the history manager

Returns the property representing the history placeholder node.

Returns:ObjectProperty<Node>

the property representing the history placeholder node

Determines whether the text field should have round corners.

Returns:BooleanProperty

true if the text field should have round corners, false otherwise