PreferencesPanel (adams-pom 24.5.0-SNAPSHOT API)

All Superinterfaces:

Comparable<PreferencesPanel>, Serializable

All Known Implementing Classes:

AbstractPreferencesPanel, AbstractPropertiesPreferencesPanel, CharsetSettingsPanel, EmailSetupPanel, FlowPreferencesPanel, FontsPreferencesPanel, JVisualVMPanel, LocaleSettingsPanel, ProxySettingsPanel, SMBSetupPanel, SSLSetupPanel, TerminalSettingsPanel, TesseractSettingsPanel, TimeZoneSettingsPanel, WekaExperimenterPreferencesPanel, WekaExplorerPreferencesPanel, WekaInvestigatorPreferencesPanel
```
public interface PreferencesPanel
extends Serializable, Comparable<PreferencesPanel>
```
Interface for preferences panels.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`activate()`	Activates the settings.
`boolean`	`canReset()`	Returns whether the panel supports resetting the options.
`String`	`getTitle()`	The title of the preferences panel.
`boolean`	`requiresWrapper()`	Returns whether the panel requires a wrapper scrollpane/panel for display.
`String`	`reset()`	Resets the settings to their default.

Methods inherited from interface java.lang.Comparable
compareTo

- Method Detail
  - getTitle
```
String getTitle()
```
    The title of the preferences panel.
    
    Returns:
    
    the title
  - requiresWrapper
```
boolean requiresWrapper()
```
    Returns whether the panel requires a wrapper scrollpane/panel for display.
    
    Returns:
    
    true if wrapper required
  - activate
```
String activate()
```
    Activates the settings.
    
    Returns:
    
    null if successfully activated, otherwise error message
  - canReset
```
boolean canReset()
```
    Returns whether the panel supports resetting the options.
    
    Returns:
    
    true if supported
  - reset
```
String reset()
```
    Resets the settings to their default.
    
    Returns:
    
    null if successfully reset, otherwise error message