org.openstreetmap.josm.gui.preferences

Class DefaultTabPreferenceSetting

java.lang.Object

org.openstreetmap.josm.gui.preferences.DefaultPreferenceSetting

org.openstreetmap.josm.gui.preferences.DefaultTabPreferenceSetting

All Implemented Interfaces:

PreferenceSetting, TabPreferenceSetting

Direct Known Subclasses:

AdvancedPreference, AudioPreference, DisplayPreference, ImageryPreference, MapPreference, PluginPreference, RemoteControlPreference, ServerAccessPreference, ShortcutPreference, ToolbarPreferences.Settings, ValidatorPreference

public abstract class DefaultTabPreferenceSetting
extends DefaultPreferenceSetting
implements TabPreferenceSetting

Field Summary

Fields

Modifier and Type	Field and Description
private String	description
private String	iconName
private Map<SubPreferenceSetting,Component>	subSettingMap
private JTabbedPane	tabpane
private String	title

Constructor Summary

Constructors

Constructor and Description
DefaultTabPreferenceSetting() Constructs a new DefaultTabPreferenceSetting.
DefaultTabPreferenceSetting(String iconName, String title, String description)
DefaultTabPreferenceSetting(String iconName, String title, String description, boolean isExpert)
DefaultTabPreferenceSetting(String iconName, String title, String description, boolean isExpert, JTabbedPane tabpane)

Method Summary

Modifier and Type	Method and Description
void	addSubTab(SubPreferenceSetting sub, String title, Component component) Adds a new sub preference settings tab with the given title and component.
void	addSubTab(SubPreferenceSetting sub, String title, Component component, String tip) Adds a new sub preference settings tab with the given title, component and tooltip.
protected void	createPreferenceTabWithScrollPane(PreferenceTabbedPane gui, JPanel panel)
String	getDescription() Called during preferences tab initialization to display a description in one sentence for this tab.
String	getIconName() Called during preferences dialog initialization to display the preferences tab with the returned icon.
Component	getSubTab(SubPreferenceSetting sub) Returns the tab component related to the specified sub preference settings
JTabbedPane	getTabPane() Get the inner tab pane, if any.
String	getTitle() Called during preferences tab initialization to display its title.
String	getTooltip() Called during preferences dialog initialization to display the preferences tab with the returned tooltip.
void	registerSubTab(SubPreferenceSetting sub, Component component) Registers a sub preference settings to an existing tab component.
boolean	selectSubTab(SubPreferenceSetting subPref) Selects the specified sub preference settings, if applicable.

Methods inherited from class org.openstreetmap.josm.gui.preferences.DefaultPreferenceSetting

isExpert

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openstreetmap.josm.gui.preferences.PreferenceSetting

addGui, isExpert, ok

Field Detail

iconName

private final String iconName

description

private final String description

title

private final String title

tabpane

private final JTabbedPane tabpane

subSettingMap

private final Map<SubPreferenceSetting,Component> subSettingMap

Constructor Detail

DefaultTabPreferenceSetting

public DefaultTabPreferenceSetting()

Constructs a new DefaultTabPreferenceSetting.

DefaultTabPreferenceSetting

public DefaultTabPreferenceSetting(String iconName,
                                   String title,
                                   String description)

DefaultTabPreferenceSetting

public DefaultTabPreferenceSetting(String iconName,
                                   String title,
                                   String description,
                                   boolean isExpert)

DefaultTabPreferenceSetting

public DefaultTabPreferenceSetting(String iconName,
                                   String title,
                                   String description,
                                   boolean isExpert,
                                   JTabbedPane tabpane)

Method Detail

getIconName

public String getIconName()

Description copied from interface: TabPreferenceSetting

Called during preferences dialog initialization to display the preferences tab with the returned icon.

Specified by:

getIconName in interface TabPreferenceSetting

Returns:

The icon name in the preferences folder.

getTooltip

public String getTooltip()

Description copied from interface: TabPreferenceSetting

Called during preferences dialog initialization to display the preferences tab with the returned tooltip.

Specified by:

getTooltip in interface TabPreferenceSetting

Returns:

The tooltip of this preferences tab.

getDescription

public String getDescription()

Description copied from interface: TabPreferenceSetting

Called during preferences tab initialization to display a description in one sentence for this tab. Will be displayed in italic under the title.

Specified by:

getDescription in interface TabPreferenceSetting

Returns:

The description of this preferences tab.

getTitle

public String getTitle()

Description copied from interface: TabPreferenceSetting

Called during preferences tab initialization to display its title.

Specified by:

getTitle in interface TabPreferenceSetting

Returns:

The title of this preferences tab.

getTabPane

public final JTabbedPane getTabPane()

Get the inner tab pane, if any.

Returns:

The JTabbedPane contained in this tab preference settings, or null if none is set.

Since:

5631

createPreferenceTabWithScrollPane

protected final void createPreferenceTabWithScrollPane(PreferenceTabbedPane gui,
                                                       JPanel panel)

selectSubTab

public boolean selectSubTab(SubPreferenceSetting subPref)

Description copied from interface: TabPreferenceSetting

Selects the specified sub preference settings, if applicable. Not all Tab preference settings need to implement this.

Specified by:

selectSubTab in interface TabPreferenceSetting

Parameters:

subPref - The sub preference settings to be selected.

Returns:

true if the specified preference settings have been selected, false otherwise.

addSubTab

public final void addSubTab(SubPreferenceSetting sub,
                            String title,
                            Component component)

Description copied from interface: TabPreferenceSetting

Adds a new sub preference settings tab with the given title and component.

Specified by:

addSubTab in interface TabPreferenceSetting

Parameters:

sub - The new sub preference settings.

title - The tab title.

component - The tab component.

addSubTab

public final void addSubTab(SubPreferenceSetting sub,
                            String title,
                            Component component,
                            String tip)

Description copied from interface: TabPreferenceSetting

Adds a new sub preference settings tab with the given title, component and tooltip.

Specified by:

addSubTab in interface TabPreferenceSetting

Parameters:

sub - The new sub preference settings.

title - The tab title.

component - The tab component.

tip - The tab tooltip.

registerSubTab

public final void registerSubTab(SubPreferenceSetting sub,
                                 Component component)

Description copied from interface: TabPreferenceSetting

Registers a sub preference settings to an existing tab component.

Specified by:

registerSubTab in interface TabPreferenceSetting

Parameters:

sub - The new sub preference settings.

component - The component for which a tab already exists.

getSubTab

public final Component getSubTab(SubPreferenceSetting sub)

Description copied from interface: TabPreferenceSetting

Returns the tab component related to the specified sub preference settings

Specified by:

getSubTab in interface TabPreferenceSetting

Parameters:

sub - The requested sub preference settings.

Returns:

The component related to the specified sub preference settings, or null.