Skip to content

Commit

Permalink
Updated class level documentation on SearchTextField.
Browse files Browse the repository at this point in the history
  • Loading branch information
dlemmermann committed May 10, 2024
1 parent 7083a55 commit 8019dce
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions gemsfx/src/main/java/com/dlsc/gemsfx/SearchTextField.java
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,9 @@
* A custom text field specifically designed for search functionality. This class enhances a text field with features
* such as a history of search terms, an optional history popup, and custom icons for search and clear operations.
* <p>
* By default, when the user presses the "enter" key (triggering the onAction event), the text is added to the history.
* This behavior can be disabled by setting the {@link #addingItemToHistoryOnEnterProperty()}.
* By default, when the field loses its focus or the user presses the "enter" key (triggering the onAction event), the
* text is added to the history. This behavior can be disabled by setting the {@link #addingItemToHistoryOnEnterProperty()}
* and / or the {@link #addingItemToHistoryOnEnterProperty()} to false.
* <br>
* Additionally, history can be manually added based on user actions, such as after typing text and selecting an item
* from a ListView or TableView that displays results, or through other interactions, by calling the {@link #addHistory}
Expand Down

0 comments on commit 8019dce

Please sign in to comment.