org.argouml.application.api
Interface GUISettingsTabInterface

All Known Subinterfaces:

GUIProjectSettingsTabInterface

All Known Implementing Classes:

ProjectSettingsTabProfile, ProjectSettingsTabProperties, SettingsTabDiagramAppearance, SettingsTabNotation, SettingsTabProfile

public interface GUISettingsTabInterface

An interface which must be implemented as the UI for tabs used on the settings panel.

Tabs will only need to load data during handleSettingsTabRefresh() and should only save data during handleSettingsTabSave(). Changes can be made during editing of the tabs, but the tab must be able to undo any change if requested through handleSettingsTabCancel().

Warning: Do not access the ProjectManager in the constructor of classes that implement this interface! This because the SettingsTabs are created before an initial Project is created.

Since:

0.9.4, 0.21.3 (it is part of the GUI subsystem)

handleSettingsTabSave

void handleSettingsTabSave()

Save any fields changed.

handleSettingsTabCancel

void handleSettingsTabCancel()

Cancel any changes.

handleSettingsTabRefresh

void handleSettingsTabRefresh()

Load or reload field settings.

handleResetToDefault

void handleResetToDefault()

Reset the settings shown to the same settings with a broader scope. I.e. copy settings from wider scope to narrow scope.

Remark: This shall only adapt the displayed value! You need a save to make the actual change.

getTabKey

java.lang.String getTabKey()

Gets the unlocalized settings tab name.

Returns:

the unlocalized settings tab name

getTabPanel

javax.swing.JPanel getTabPanel()

Gets the JPanel which implements the tab.

Returns:

the JPanel which implements the tab