BasicApplicationPreferences (ontimize-core 5.6.0 API)

java.lang.Object
- com.ontimize.gui.preferences.AbstractApplicationPreferences
- - com.ontimize.gui.preferences.BasicApplicationPreferences

All Implemented Interfaces:

ApplicationPreferences
```
public class BasicApplicationPreferences
extends AbstractApplicationPreferences
```
Basic implementation of the application preferences

Version:

1.0

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ADJUST_TREE_SPACE` Name of the preference to adjust automatically the available space for the trees
`static boolean`	`ADJUST_TREE_SPACE_VALUE`
`static String`	`APP_CONNECT_TO`
`static String`	`APP_FONTSIZE` Name of the preference to set the application font size
`static String`	`APP_LAST_LOGIN` Name of the preference to store the last login used in the application
`static String`	`APP_LAST_PASSWORD`
`static String`	`APP_LOCALE`
`static String`	`APP_REMEMBER_LAST_LOGIN` Name of the preference to remember or not the last login used
`static String`	`APP_REMEMBER_LAST_PASSWORD`
`static String`	`APP_STATUS_BAR_VISIBLE` Name of the preference to show/hide the application status bar
`static String`	`APP_TOOL_BAR_VISIBLE` Name of the preference to show/hide the application buttons bar
`static String`	`APP_TOOLBAR_LOCATION`
`static String`	`APP_USER_DIR`
`static String`	`APP_WINDOW_POSITION` Name of the preference to set the application window position
`static String`	`APP_WINDOW_SIZE` Name of the preference to set the application window size
`static String`	`APP_WINDOW_STATE` Name of the preference to set the application window state
`protected JLabel`	`backgroundColorFieldLabel`
`protected String`	`basePath`
`protected JButton`	`cancelButton`
`static boolean`	`checkOldPreferences`
`static String`	`COLLAPSIBLE_PANEL_VISIBLE`
`protected JDialog`	`colorDialog`
`static boolean`	`DEBUG`
`static String`	`DETAIL_DIALOG_SIZE_POSITION`
`static String`	`DIALOG_SIZE_POSITION`
`boolean`	`dirtyMode`
`protected JDialog`	`dPreferences`
`protected String`	`file`
`static String`	`FOCUSED_FIELD_BG_COLOR`
`static String`	`FORM_TABLEVIEW_COLUMNS`
`protected static String`	`L_EVEN_COLOR_TABLE_ROW`
`protected static String`	`L_FOCUS_COLOR_FIELD`
`protected static String`	`L_REQUIRED_BACKGROUND_COLOR_FIELD`
`protected JLabel`	`labelRequiredBackgroungColor`
`protected JLabel`	`labelTableColor`
`protected boolean`	`loadDeaults`
`static String`	`LOOK_AND_FEEL_CLASS_NAME` Name of the preference to store the application look and feel
`static String`	`MENU_ACCELERATOR`
`protected JButton`	`okButton`
`protected JPanel`	`panelFieldBackgroundColor`
`protected JPanel`	`panelRequiredBackgroundColor`
`protected JPanel`	`panelTableColor`
`static boolean`	`remoteUserPreferences`
`static String`	`REQUIRED_FIELDS_BG_COLOR` Name of the preference to set the required fields background color
`protected JButton`	`restoreButton`
`protected RemoteApplicationPreferences`	`rprefs`
`static String`	`SHOW_TABLE_CONTROLS` Name of the preference to show/hide the table controls
`static String`	`SHOW_TABLE_NUM_ROW` Name of the preference to show/hide the column with the rows number in a table
`static String`	`SHOW_TIPS`
`static String`	`SPLIT_POSITION`
`protected static String`	`T_COLORS`
`static String`	`TABLE_CALCULATED_COLUMNS_CONFIGURATION`
`static String`	`TABLE_COLS_POSITION_SIZE`
`static String`	`TABLE_CONF_CHART_CONFIGURATIONS`
`static String`	`TABLE_CONF_PIVOT_TABLE_CONFIGURATIONS`
`static String`	`TABLE_CONF_REPORT_CONFIGURATIONS`
`static String`	`TABLE_CONF_SORT_FILTER`
`static String`	`TABLE_CONF_SORT_FILTER_CONFIGURATIONS`
`static String`	`TABLE_CONTROL_PANEL`
`static String`	`TABLE_EVEN_ROWS_COLOR` Name of the preference to set the even table rows background color
`static String`	`TABLE_VISIBLE_COLS`

Fields inherited from class com.ontimize.gui.preferences.AbstractApplicationPreferences
defaultUserProps, listeners, props, separator, userProps

Constructor Summary

Constructors
Constructor and Description
`BasicApplicationPreferences(String file)` Creates new BasicApplicationPreferences object with the preferences stored in the file `file`.
`BasicApplicationPreferences(String file, RemoteApplicationPreferences rp)` Creates a BasicApplicationPreferences object with the preferences stored in the file `file`.
`BasicApplicationPreferences(String file, String basePath)` Creates a BasicApplicationPreferences object with the preferences stored in the file `file`.
`BasicApplicationPreferences(String file, String basePath, RemoteApplicationPreferences rp)` Creates a BasicApplicationPreferences object with the preferences stored in the file `file`.

Method Summary

Methods
Modifier and Type	Method and Description
`protected Properties`	`checkOldPreferences(String user)` This method extract the user preferences of old preferences file.
`protected void`	`createColorDialog(Window parent)`
`Properties`	`getAllPreferences()`
`String`	`getBasePath()`
`protected String`	`getDefault(String preferenceName)` Gets the default value for the specified preference
`String`	`getFile()`
`String`	`getPreference(String user, String preferenceName)` Get the value of the preference with name `preferenceName` for the user `user`
`RemoteApplicationPreferences`	`getRemoteApplicationPreferences()`
`static Properties`	`getUserLocalPreferences(String user, Properties properties)`
`Properties`	`getUserPreferences()`
`boolean`	`isDirtyMode()`
`protected void`	`loadDefaults()` Initializes the default preference values
`void`	`loadPreferences()` Load the preference values
`static void`	`main(String[] args)`
`static String`	`parserPropertiesToStringBase64(Properties properties)`
`static Properties`	`parserStringBase64ToProperties(String properties)`
`protected static Properties`	`retrieveProperties(String properties)`
`void`	`savePreferences()` Save the current preference values
`void`	`setBasePath(String basePath)`
`void`	`setDirtyMode(boolean dirtyMode)`
`void`	`setFile(String file)`
`void`	`setLoadDefaults(boolean value)`
`void`	`setPreference(String user, String preferenceName, String value)` Sets the value of the preference with name `preferenceName` for the user `user`
`void`	`setRemoteApplicationPreferences(RemoteApplicationPreferences rp)`
`protected void`	`setResourceBundleColorChooser()`
`protected void`	`setUserPreferences(Properties current)`
`void`	`showColorChooserDialog(Window parent)`
`void`	`showPreferencesDialog(String user, String formManager, String form, Application a)` Show a dialog to configure the user preferences

Methods inherited from class com.ontimize.gui.preferences.AbstractApplicationPreferences
addApplicationPreferencesListener, fireApplicationPreferencesChanged, getKeyPreference, getProperties, removeApplicationPreferencesListener

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - remoteUserPreferences
```
public static boolean remoteUserPreferences
```
  - checkOldPreferences
```
public static boolean checkOldPreferences
```
  - dirtyMode
```
public boolean dirtyMode
```
  - DEBUG
```
public static boolean DEBUG
```
  - APP_LOCALE
```
public static final String APP_LOCALE
```
    See Also:
    Constant Field Values
  - APP_CONNECT_TO
```
public static final String APP_CONNECT_TO
```
    See Also:
    Constant Field Values
  - TABLE_EVEN_ROWS_COLOR
```
public static final String TABLE_EVEN_ROWS_COLOR
```
    Name of the preference to set the even table rows background color
    
    See Also:
    Constant Field Values
  - TABLE_VISIBLE_COLS
```
public static final String TABLE_VISIBLE_COLS
```
    See Also:
    Constant Field Values
  - TABLE_CONTROL_PANEL
```
public static final String TABLE_CONTROL_PANEL
```
    See Also:
    Constant Field Values
  - TABLE_CONF_SORT_FILTER
```
public static final String TABLE_CONF_SORT_FILTER
```
    See Also:
    Constant Field Values
  - TABLE_CONF_SORT_FILTER_CONFIGURATIONS
```
public static final String TABLE_CONF_SORT_FILTER_CONFIGURATIONS
```
    See Also:
    Constant Field Values
  - TABLE_CONF_REPORT_CONFIGURATIONS
```
public static final String TABLE_CONF_REPORT_CONFIGURATIONS
```
    See Also:
    Constant Field Values
  - TABLE_CONF_CHART_CONFIGURATIONS
```
public static final String TABLE_CONF_CHART_CONFIGURATIONS
```
    See Also:
    Constant Field Values
  - TABLE_COLS_POSITION_SIZE
```
public static final String TABLE_COLS_POSITION_SIZE
```
    See Also:
    Constant Field Values
  - TABLE_CONF_PIVOT_TABLE_CONFIGURATIONS
```
public static final String TABLE_CONF_PIVOT_TABLE_CONFIGURATIONS
```
    See Also:
    Constant Field Values
  - TABLE_CALCULATED_COLUMNS_CONFIGURATION
```
public static final String TABLE_CALCULATED_COLUMNS_CONFIGURATION
```
    See Also:
    Constant Field Values
  - REQUIRED_FIELDS_BG_COLOR
```
public static final String REQUIRED_FIELDS_BG_COLOR
```
    Name of the preference to set the required fields background color
    
    See Also:
    Constant Field Values
  - FOCUSED_FIELD_BG_COLOR
```
public static final String FOCUSED_FIELD_BG_COLOR
```
    See Also:
    Constant Field Values
  - SHOW_TIPS
```
public static final String SHOW_TIPS
```
    See Also:
    Constant Field Values
  - SHOW_TABLE_CONTROLS
```
public static final String SHOW_TABLE_CONTROLS
```
    Name of the preference to show/hide the table controls
    
    See Also:
    Constant Field Values
  - SHOW_TABLE_NUM_ROW
```
public static final String SHOW_TABLE_NUM_ROW
```
    Name of the preference to show/hide the column with the rows number in a table
    
    See Also:
    Constant Field Values
  - APP_WINDOW_POSITION
```
public static final String APP_WINDOW_POSITION
```
    Name of the preference to set the application window position
    
    See Also:
    Constant Field Values
  - APP_WINDOW_STATE
```
public static final String APP_WINDOW_STATE
```
    Name of the preference to set the application window state
    
    See Also:
    Constant Field Values
  - APP_WINDOW_SIZE
```
public static final String APP_WINDOW_SIZE
```
    Name of the preference to set the application window size
    
    See Also:
    Constant Field Values
  - APP_STATUS_BAR_VISIBLE
```
public static final String APP_STATUS_BAR_VISIBLE
```
    Name of the preference to show/hide the application status bar
    
    See Also:
    Constant Field Values
  - APP_TOOL_BAR_VISIBLE
```
public static final String APP_TOOL_BAR_VISIBLE
```
    Name of the preference to show/hide the application buttons bar
    
    See Also:
    Constant Field Values
  - APP_FONTSIZE
```
public static final String APP_FONTSIZE
```
    Name of the preference to set the application font size
    
    See Also:
    Constant Field Values
  - ADJUST_TREE_SPACE
```
public static final String ADJUST_TREE_SPACE
```
    Name of the preference to adjust automatically the available space for the trees
    
    See Also:
    Constant Field Values
  - ADJUST_TREE_SPACE_VALUE
```
public static boolean ADJUST_TREE_SPACE_VALUE
```
  - APP_REMEMBER_LAST_LOGIN
```
public static final String APP_REMEMBER_LAST_LOGIN
```
    Name of the preference to remember or not the last login used
    
    See Also:
    Constant Field Values
  - APP_LAST_LOGIN
```
public static final String APP_LAST_LOGIN
```
    Name of the preference to store the last login used in the application
    
    See Also:
    Constant Field Values
  - APP_REMEMBER_LAST_PASSWORD
```
public static final String APP_REMEMBER_LAST_PASSWORD
```
    See Also:
    Constant Field Values
  - APP_LAST_PASSWORD
```
public static final String APP_LAST_PASSWORD
```
    See Also:
    Constant Field Values
  - APP_USER_DIR
```
public static final String APP_USER_DIR
```
    See Also:
    Constant Field Values
  - LOOK_AND_FEEL_CLASS_NAME
```
public static final String LOOK_AND_FEEL_CLASS_NAME
```
    Name of the preference to store the application look and feel
    
    See Also:
    Constant Field Values
  - SPLIT_POSITION
```
public static final String SPLIT_POSITION
```
    See Also:
    Constant Field Values
  - COLLAPSIBLE_PANEL_VISIBLE
```
public static final String COLLAPSIBLE_PANEL_VISIBLE
```
    See Also:
    Constant Field Values
  - DETAIL_DIALOG_SIZE_POSITION
```
public static final String DETAIL_DIALOG_SIZE_POSITION
```
    See Also:
    Constant Field Values
  - DIALOG_SIZE_POSITION
```
public static final String DIALOG_SIZE_POSITION
```
    See Also:
    Constant Field Values
  - APP_TOOLBAR_LOCATION
```
public static final String APP_TOOLBAR_LOCATION
```
    See Also:
    Constant Field Values
  - MENU_ACCELERATOR
```
public static final String MENU_ACCELERATOR
```
    See Also:
    Constant Field Values
  - FORM_TABLEVIEW_COLUMNS
```
public static final String FORM_TABLEVIEW_COLUMNS
```
    See Also:
    Constant Field Values
  - dPreferences
```
protected JDialog dPreferences
```
  - file
```
protected String file
```
  - basePath
```
protected String basePath
```
  - colorDialog
```
protected JDialog colorDialog
```
  - panelTableColor
```
protected JPanel panelTableColor
```
  - panelRequiredBackgroundColor
```
protected JPanel panelRequiredBackgroundColor
```
  - panelFieldBackgroundColor
```
protected JPanel panelFieldBackgroundColor
```
  - T_COLORS
```
protected static String T_COLORS
```
  - L_EVEN_COLOR_TABLE_ROW
```
protected static String L_EVEN_COLOR_TABLE_ROW
```
  - L_REQUIRED_BACKGROUND_COLOR_FIELD
```
protected static String L_REQUIRED_BACKGROUND_COLOR_FIELD
```
  - L_FOCUS_COLOR_FIELD
```
protected static String L_FOCUS_COLOR_FIELD
```
  - labelTableColor
```
protected JLabel labelTableColor
```
  - labelRequiredBackgroungColor
```
protected JLabel labelRequiredBackgroungColor
```
  - backgroundColorFieldLabel
```
protected JLabel backgroundColorFieldLabel
```
  - okButton
```
protected JButton okButton
```
  - cancelButton
```
protected JButton cancelButton
```
  - restoreButton
```
protected JButton restoreButton
```
  - rprefs
```
protected RemoteApplicationPreferences rprefs
```
  - loadDeaults
```
protected boolean loadDeaults
```
- Constructor Detail
  - BasicApplicationPreferences
```
public BasicApplicationPreferences(String file)
```
    Creates new BasicApplicationPreferences object with the preferences stored in the file file.
    
    Parameters:
    file - Name of the file (without path) that contains the application preferences. This file must be in the user directory
  - BasicApplicationPreferences
```
public BasicApplicationPreferences(String file,
                           String basePath)
```
    Creates a BasicApplicationPreferences object with the preferences stored in the file file.
    
    Parameters:
    file - Name of the preferences file
    basePath - Path where the file is
  - BasicApplicationPreferences
```
public BasicApplicationPreferences(String file,
                           RemoteApplicationPreferences rp)
```
    Creates a BasicApplicationPreferences object with the preferences stored in the file file.
    
    Parameters:
    file - Name of the file (without path). This file must be in the user directory
    rp - Remote preferences
  - BasicApplicationPreferences
```
public BasicApplicationPreferences(String file,
                           String basePath,
                           RemoteApplicationPreferences rp)
```
    Creates a BasicApplicationPreferences object with the preferences stored in the file file.
    
    Parameters:
    file - Name of the file
    basePath - Path where the file is
    rp - Remote preferences
- Method Detail
  - getFile
```
public String getFile()
```
  - setFile
```
public void setFile(String file)
```
  - getBasePath
```
public String getBasePath()
```
  - setBasePath
```
public void setBasePath(String basePath)
```
  - setLoadDefaults
```
public void setLoadDefaults(boolean value)
```
  - loadPreferences
```
public void loadPreferences()
```
    Description copied from interface: ApplicationPreferences
    
    Load the preference values
  - loadDefaults
```
protected void loadDefaults()
```
    Initializes the default preference values
  - getPreference
```
public String getPreference(String user,
                   String preferenceName)
```
    Description copied from interface: ApplicationPreferences
    
    Get the value of the preference with name preferenceName for the user user
    
    Parameters:
    user - Name of the user or null if the preference is for all users
    preferenceName - Name of the preference
    
    Returns:
    Preference value
  - getDefault
```
protected String getDefault(String preferenceName)
```
    Gets the default value for the specified preference
    
    Parameters:
    preferenceName -
    
    Returns:
  - setPreference
```
public void setPreference(String user,
                 String preferenceName,
                 String value)
```
    Description copied from interface: ApplicationPreferences
    
    Sets the value of the preference with name preferenceName for the user user
    
    Parameters:
    user - Name of the user or null if the preference is for all users
    preferenceName - Name of the preference
    value - The value for the preference
  - savePreferences
```
public void savePreferences()
```
    Description copied from interface: ApplicationPreferences
    
    Save the current preference values
  - showPreferencesDialog
```
public void showPreferencesDialog(String user,
                         String formManager,
                         String form,
                         Application a)
```
    Description copied from interface: ApplicationPreferences
    
    Show a dialog to configure the user preferences
  - showColorChooserDialog
```
public void showColorChooserDialog(Window parent)
```
  - setResourceBundleColorChooser
```
protected void setResourceBundleColorChooser()
```
  - createColorDialog
```
protected void createColorDialog(Window parent)
```
  - setRemoteApplicationPreferences
```
public void setRemoteApplicationPreferences(RemoteApplicationPreferences rp)
```
  - getRemoteApplicationPreferences
```
public RemoteApplicationPreferences getRemoteApplicationPreferences()
```
  - parserPropertiesToStringBase64
```
public static String parserPropertiesToStringBase64(Properties properties)
```
  - parserStringBase64ToProperties
```
public static Properties parserStringBase64ToProperties(String properties)
```
  - retrieveProperties
```
protected static Properties retrieveProperties(String properties)
                                        throws Exception
```
    Throws:
    
    Exception
  - getUserLocalPreferences
```
public static Properties getUserLocalPreferences(String user,
                                 Properties properties)
```
  - getUserPreferences
```
public Properties getUserPreferences()
```
  - setUserPreferences
```
protected void setUserPreferences(Properties current)
```
  - checkOldPreferences
```
protected Properties checkOldPreferences(String user)
```
    This method extract the user preferences of old preferences file.
    
    Parameters:
    user -
    
    Returns:
  - getAllPreferences
```
public Properties getAllPreferences()
```
  - isDirtyMode
```
public boolean isDirtyMode()
```
  - setDirtyMode
```
public void setDirtyMode(boolean dirtyMode)
```
  - main
```
public static void main(String[] args)
```

Class BasicApplicationPreferences

Field Summary

Fields inherited from class com.ontimize.gui.preferences.AbstractApplicationPreferences

Constructor Summary

Method Summary

Methods inherited from class com.ontimize.gui.preferences.AbstractApplicationPreferences

Methods inherited from class java.lang.Object

Field Detail

remoteUserPreferences

checkOldPreferences

dirtyMode

DEBUG

APP_LOCALE

APP_CONNECT_TO

TABLE_EVEN_ROWS_COLOR

TABLE_VISIBLE_COLS

TABLE_CONTROL_PANEL

TABLE_CONF_SORT_FILTER

TABLE_CONF_SORT_FILTER_CONFIGURATIONS

TABLE_CONF_REPORT_CONFIGURATIONS

TABLE_CONF_CHART_CONFIGURATIONS

TABLE_COLS_POSITION_SIZE

TABLE_CONF_PIVOT_TABLE_CONFIGURATIONS

TABLE_CALCULATED_COLUMNS_CONFIGURATION

REQUIRED_FIELDS_BG_COLOR

FOCUSED_FIELD_BG_COLOR

SHOW_TIPS

SHOW_TABLE_CONTROLS

SHOW_TABLE_NUM_ROW

APP_WINDOW_POSITION

APP_WINDOW_STATE

APP_WINDOW_SIZE

APP_STATUS_BAR_VISIBLE

APP_TOOL_BAR_VISIBLE

APP_FONTSIZE

ADJUST_TREE_SPACE

ADJUST_TREE_SPACE_VALUE

APP_REMEMBER_LAST_LOGIN

APP_LAST_LOGIN

APP_REMEMBER_LAST_PASSWORD

APP_LAST_PASSWORD

APP_USER_DIR

LOOK_AND_FEEL_CLASS_NAME

SPLIT_POSITION

COLLAPSIBLE_PANEL_VISIBLE

DETAIL_DIALOG_SIZE_POSITION

DIALOG_SIZE_POSITION

APP_TOOLBAR_LOCATION

MENU_ACCELERATOR

FORM_TABLEVIEW_COLUMNS

dPreferences

file

basePath

colorDialog

panelTableColor

panelRequiredBackgroundColor

panelFieldBackgroundColor

T_COLORS

L_EVEN_COLOR_TABLE_ROW

L_REQUIRED_BACKGROUND_COLOR_FIELD

L_FOCUS_COLOR_FIELD

labelTableColor

labelRequiredBackgroungColor

backgroundColorFieldLabel

okButton

cancelButton

restoreButton

rprefs

loadDeaults

Constructor Detail

BasicApplicationPreferences

BasicApplicationPreferences

BasicApplicationPreferences

BasicApplicationPreferences

Method Detail

getFile

setFile

getBasePath

setBasePath

setLoadDefaults