public abstract class DefaultTabPreferenceSetting extends DefaultPreferenceSetting implements TabPreferenceSetting
TabPreferenceSetting
implementations.
Support for common functionality, like icon, title and adding a tab (SubPreferenceSetting
).Modifier and Type | Field and Description |
---|---|
private java.lang.String |
description |
private java.lang.String |
iconName |
private java.util.Map<SubPreferenceSetting,java.awt.Component> |
subSettingMap |
private javax.swing.JTabbedPane |
tabpane |
private java.lang.String |
title |
Constructor and Description |
---|
DefaultTabPreferenceSetting()
Constructs a new
DefaultTabPreferenceSetting . |
DefaultTabPreferenceSetting(java.lang.String iconName,
java.lang.String title,
java.lang.String description) |
DefaultTabPreferenceSetting(java.lang.String iconName,
java.lang.String title,
java.lang.String description,
boolean isExpert) |
DefaultTabPreferenceSetting(java.lang.String iconName,
java.lang.String title,
java.lang.String description,
boolean isExpert,
javax.swing.JTabbedPane tabpane) |
Modifier and Type | Method and Description |
---|---|
void |
addSubTab(SubPreferenceSetting sub,
java.lang.String title,
java.awt.Component component)
Adds a new sub preference settings tab with the given title and component.
|
void |
addSubTab(SubPreferenceSetting sub,
java.lang.String title,
java.awt.Component component,
java.lang.String tip)
Adds a new sub preference settings tab with the given title, component and tooltip.
|
protected void |
createPreferenceTabWithScrollPane(PreferenceTabbedPane gui,
javax.swing.JPanel panel) |
java.lang.String |
getDescription()
Called during preferences tab initialization to display a description in one sentence for this tab.
|
java.lang.String |
getHelpContext()
Returns the help context for this preferences settings tab.
|
java.lang.String |
getIconName()
Called during preferences dialog initialization to display the preferences tab with the returned icon.
|
java.awt.Component |
getSubTab(SubPreferenceSetting sub)
Returns the tab component related to the specified sub preference settings
|
javax.swing.JTabbedPane |
getTabPane()
Get the inner tab pane, if any.
|
java.lang.String |
getTitle()
Called during preferences tab initialization to display its title.
|
java.lang.String |
getTooltip()
Called during preferences dialog initialization to display the preferences tab with the returned tooltip.
|
void |
registerSubTab(SubPreferenceSetting sub,
java.awt.Component component)
Registers a sub preference settings to an existing tab component.
|
boolean |
selectSubTab(SubPreferenceSetting subPref)
Selects the specified sub preference settings, if applicable.
|
isExpert, saveBoolean, saveDouble, saveInt
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
addGui, isExpert, ok
private final java.lang.String iconName
private final java.lang.String description
private final java.lang.String title
private final javax.swing.JTabbedPane tabpane
private final java.util.Map<SubPreferenceSetting,java.awt.Component> subSettingMap
public DefaultTabPreferenceSetting()
DefaultTabPreferenceSetting
.public DefaultTabPreferenceSetting(java.lang.String iconName, java.lang.String title, java.lang.String description)
public DefaultTabPreferenceSetting(java.lang.String iconName, java.lang.String title, java.lang.String description, boolean isExpert)
public DefaultTabPreferenceSetting(java.lang.String iconName, java.lang.String title, java.lang.String description, boolean isExpert, javax.swing.JTabbedPane tabpane)
public java.lang.String getIconName()
TabPreferenceSetting
getIconName
in interface TabPreferenceSetting
public java.lang.String getTooltip()
TabPreferenceSetting
getTooltip
in interface TabPreferenceSetting
public java.lang.String getDescription()
TabPreferenceSetting
getDescription
in interface TabPreferenceSetting
public java.lang.String getTitle()
TabPreferenceSetting
getTitle
in interface TabPreferenceSetting
public final javax.swing.JTabbedPane getTabPane()
protected final void createPreferenceTabWithScrollPane(PreferenceTabbedPane gui, javax.swing.JPanel panel)
public boolean selectSubTab(SubPreferenceSetting subPref)
TabPreferenceSetting
selectSubTab
in interface TabPreferenceSetting
subPref
- The sub preference settings to be selected.public final void addSubTab(SubPreferenceSetting sub, java.lang.String title, java.awt.Component component)
TabPreferenceSetting
addSubTab
in interface TabPreferenceSetting
sub
- The new sub preference settings.title
- The tab title.component
- The tab component.public final void addSubTab(SubPreferenceSetting sub, java.lang.String title, java.awt.Component component, java.lang.String tip)
TabPreferenceSetting
addSubTab
in interface TabPreferenceSetting
sub
- The new sub preference settings.title
- The tab title.component
- The tab component.tip
- The tab tooltip.public final void registerSubTab(SubPreferenceSetting sub, java.awt.Component component)
TabPreferenceSetting
registerSubTab
in interface TabPreferenceSetting
sub
- The new sub preference settings.component
- The component for which a tab already exists.public final java.awt.Component getSubTab(SubPreferenceSetting sub)
TabPreferenceSetting
getSubTab
in interface TabPreferenceSetting
sub
- The requested sub preference settings.public java.lang.String getHelpContext()
TabPreferenceSetting
getHelpContext
in interface TabPreferenceSetting