com.bigzip
Class SettingsCustomizer

java.lang.Object
  |
  +--com.bigzip.SettingsCustomizer

public abstract class SettingsCustomizer
extends java.lang.Object

This class provide the BiGZip preferences dialog box with the facilities to customise a settings object. Subclasses of this class are registered with the settings object through the setCustomizer method. Subclasses need to provide an implementation for the applyCustomizer, getCustomizer and veifyCustomizer methods. Note that the customizer is responsible for providing a customization interface for any children of the settings object.


Constructor Summary
SettingsCustomizer()
           
 
Method Summary
abstract  void applyCustomizer(javax.swing.JComponent customizer)
          Applys the settings in the component to the settings object for which this is the customizer.
abstract  javax.swing.JComponent getCustomizer()
          Returns a customizer that will allow the user to edit the settings in a settings object through the preferences dialog box.
 Settings getSettings()
          Returns the settings object for which this class provides a customizer.
 void setSettings(Settings settings)
          Initialises the settings object to be customized.
abstract  boolean verifyCustomizer(javax.swing.JComponent customizer)
          Verifies the settings in the component.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SettingsCustomizer

public SettingsCustomizer()
Method Detail

applyCustomizer

public abstract void applyCustomizer(javax.swing.JComponent customizer)
Applys the settings in the component to the settings object for which this is the customizer.
Parameters:
customizer - The component previously obtained by a call to the getCustomizer method.

getCustomizer

public abstract javax.swing.JComponent getCustomizer()
Returns a customizer that will allow the user to edit the settings in a settings object through the preferences dialog box.
Returns:
The customizer component.

getSettings

public final Settings getSettings()
Returns the settings object for which this class provides a customizer.
Returns:
The settings object.

verifyCustomizer

public abstract boolean verifyCustomizer(javax.swing.JComponent customizer)
Verifies the settings in the component. Raises any dialogs necessary to inform the user of any anomilies.
Parameters:
customizer - The component previously obtained by a call to the getCustomizer method.
Returns:
True if the component has been verified that appling the component will be successful.

setSettings

public final void setSettings(Settings settings)
Initialises the settings object to be customized.
Parameters:
settings - The settings object.