Skip to content

Commit

Permalink
Update the JavaDoc documentation for SearchTextField and SearchField.
Browse files Browse the repository at this point in the history
  • Loading branch information
leewyatt committed May 31, 2024
1 parent 8356733 commit cc9ea36
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 15 deletions.
7 changes: 0 additions & 7 deletions gemsfx/src/main/java/com/dlsc/gemsfx/SearchField.java
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,6 @@
* The history manager is disabled by default, but it can be enabled using the {@link #setHistoryManager(HistoryManager)} method.
* We have implemented a local history manager, {@link StringHistoryManager}, which uses the Java Preferences API to store history records.
* You can enable it via the {@link #setHistoryManager(HistoryManager)} method.
* If you want to persistently store history records, you also need to provide a {@link java.util.prefs.Preferences} instance to the {@link StringHistoryManager}.
* Otherwise, the history records will be lost after the application restarts.
* </p>
*
* @param <T> the type of objects to work on
Expand Down Expand Up @@ -1277,11 +1275,6 @@ public final void setAddingItemToHistoryOnCommit(boolean addingItemToHistoryOnCo
* To enable the history feature, you need to set an instance of {@link HistoryManager}.
* Typically, you would use an instance of {@link StringHistoryManager}, which is an
* implementation of {@link HistoryManager} that manages string-type history records.
* <p>
* Please note that if you do not set the {@code StringHistoryManager#setPreferences(Preferences)}
* method for the {@link StringHistoryManager} instance, the history records will only be saved
* in memory and will not be persisted locally. This means that the history data will not be
* retained after the application is closed.
*
* @return the property representing the history manager
*/
Expand Down
9 changes: 1 addition & 8 deletions gemsfx/src/main/java/com/dlsc/gemsfx/SearchTextField.java
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,14 @@
* The history manager is disabled by default, but it can be enabled using the {@link #setHistoryManager(HistoryManager)} method.
* We have implemented a local history manager, {@link StringHistoryManager}, which uses the Java Preferences API to store history records.
* You can enable it via the {@link #setHistoryManager(HistoryManager)} method.
* If you want to persistently store history records, you also need to provide a {@link java.util.prefs.Preferences} instance to the {@link StringHistoryManager}.
* Otherwise, the history records will be lost after the application restarts.
* <p>
* 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 #getHistoryManager()}
* method to access the {@link StringHistoryManager} instance. then calling the {@link StringHistoryManager#add(String)} method.
* method to access the {@link StringHistoryManager} instance. then calling the {@link StringHistoryManager#add(Object)}} method.
*/
public class SearchTextField extends CustomTextField {

Expand Down Expand Up @@ -257,11 +255,6 @@ public final void setRound(boolean round) {
* To enable the history feature, you need to set an instance of {@link HistoryManager}.
* Typically, you would use an instance of {@link StringHistoryManager}, which is an
* implementation of {@link HistoryManager} that manages string-type history records.
* <p>
* Please note that if you do not set the {@code StringHistoryManager#setPreferences(Preferences)}
* method for the {@link StringHistoryManager} instance, the history records will only be saved
* in memory and will not be persisted locally. This means that the history data will not be
* retained after the application is closed.
*
* @return the property representing the history manager
*/
Expand Down

0 comments on commit cc9ea36

Please sign in to comment.