org.argouml.ui
Interface GUISettingsTabInterface

All Known Implementing Classes:
ProjectSettingsTabProperties

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().

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

Method Summary
 String getTabKey()
          Gets the unlocalized settings tab name.
 JPanel getTabPanel()
          Gets the JPanel which implements the tab.
 void handleResetToDefault()
          Reset the settings shown to the same settings with a broader scope.
 void handleSettingsTabCancel()
          Cancel any changes.
 void handleSettingsTabRefresh()
          Load or reload field settings.
 void handleSettingsTabSave()
          Save any fields changed.
 

Method Detail

handleSettingsTabSave

public void handleSettingsTabSave()
Save any fields changed.


handleSettingsTabCancel

public void handleSettingsTabCancel()
Cancel any changes.


handleSettingsTabRefresh

public void handleSettingsTabRefresh()
Load or reload field settings.


handleResetToDefault

public 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

public String getTabKey()
Gets the unlocalized settings tab name.

Returns:
the unlocalized settings tab name

getTabPanel

public JPanel getTabPanel()
Gets the JPanel which implements the tab.

Returns:
the JPanel which implements the tab


ArgoUML © 1996-2006ArgoUML HomepageArgoUML Cookbook