GemsFX Documentation

The SearchTextField is a specialized text field designed for search interfaces. It provides built-in support for:

• A history of search terms.
• An optional history popup.
• Custom icons for search and clear operations.

The TextView component is used to display multiline text. It supports text selection, allowing users to highlight content and copy it to the clipboard.

Selection behaviors:

• Mouse Dragging: Select text by clicking and dragging the mouse.
• Double Click: Selects a single word.
• Triple Click: Selects an entire paragraph.

Copying text:

• Keyboard Shortcuts: Users can use OS-specific shortcuts (e.g., CTRL-C on Windows/Linux or Command-C on macOS).
• Context Menu: A built-in context menu is provided for copying selected text.

GemsFX uses ResourceBundleManager (com.dlsc.gemsfx.util) for built-in localized labels. The active locale defaults to Locale.getDefault().

To set a custom locale, call ResourceBundleManager.setLocale() before creating your controls. Note that changing the locale clears the internal bundle cache and affects future lookups, but existing control instances are not guaranteed to live-refresh their text automatically.

ResourceBundleManager.setLocale(Locale.GERMAN);

The SearchField is a specialized text field designed for auto-suggest capabilities where the primary outcome is a specific object type (defined by a generic type argument) rather than just raw text.

Key features include:

• Object-oriented selection: Automatically finds and selects objects matching user input.
• On-the-fly creation: Can create new instances of the object type if no match is found (requires a New Item Producer).
• Asynchronous suggestions: Uses JavaFX concurrency (Service & Task) to fetch suggestions with a built-in delay to prevent excessive searching while typing.
• History support: Can be configured with a HistoryManager to track previous searches.

Use NestedListChangeTracker to monitor modifications in a nested list structure (an ObservableList containing other ObservableList instances).

This class extends AbstractChangeTracker and is designed to track changes at two levels:

1. Outer List Changes: Additions, removals, or replacements of the inner lists themselves.
2. Inner List Changes: Modifications (additions, removals, or updates) occurring within any of the nested inner lists.

When any modification occurs at either level, the tracker notifies its consumer, making it ideal for synchronizing complex UI components with deeply nested data models.

// Note: The provided documentation describes the concept but does not include a code snippet. 
// Conceptually, it is used to wrap an ObservableList<ObservableList<T>>.

The PowerPane is a composite layout component that aggregates several specialized panes from GemsFX and ControlsFX into a single structure. It is designed to serve as the foundational layout for rich client applications that require integrated notification and dialog management.

PowerPane integrates the following specialized panes:

• InfoCenterPane: Used for displaying notifications.
• DialogPane: Used for displaying dialogs.
• DrawerStackPane: Used to display a drawer or tray that slides in from the bottom.
• HiddenSidesPane: Used to display trays that slide in from any of the four sides.