Package apps.gui3.tabbedpreferences

@DefaultAnnotation({}) package apps.gui3.tabbedpreferences

Provides the tabbed preferences window and its contents.

There is generally only one TabbedPreferencesFrame in the system, containing the single TabbedPreferences content object. Both are available in the InstanceManager. Various classes across JMRI show these by using TabbedPreferencesAction instances, or instances of subclasses.

Related Documentation

Please see:

• JMRI Preferences tech documentation

The Startup Process

• During normal startup, TabbedPreferencesAction instance(s) are created for menus, etc. They don't reference the TabbedPreferences or TabbedPreferencesFrame objects at that point.
• When a TabbedPreferencesAction is invoked, it asks the InstanceManager for a TabbedPreferencesFrame instance, creating and initializing it if needed. That in turn asks the InstanceManager for a TabbedPreferences instance, creating and initializing it if needed.
• In some cases, the startup code needs a TabbedPreferencesFrame object. In those cases, that code asks the InstanceManager for the TabbedPreferences instance, again creating and initializing it if needed.

The current (March 2019, JMRI 4.15.3) implementation does all this in the requesting thread, which can take a few seconds when the preferences are eventually requested. That's not an every-time thing, so perhaps that delay is OK, perhaps not. Eventually, it would be desirable to separate the content vs GUI sections of TabbedPreferences and defer the GUI creation (which is the majority of the time) to a separate GUI-update thread.

See Also:

• PreferencesManager
• PreferencesPanel
• AppConfigBase

Related Packages

Package	Description
apps.gui3	The gui3 package provides basic function for JMRI applications that use the new "Gui3" user interface first seen in the updated DecoderPro (formerly known as DecoderPro3).
apps.gui3.dp3	The current DecoderPro application, previously known as DecoderPro3.
apps.gui3.lccpro
apps.gui3.mdi
apps.gui3.paned	Provide the GUI3 "paned", IDE-like, user interface.

Classes

Class	Description
Bundle
EditConnectionPreferences	Provide access to the connection preferences via a tabbed pane.
EditConnectionPreferences.PreferencesCatItems
EditConnectionPreferences.PreferencesCatItems.TabDetails
EditConnectionPreferencesDialog	Provide a Connection preferences dialog.
TabbedPreferences	Provide access to preferences via a tabbed pane.
TabbedPreferences.PreferencesCatItems
TabbedPreferences.PreferencesCatItems.TabDetails
TabbedPreferencesAction	Action launches the tabbed preferences window.
TabbedPreferencesActionFactory	Preferences startup action factory.
TabbedPreferencesFrame	Support displaying TabbedPreferences in a window.
TabbedPreferencesProfileAction	Tabbed Preferences Action for going direct to Profiles.