RSE
Release 1.0

org.eclipse.rse.ui.propertypages
Class RemoteSystemsPreferencePage

java.lang.Object
  extended byorg.eclipse.jface.dialogs.DialogPage
      extended byorg.eclipse.jface.preference.PreferencePage
          extended byorg.eclipse.jface.preference.FieldEditorPreferencePage
              extended byorg.eclipse.rse.ui.propertypages.RemoteSystemsPreferencePage
All Implemented Interfaces:
EventListener, IDialogPage, IMessageProvider, IPreferencePage, IPropertyChangeListener, ISystemPreferencesConstants, IWorkbenchPreferencePage

public class RemoteSystemsPreferencePage
extends FieldEditorPreferencePage
implements IWorkbenchPreferencePage, ISystemPreferencesConstants

Root preference page for Remote Systems Plugin


Field Summary
 
Fields inherited from class org.eclipse.jface.preference.FieldEditorPreferencePage
FLAT, GRID, MARGIN_HEIGHT, MARGIN_WIDTH, VERTICAL_SPACING
 
Fields inherited from interface org.eclipse.rse.ui.ISystemPreferencesConstants
ACTIVEUSERPROFILES, ALERT_NONSSL, ALERT_SSL, CASCADE_UDAS_BYPROFILE, DAEMON_AUTOSTART, DAEMON_PORT, DEFAULT_ACTIVEUSERPROFILES, DEFAULT_ALERT_NON_SSL, DEFAULT_ALERT_SSL, DEFAULT_CASCADE_UDAS_BYPROFILE, DEFAULT_DAEMON_AUTOSTART, DEFAULT_DAEMON_PORT, DEFAULT_DOSUPERTRANSFER, DEFAULT_DOWNLOAD_BUFFER_SIZE, DEFAULT_FILETRANSFERMODE, DEFAULT_HISTORY_FOLDER, DEFAULT_LIMIT_CACHE, DEFAULT_MAX_CACHE_SIZE, DEFAULT_ORDER_CONNECTIONS, DEFAULT_QUALIFY_CONNECTION_NAMES, DEFAULT_REMEMBER_STATE, DEFAULT_RESTORE_STATE_FROM_CACHE, DEFAULT_SHOW_HIDDEN, DEFAULT_SHOWFILTERPOOLS, DEFAULT_SHOWNEWCONNECTIONPROMPT, DEFAULT_SUPERTRANSFER_ARCHIVE_TYPE, DEFAULT_SYSTEMTYPE, DEFAULT_TEAMPROFILE, DEFAULT_USE_DEFERRED_QUERIES, DEFAULT_USERID, DEFAULT_VERIFY_CONNECTION, DOSUPERTRANSFER, DOWNLOAD_BUFFER_SIZE, FILETRANSFERMODE_BINARY, FILETRANSFERMODE_TEXT, FILETRANSFERMODEDEFAULT, HISTORY_FOLDER, HISTORY_QUALIFIED_FOLDER, LIMIT_CACHE, MAX_CACHE_SIZE, ORDER_CONNECTIONS, QUALIFY_CONNECTION_NAMES, REMEMBER_STATE, RESTORE_STATE_FROM_CACHE, ROOT, SHOWFILTERPOOLS, SHOWHIDDEN, SHOWNEWCONNECTIONPROMPT, SUPERTRANSFER_ARC_TYPE, SYSTEMTYPE, SYSTEMTYPE_VALUES, UPLOAD_BUFFER_SIZE, USE_DEFERRED_QUERIES, USERIDKEYS, USERIDPERKEY, VERIFY_CONNECTION
 
Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider
ERROR, INFORMATION, NONE, WARNING
 
Constructor Summary
RemoteSystemsPreferencePage()
          Constructor
 
Method Summary
 void createControl(Composite parent)
          We intercept to set the help
protected  void createFieldEditors()
          GUI widgets for preferences page
static String[] getActiveProfiles()
          Return the names of the profiles the user has elected to make "active".
static boolean getCascadeUserActionsPreference()
          Return true if the user has elected to show user defined actions cascaded by profile
static String[] getConnectionNamesOrder()
          Return the ordered list of connection names.
static String[] getFolderHistory()
          Return the history for the folder combo box widget
static boolean getQualifyConnectionNamesPreference()
          Return true if the user has elected to show connection names qualified by profile
static boolean getRememberStatePreference()
          Return true if the user has elected to remember the state of the Remote Systems view
static boolean getRestoreStateFromCachePreference()
          Return true if the user has elected to restore the state of the Remote Systems view from cached information
static boolean getShowFilterPoolsPreference()
          Return true if the user has elected to show filter pools in the Remote System Explorer view
static boolean getShowNewConnectionPromptPreference()
          Return true if the user has elected to show the "New Connection..." prompt in the Remote Systems view
static String getSystemTypePreference()
          Return the System type to default to on the Create Connection wizard.
static String getUserIdPreference(String systemType)
          Return the userId to default to on the Create Connection wizard, per the given system type.
static String[] getWidgetHistory(String key)
          Return the history for a widget given an arbitrary key uniquely identifying it
 void init(IWorkbench workbench)
           
static void initDefaults(IPreferenceStore store, boolean showNewConnectionPromptDefault)
          Initialize our preference store with our defaults.
protected static String makeString(String[] values)
          Make a single string out of an array of strings
protected static Hashtable parseString(String allvalues)
          Parse out list of key-value pairs into a hashtable
protected static String[] parseStrings(String allvalues)
          Parse out list of multiple values into a string array per value
 boolean performOk()
          Override of parent so we can fire changes to our views
 void propertyChange(PropertyChangeEvent event)
          we don't use this after all because it causes an event to be fired as the user makes each change.
static void setActiveProfiles(String[] newProfileNames)
          Set the names of the profiles the user has elected to make "active".
static void setCascadeUserActionsPreference(boolean set)
          Set if the user has elected to show user defined actions cascaded by profile
static void setConnectionNamesOrder(String[] newConnectionNamesOrder)
          Set the ordered list of connection names.
static void setFolderHistory(String[] newHistory)
          Set the history for the folder combo box widget.
static void setQualifyConnectionNamesPreference(boolean set)
          Set if the user has elected to show connection names qualified by profile
static void setRememberStatePreference(boolean set)
          Set if the user has elected to show connection names qualified by profile
static void setRestoreStateFromCachePreference(boolean set)
          Set if the user has elected to restore the state of the Remote Systems view from cached information
static void setShowFilterPoolsPreference(boolean show)
          Toggle whether to show filter pools in the Remote System Explorer view
static void setShowNewConnectionPromptPreference(boolean show)
          Toggle whether to show filter pools in the Remote System Explorer view
static void setUserIdPreference(String systemType, String userId)
          Set the default userId per the given system type.
static void setWidgetHistory(String key, String[] newHistory)
          Set the history for a widget given an arbitrary key uniquely identifying it.
 
Methods inherited from class org.eclipse.jface.preference.FieldEditorPreferencePage
addField, adjustGridLayout, applyFont, checkState, createContents, dispose, getFieldEditorParent, initialize, performDefaults, setVisible
 
Methods inherited from class org.eclipse.jface.preference.PreferencePage
applyData, applyDialogFont, computeSize, contributeButtons, createDescriptionLabel, createNoteComposite, doComputeSize, doGetPreferenceStore, getApplyButton, getContainer, getDefaultsButton, getPreferenceStore, isValid, noDefaultAndApplyButton, okToLeave, performApply, 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, setContainer, setSize
 
Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage
dispose, getControl, getDescription, getErrorMessage, getImage, getMessage, getTitle, performHelp, setDescription, setImageDescriptor, setTitle, setVisible
 

Constructor Detail

RemoteSystemsPreferencePage

public RemoteSystemsPreferencePage()
Constructor

Method Detail

createControl

public void createControl(Composite parent)
We intercept to set the help

Specified by:
createControl in interface IDialogPage

createFieldEditors

protected void createFieldEditors()
GUI widgets for preferences page


getActiveProfiles

public static String[] getActiveProfiles()
Return the names of the profiles the user has elected to make "active".


setActiveProfiles

public static void setActiveProfiles(String[] newProfileNames)
Set the names of the profiles the user has elected to make "active".


getConnectionNamesOrder

public static String[] getConnectionNamesOrder()
Return the ordered list of connection names. This is how user arranged his connections in the system view.


setConnectionNamesOrder

public static void setConnectionNamesOrder(String[] newConnectionNamesOrder)
Set the ordered list of connection names. This is how user arranged his connections in the system view.


getShowFilterPoolsPreference

public static boolean getShowFilterPoolsPreference()
Return true if the user has elected to show filter pools in the Remote System Explorer view


setShowFilterPoolsPreference

public static void setShowFilterPoolsPreference(boolean show)
Toggle whether to show filter pools in the Remote System Explorer view


getShowNewConnectionPromptPreference

public static boolean getShowNewConnectionPromptPreference()
Return true if the user has elected to show the "New Connection..." prompt in the Remote Systems view


setShowNewConnectionPromptPreference

public static void setShowNewConnectionPromptPreference(boolean show)
Toggle whether to show filter pools in the Remote System Explorer view


getQualifyConnectionNamesPreference

public static boolean getQualifyConnectionNamesPreference()
Return true if the user has elected to show connection names qualified by profile


setQualifyConnectionNamesPreference

public static void setQualifyConnectionNamesPreference(boolean set)
Set if the user has elected to show connection names qualified by profile


getRememberStatePreference

public static boolean getRememberStatePreference()
Return true if the user has elected to remember the state of the Remote Systems view


setRememberStatePreference

public static void setRememberStatePreference(boolean set)
Set if the user has elected to show connection names qualified by profile


getRestoreStateFromCachePreference

public static boolean getRestoreStateFromCachePreference()
Return true if the user has elected to restore the state of the Remote Systems view from cached information


setRestoreStateFromCachePreference

public static void setRestoreStateFromCachePreference(boolean set)
Set if the user has elected to restore the state of the Remote Systems view from cached information


getCascadeUserActionsPreference

public static boolean getCascadeUserActionsPreference()
Return true if the user has elected to show user defined actions cascaded by profile


setCascadeUserActionsPreference

public static void setCascadeUserActionsPreference(boolean set)
Set if the user has elected to show user defined actions cascaded by profile


getUserIdPreference

public static String getUserIdPreference(String systemType)
Return the userId to default to on the Create Connection wizard, per the given system type.

See Also:
SystemConnectionForm

setUserIdPreference

public static void setUserIdPreference(String systemType,
                                       String userId)
Set the default userId per the given system type.


getSystemTypePreference

public static String getSystemTypePreference()
Return the System type to default to on the Create Connection wizard.

See Also:
SystemConnectionForm

getFolderHistory

public static String[] getFolderHistory()
Return the history for the folder combo box widget


setFolderHistory

public static void setFolderHistory(String[] newHistory)
Set the history for the folder combo box widget.


getWidgetHistory

public static String[] getWidgetHistory(String key)
Return the history for a widget given an arbitrary key uniquely identifying it


setWidgetHistory

public static void setWidgetHistory(String key,
                                    String[] newHistory)
Set the history for a widget given an arbitrary key uniquely identifying it.


parseString

protected static Hashtable parseString(String allvalues)
Parse out list of key-value pairs into a hashtable


parseStrings

protected static String[] parseStrings(String allvalues)
Parse out list of multiple values into a string array per value


makeString

protected static String makeString(String[] values)
Make a single string out of an array of strings


init

public void init(IWorkbench workbench)
Specified by:
init in interface IWorkbenchPreferencePage

initDefaults

public static void initDefaults(IPreferenceStore store,
                                boolean showNewConnectionPromptDefault)
Initialize our preference store with our defaults. This is called in RSEUIPlugin.initializeDefaultPreferences


propertyChange

public void propertyChange(PropertyChangeEvent event)
we don't use this after all because it causes an event to be fired as the user makes each change. We prefer to wait until Apply or Defaults are pressed.

Specified by:
propertyChange in interface IPropertyChangeListener

performOk

public boolean performOk()
Override of parent so we can fire changes to our views

Specified by:
performOk in interface IPreferencePage

RSE
Release 1.0

Copyright (c) IBM Corporation and others 2000, 2006. All Rights Reserved.