ch.elexis.omnivore.preferences
Class PreferencePage

java.lang.Object
  org.eclipse.jface.dialogs.DialogPage
      org.eclipse.jface.preference.PreferencePage
          org.eclipse.jface.preference.FieldEditorPreferencePage
              ch.elexis.omnivore.preferences.PreferencePage

All Implemented Interfaces:

java.util.EventListener, org.eclipse.jface.dialogs.IDialogPage, org.eclipse.jface.dialogs.IMessageProvider, org.eclipse.jface.preference.IPreferencePage, org.eclipse.jface.util.IPropertyChangeListener, org.eclipse.ui.IWorkbenchPreferencePage

public class PreferencePage
extends org.eclipse.jface.preference.FieldEditorPreferencePage
implements org.eclipse.ui.IWorkbenchPreferencePage

Field Summary

static java.lang.Integer	nOmnivore_jsPREF_cotf_element_digits_max
static int	nPREF_DEST_DIR
static int	nPREF_SRC_PATTERN
static java.lang.Integer	Omnivore_jsMax_Filename_Length_Default
static java.lang.Integer	Omnivore_jsMax_Filename_Length_Max
static java.lang.Integer	Omnivore_jsMax_Filename_Length_Min
static java.lang.String[]	PREF_DEST_DIR
static java.lang.String	PREF_MAX_FILENAME_LENGTH
static java.lang.String[]	PREF_SRC_PATTERN
static java.lang.String	PREFERENCE_BRANCH
static java.lang.String	PREFERENCE_COTF
static java.lang.String[]	PREFERENCE_cotf_elements
static java.lang.String[]	PREFERENCE_cotf_elements_messages
static java.lang.String[]	PREFERENCE_cotf_parameters
static java.lang.String[]	PREFERENCE_cotf_parameters_messages
static java.lang.String	PREFERENCE_DEST_DIR
static java.lang.String	PREFERENCE_SRC_PATTERN

Fields inherited from class org.eclipse.jface.preference.FieldEditorPreferencePage

FLAT, GRID, MARGIN_HEIGHT, MARGIN_WIDTH, VERTICAL_SPACING

Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider

ERROR, INFORMATION, NONE, WARNING

Constructor Summary

PreferencePage()

Method Summary

protected void	createFieldEditors()
static java.lang.Integer	getOmnivore_jsMax_Filename_Length() Returns a currently value from the preference store, observing default settings and min/max settings for that parameter
static java.lang.Integer	getOmnivore_jsMax_Filename_Length(org.eclipse.jface.preference.IPreferenceStore preferenceStore)
static java.lang.Integer	getOmnivore_jsnRulesForAutoArchiving() Returns the number of rules to process for automatic archiving
static java.lang.String	getOmnivore_jsRuleForAutoArchivingDestDir(java.lang.Integer i) Returns configured content of rules for automatic archiving
static java.lang.String	getOmnivore_jsRuleForAutoArchivingSrcPattern(java.lang.Integer i) Returns configured content of rules for automatic archiving
static java.lang.String	getOmnivore_jsTemp_Filename_Element(org.eclipse.jface.preference.IPreferenceStore preferenceStore, java.lang.String element_key, java.lang.String element_data)
static java.lang.String	getOmnivore_jsTemp_Filename_Element(java.lang.String element_key, java.lang.String element_data) Accepts some data to turn into a temporary filename element, and returns a formatted temporary filename element, observing current settings from the preference store, also observing default settings and min/max settings for that parameter
void	init(org.eclipse.ui.IWorkbench workbench)
protected void	performApply()

Methods inherited from class org.eclipse.jface.preference.FieldEditorPreferencePage

addField, adjustGridLayout, applyFont, checkState, createContents, dispose, getFieldEditorParent, initialize, performDefaults, performOk, propertyChange, setVisible

Methods inherited from class org.eclipse.jface.preference.PreferencePage

applyData, applyDialogFont, computeSize, contributeButtons, createControl, createDescriptionLabel, createNoteComposite, doComputeSize, doGetPreferenceStore, getApplyButton, getContainer, getDefaultsButton, getPreferenceStore, isValid, noDefaultAndApplyButton, okToLeave, performCancel, performHelp, setContainer, setErrorMessage, setMessage, setPreferenceStore, setSize, setTitle, setValid, toString, updateApplyButton

Methods inherited from class org.eclipse.jface.dialogs.DialogPage

convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, getControl, getDescription, getDialogFontName, getErrorMessage, getFont, getImage, getMessage, getMessageType, getShell, getTitle, getToolTipText, initializeDialogUnits, isControlCreated, setButtonLayoutData, setControl, setDescription, setImageDescriptor, setMessage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.jface.preference.IPreferencePage

computeSize, isValid, okToLeave, performCancel, performOk, setContainer, setSize

Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage

createControl, dispose, getControl, getDescription, getErrorMessage, getImage, getMessage, getTitle, performHelp, setDescription, setImageDescriptor, setTitle, setVisible

Field Detail

PREFERENCE_BRANCH

public static final java.lang.String PREFERENCE_BRANCH

See Also:

Constant Field Values

PREFERENCE_SRC_PATTERN

public static final java.lang.String PREFERENCE_SRC_PATTERN

See Also:

Constant Field Values

PREFERENCE_DEST_DIR

public static final java.lang.String PREFERENCE_DEST_DIR

See Also:

Constant Field Values

Omnivore_jsMax_Filename_Length_Min

public static final java.lang.Integer Omnivore_jsMax_Filename_Length_Min

Omnivore_jsMax_Filename_Length_Default

public static final java.lang.Integer Omnivore_jsMax_Filename_Length_Default

Omnivore_jsMax_Filename_Length_Max

public static final java.lang.Integer Omnivore_jsMax_Filename_Length_Max

PREF_MAX_FILENAME_LENGTH

public static final java.lang.String PREF_MAX_FILENAME_LENGTH

See Also:

Constant Field Values

PREF_SRC_PATTERN

public static final java.lang.String[] PREF_SRC_PATTERN

PREF_DEST_DIR

public static final java.lang.String[] PREF_DEST_DIR

nPREF_SRC_PATTERN

public static final int nPREF_SRC_PATTERN

nPREF_DEST_DIR

public static final int nPREF_DEST_DIR

nOmnivore_jsPREF_cotf_element_digits_max

public static final java.lang.Integer nOmnivore_jsPREF_cotf_element_digits_max

PREFERENCE_COTF

public static final java.lang.String PREFERENCE_COTF

See Also:

Constant Field Values

PREFERENCE_cotf_elements

public static final java.lang.String[] PREFERENCE_cotf_elements

PREFERENCE_cotf_parameters

public static final java.lang.String[] PREFERENCE_cotf_parameters

PREFERENCE_cotf_elements_messages

public static final java.lang.String[] PREFERENCE_cotf_elements_messages

PREFERENCE_cotf_parameters_messages

public static final java.lang.String[] PREFERENCE_cotf_parameters_messages

Constructor Detail

PreferencePage

public PreferencePage()

Method Detail

createFieldEditors

protected void createFieldEditors()

Specified by:

createFieldEditors in class org.eclipse.jface.preference.FieldEditorPreferencePage

init

public void init(org.eclipse.ui.IWorkbench workbench)

Specified by:

init in interface org.eclipse.ui.IWorkbenchPreferencePage

performApply

protected void performApply()

Overrides:

performApply in class org.eclipse.jface.preference.PreferencePage

getOmnivore_jsTemp_Filename_Element

public static java.lang.String getOmnivore_jsTemp_Filename_Element(java.lang.String element_key,
                                                                   java.lang.String element_data)

Accepts some data to turn into a temporary filename element, and returns a formatted temporary filename element, observing current settings from the preference store, also observing default settings and min/max settings for that parameter

Parameters:

Can - be called with an already available preferenceStore. If none is passed, one will be temporarily instantiated on the fly. Also accepts String element_key to identify the requested filename element, and the String element_data to be processed into a string constituting that filename element.

Returns:

The requested filename element as a string.

getOmnivore_jsTemp_Filename_Element

public static java.lang.String getOmnivore_jsTemp_Filename_Element(org.eclipse.jface.preference.IPreferenceStore preferenceStore,
                                                                   java.lang.String element_key,
                                                                   java.lang.String element_data)

getOmnivore_jsMax_Filename_Length

public static java.lang.Integer getOmnivore_jsMax_Filename_Length()

Returns a currently value from the preference store, observing default settings and min/max settings for that parameter

Parameters:

Can - be called with an already available preferenceStore. If none is passed, one will be temporarily instantiated on the fly.

Returns:

The requested integer parameter

getOmnivore_jsMax_Filename_Length

public static java.lang.Integer getOmnivore_jsMax_Filename_Length(org.eclipse.jface.preference.IPreferenceStore preferenceStore)

getOmnivore_jsnRulesForAutoArchiving

public static java.lang.Integer getOmnivore_jsnRulesForAutoArchiving()

Returns the number of rules to process for automatic archiving

getOmnivore_jsRuleForAutoArchivingSrcPattern

public static java.lang.String getOmnivore_jsRuleForAutoArchivingSrcPattern(java.lang.Integer i)

Returns configured content of rules for automatic archiving

Parameters:

Rule - number whose match pattern shall be retrieved. Cave: Visible only internally to the program, this index is 0 based, whereas the preference page for the user shows 1-based "Rule n" headings.

Returns:

Either null if the index is out of bounds, or if the respective String is technically undefined (which should never be the case); or the respective String (which may also be "", i.e. an empty string), if the user has cleared or left clear the respective input field.

getOmnivore_jsRuleForAutoArchivingDestDir

public static java.lang.String getOmnivore_jsRuleForAutoArchivingDestDir(java.lang.Integer i)

Returns configured content of rules for automatic archiving

Parameters:

Rule - number whose destination directory shall be retrieved. Cave: Visible only internally to the program, this index is 0 based, whereas the preference page for the user shows 1-based "Rule n" headings.

Returns:

Either null if the index is out of bounds, or if the respective String is technically undefined (which should never be the case); or the respective String (which may also be "", i.e. an empty string), if the user has cleared or left clear the respective input field.