nl.lxtreme.ols.api
Interface Configurable


public interface Configurable

This interface defines the methods required to make (UI) object states controllable by the project mechanism.

Its methods are called by Project when storing or loading the project state. A project state is the collection of states of all user configurable items.

Note: When defining property values it should be kept in mind that the project configuration file should be understandable and editable by users. Use common sense to determine wheter a particular setting should be part of the project configuration or not. For key naming conventions please look at an actual configuration file.


Method Summary
 void readPreferences(UserSettings aSettings)
          Reads configuration from given preferences.
 void writePreferences(UserSettings aSettings)
          Writes configuration to given preferences.
 

Method Detail

readPreferences

void readPreferences(UserSettings aSettings)
Reads configuration from given preferences.

Parameters:
aSettings - the user settings to read the configuration from, cannot be null.

writePreferences

void writePreferences(UserSettings aSettings)
Writes configuration to given preferences.

Parameters:
aSettings - the user settins to write the configuration to, cannot be null.


Copyright © 2012 L'Xtreme IT consultancy. All Rights Reserved.