Package apps

Class GuiLocalePreferencesPanel

java.lang.Object

apps.GuiLocalePreferencesPanel

All Implemented Interfaces:

JmriServiceProviderInterface, PreferencesPanel, PreferencesSubPanel

public class GuiLocalePreferencesPanel
extends java.lang.Object
implements PreferencesSubPanel

Provide PreferencesPanel information for the JPanel provided by GuiLafConfigPane.doLocale().

Field Summary

Fields

Modifier and Type	Field	Description
(package private) GuiLafConfigPane	parent

Constructor Summary

Constructors

Constructor	Description
GuiLocalePreferencesPanel()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getLabelKey()	Text displayed above the preferences panel This label is only displayed if the preferences panel is in a tabbed set of preferences.
GuiLafConfigPane	getParent()
java.lang.String	getParentClassName()
javax.swing.JComponent	getPreferencesComponent()	Get the preferences component for display
java.lang.String	getPreferencesItem()	Get the Preferences Item identifier.
java.lang.String	getPreferencesItemText()	Get the text for the Preferences Item in the preferences window list of preferences categories.
java.lang.String	getPreferencesTooltip()	The tooltip to display for a tabbed preferences panel
java.lang.String	getTabbedPreferencesTitle()	Get the title for the tab containing this preferences item.
boolean	isDirty()	Indicate that preferences need to be saved.
boolean	isPersistant()	Indicates that this PrefernecesPanel should be stored across application starts by the PreferencesManager This should be true if the implementing class relies on the ConfigureManager stores and retrieves the preferences managed by the implementing class on behalf of the implementing class.
boolean	isPreferencesValid()	Indicate that the preferences are valid.
boolean	isRestartRequired()	Indicate that the preferences will not take effect until restarted.
void	savePreferences()	Save any changes to preferences.
void	setParent(PreferencesPanel parent)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jmri.swing.PreferencesPanel

getIsEnabled, getSortOrder

Field Detail

parent

GuiLafConfigPane parent

Constructor Detail

GuiLocalePreferencesPanel

public GuiLocalePreferencesPanel()

Method Detail

getParentClassName

public java.lang.String getParentClassName()

Specified by:

getParentClassName in interface PreferencesSubPanel

setParent

public void setParent(PreferencesPanel parent)

Specified by:

setParent in interface PreferencesSubPanel

getParent

public GuiLafConfigPane getParent()

Specified by:

getParent in interface PreferencesSubPanel

getPreferencesItem

public java.lang.String getPreferencesItem()

Description copied from interface: PreferencesPanel

Get the Preferences Item identifier. Multiple PreferencePanels can be displayed as tabs in a single item. Preferences items are listed in the menu on the left of the preferences window.

Specified by:

getPreferencesItem in interface PreferencesPanel

Returns:

the preferences item identifier.

getPreferencesItemText

public java.lang.String getPreferencesItemText()

Description copied from interface: PreferencesPanel

Get the text for the Preferences Item in the preferences window list of preferences categories. Multiple PreferencePanels can be displayed as tabs in a single item. Preferences items are listed in the menu on the left of the preferences window.

Specified by:

getPreferencesItemText in interface PreferencesPanel

Returns:

the text for the preferences item.

getTabbedPreferencesTitle

public java.lang.String getTabbedPreferencesTitle()

Description copied from interface: PreferencesPanel

Get the title for the tab containing this preferences item.

Specified by:

getTabbedPreferencesTitle in interface PreferencesPanel

Returns:

a tab title

getLabelKey

public java.lang.String getLabelKey()

Description copied from interface: PreferencesPanel

Text displayed above the preferences panel This label is only displayed if the preferences panel is in a tabbed set of preferences. This label can contain multiple lines.

Specified by:

getLabelKey in interface PreferencesPanel

Returns:

label text

getPreferencesComponent

public javax.swing.JComponent getPreferencesComponent()

Description copied from interface: PreferencesPanel

Get the preferences component for display

Specified by:

getPreferencesComponent in interface PreferencesPanel

Returns:

the preferences panel

isPersistant

public boolean isPersistant()

Description copied from interface: PreferencesPanel

Indicates that this PrefernecesPanel should be stored across application starts by the PreferencesManager This should be true if the implementing class relies on the ConfigureManager stores and retrieves the preferences managed by the implementing class on behalf of the implementing class.

Specified by:

isPersistant in interface PreferencesPanel

Returns:

false if the implementing class stores its own preferences

getPreferencesTooltip

public java.lang.String getPreferencesTooltip()

Description copied from interface: PreferencesPanel

The tooltip to display for a tabbed preferences panel

Specified by:

getPreferencesTooltip in interface PreferencesPanel

Returns:

tooltip text

savePreferences

public void savePreferences()

Description copied from interface: PreferencesPanel

Save any changes to preferences. This method is called for every instance of a PreferencesPanel that is loaded by TabbedPreferences if PreferencesPanel.isPersistant() is false.

Specified by:

savePreferences in interface PreferencesPanel

isDirty

public boolean isDirty()

Description copied from interface: PreferencesPanel

Indicate that preferences need to be saved.

Specified by:

isDirty in interface PreferencesPanel

Returns:

true if preferences need to be saved, false otherwise

isRestartRequired

public boolean isRestartRequired()

Description copied from interface: PreferencesPanel

Indicate that the preferences will not take effect until restarted.

Specified by:

isRestartRequired in interface PreferencesPanel

Returns:

true if the application needs to restart

isPreferencesValid

public boolean isPreferencesValid()

Description copied from interface: PreferencesPanel

Indicate that the preferences are valid.

Specified by:

isPreferencesValid in interface PreferencesPanel

Returns:

true if the preferences are valid, false otherwise