org.eclipse.rse.ui.filters.dialogs
Class SystemNewFilterWizardConfigurator

java.lang.Object
  org.eclipse.rse.ui.filters.dialogs.SystemNewFilterWizardConfigurator

All Implemented Interfaces:

ISystemIconConstants, ISystemNewFilterWizardConfigurator

public class SystemNewFilterWizardConfigurator

extends Object

implements ISystemNewFilterWizardConfigurator, ISystemIconConstants

Much of the new filter wizard is configurable, especially with respect to translated strings. While there exists setters and overridable methods for most of it, sometimes that gets overwhelming. This class is designed to capture all the configurable attributes that are not likely to change from usage to usage of the wizard (eg, not context sensitive) such that for convenience you can subclass it in a class and instantiate a singleton instance of that class to re-use in your wizard.

Your best option is to subclass this and override just those things you want to change.

Field Summary

Fields inherited from interface org.eclipse.rse.ui.ISystemIconConstants

ICON_ACTIONS_DIR, ICON_BANNER_SUFFIX, ICON_EXT, ICON_IDE_COLLAPSEALL_ID, ICON_IDE_FILTER_ID, ICON_IDE_LINKTOEDITOR_ID, ICON_IDE_REFRESH_ID, ICON_MODEL_DIR, ICON_NEWACTIONS_DIR, ICON_OBJS_DIR, ICON_SEARCH_CLEAR_HISTORY, ICON_SEARCH_CLEAR_HISTORY_ID, ICON_SEARCH_CLEAR_HISTORY_ROOT, ICON_SEARCH_REMOVE_ALL_MATCHES, ICON_SEARCH_REMOVE_ALL_MATCHES_ID, ICON_SEARCH_REMOVE_ALL_MATCHES_ROOT, ICON_SEARCH_REMOVE_SELECTED_MATCHES, ICON_SEARCH_REMOVE_SELECTED_MATCHES_ID, ICON_SEARCH_REMOVE_SELECTED_MATCHES_ROOT, ICON_SUFFIX, ICON_SYSTEM_ARROW_DOWN, ICON_SYSTEM_ARROW_DOWN_ID, ICON_SYSTEM_ARROW_DOWN_ROOT, ICON_SYSTEM_ARROW_UP, ICON_SYSTEM_ARROW_UP_ID, ICON_SYSTEM_ARROW_UP_ROOT, ICON_SYSTEM_BLANK, ICON_SYSTEM_BLANK_ID, ICON_SYSTEM_BLANK_ROOT, ICON_SYSTEM_CANCEL, ICON_SYSTEM_CANCEL_ID, ICON_SYSTEM_CANCEL_ROOT, ICON_SYSTEM_CANCEL_SHELL, ICON_SYSTEM_CANCEL_SHELL_ID, ICON_SYSTEM_CANCEL_SHELL_ROOT, ICON_SYSTEM_CHANGEFILTER, ICON_SYSTEM_CHANGEFILTER_ID, ICON_SYSTEM_CHANGEFILTER_ROOT, ICON_SYSTEM_CLEAR, ICON_SYSTEM_CLEAR_ALL, ICON_SYSTEM_CLEAR_ALL_ID, ICON_SYSTEM_CLEAR_ALL_ROOT, ICON_SYSTEM_CLEAR_ID, ICON_SYSTEM_CLEAR_ROOT, ICON_SYSTEM_CLEAR_SELECTED, ICON_SYSTEM_CLEAR_SELECTED_ID, ICON_SYSTEM_CLEAR_SELECTED_ROOT, ICON_SYSTEM_COMBINE, ICON_SYSTEM_COMBINE_ID, ICON_SYSTEM_COMBINE_ROOT, ICON_SYSTEM_COMPILE, ICON_SYSTEM_COMPILE_ID, ICON_SYSTEM_COMPILE_ROOT, ICON_SYSTEM_CONNECTION, ICON_SYSTEM_CONNECTION_ID, ICON_SYSTEM_CONNECTION_ROOT, ICON_SYSTEM_CONNECTIONLIVE, ICON_SYSTEM_CONNECTIONLIVE_ID, ICON_SYSTEM_CONNECTIONLIVE_ROOT, ICON_SYSTEM_CONNECTOR_SERVICE, ICON_SYSTEM_CONNECTOR_SERVICE_ID, ICON_SYSTEM_CONNECTOR_SERVICE_ROOT, ICON_SYSTEM_CONVERT, ICON_SYSTEM_CONVERT_ID, ICON_SYSTEM_CONVERT_ROOT, ICON_SYSTEM_DELETEREF, ICON_SYSTEM_DELETEREF_ID, ICON_SYSTEM_DELETEREF_ROOT, ICON_SYSTEM_EMPTY, ICON_SYSTEM_EMPTY_ID, ICON_SYSTEM_EMPTY_ROOT, ICON_SYSTEM_ENVVAR, ICON_SYSTEM_ENVVAR_ID, ICON_SYSTEM_ENVVAR_LIBPATH, ICON_SYSTEM_ENVVAR_LIBPATH_ID, ICON_SYSTEM_ENVVAR_LIBPATH_ROOT, ICON_SYSTEM_ENVVAR_PATH, ICON_SYSTEM_ENVVAR_PATH_ID, ICON_SYSTEM_ENVVAR_PATH_ROOT, ICON_SYSTEM_ENVVAR_ROOT, ICON_SYSTEM_ERROR, ICON_SYSTEM_ERROR_ID, ICON_SYSTEM_ERROR_ROOT, ICON_SYSTEM_EXPORT_SHELL_HISTORY, ICON_SYSTEM_EXPORT_SHELL_HISTORY_ID, ICON_SYSTEM_EXPORT_SHELL_HISTORY_ROOT, ICON_SYSTEM_EXPORT_SHELL_OUTPUT, ICON_SYSTEM_EXPORT_SHELL_OUTPUT_ID, ICON_SYSTEM_EXPORT_SHELL_OUTPUT_ROOT, ICON_SYSTEM_EXTRACT, ICON_SYSTEM_EXTRACT_ID, ICON_SYSTEM_EXTRACT_ROOT, ICON_SYSTEM_EXTRACTTO, ICON_SYSTEM_EXTRACTTO_ID, ICON_SYSTEM_EXTRACTTO_ROOT, ICON_SYSTEM_FAILED, ICON_SYSTEM_FAILED_ID, ICON_SYSTEM_FAILED_ROOT, ICON_SYSTEM_FILTER, ICON_SYSTEM_FILTER_ID, ICON_SYSTEM_FILTER_ROOT, ICON_SYSTEM_FILTERPOOL, ICON_SYSTEM_FILTERPOOL_ID, ICON_SYSTEM_FILTERPOOL_ROOT, ICON_SYSTEM_FILTERSTRING, ICON_SYSTEM_FILTERSTRING_ID, ICON_SYSTEM_FILTERSTRING_ROOT, ICON_SYSTEM_FOLDER, ICON_SYSTEM_FOLDER_ID, ICON_SYSTEM_FOLDER_ROOT, ICON_SYSTEM_HELP, ICON_SYSTEM_HELP_ID, ICON_SYSTEM_HELP_ROOT, ICON_SYSTEM_INFO, ICON_SYSTEM_INFO_ID, ICON_SYSTEM_INFO_ROOT, ICON_SYSTEM_INFO_TREE, ICON_SYSTEM_INFO_TREE_ID, ICON_SYSTEM_INFO_TREE_ROOT, ICON_SYSTEM_LAUNCHER_CONFIGURATION, ICON_SYSTEM_LAUNCHER_CONFIGURATION_ID, ICON_SYSTEM_LAUNCHER_CONFIGURATION_ROOT, ICON_SYSTEM_LOCK, ICON_SYSTEM_LOCK_ID, ICON_SYSTEM_LOCK_ROOT, ICON_SYSTEM_MAKEPROFILEACTIVE, ICON_SYSTEM_MAKEPROFILEACTIVE_ID, ICON_SYSTEM_MAKEPROFILEACTIVE_ROOT, ICON_SYSTEM_MAKEPROFILEINACTIVE, ICON_SYSTEM_MAKEPROFILEINACTIVE_ID, ICON_SYSTEM_MAKEPROFILEINACTIVE_ROOT, ICON_SYSTEM_MOVE, ICON_SYSTEM_MOVE_ID, ICON_SYSTEM_MOVE_ROOT, ICON_SYSTEM_MOVEDOWN, ICON_SYSTEM_MOVEDOWN_ID, ICON_SYSTEM_MOVEDOWN_ROOT, ICON_SYSTEM_MOVEUP, ICON_SYSTEM_MOVEUP_ID, ICON_SYSTEM_MOVEUP_ROOT, ICON_SYSTEM_NEW, ICON_SYSTEM_NEW_ID, ICON_SYSTEM_NEW_ROOT, ICON_SYSTEM_NEWCONNECTION, ICON_SYSTEM_NEWCONNECTION_ID, ICON_SYSTEM_NEWCONNECTION_ROOT, ICON_SYSTEM_NEWCONNECTIONWIZARD, ICON_SYSTEM_NEWCONNECTIONWIZARD_ID, ICON_SYSTEM_NEWCONNECTIONWIZARD_ROOT, ICON_SYSTEM_NEWFILE, ICON_SYSTEM_NEWFILE_ID, ICON_SYSTEM_NEWFILE_ROOT, ICON_SYSTEM_NEWFILEWIZARD, ICON_SYSTEM_NEWFILEWIZARD_ID, ICON_SYSTEM_NEWFILEWIZARD_ROOT, ICON_SYSTEM_NEWFILTER, ICON_SYSTEM_NEWFILTER_ID, ICON_SYSTEM_NEWFILTER_ROOT, ICON_SYSTEM_NEWFILTERPOOL, ICON_SYSTEM_NEWFILTERPOOL_ID, ICON_SYSTEM_NEWFILTERPOOL_ROOT, ICON_SYSTEM_NEWFILTERPOOLREF, ICON_SYSTEM_NEWFILTERPOOLREF_ID, ICON_SYSTEM_NEWFILTERPOOLREF_ROOT, ICON_SYSTEM_NEWFILTERPOOLWIZARD, ICON_SYSTEM_NEWFILTERPOOLWIZARD_ID, ICON_SYSTEM_NEWFILTERPOOLWIZARD_ROOT, ICON_SYSTEM_NEWFILTERWIZARD, ICON_SYSTEM_NEWFILTERWIZARD_ID, ICON_SYSTEM_NEWFILTERWIZARD_ROOT, ICON_SYSTEM_NEWFOLDER, ICON_SYSTEM_NEWFOLDER_ID, ICON_SYSTEM_NEWFOLDER_ROOT, ICON_SYSTEM_NEWFOLDERWIZARD, ICON_SYSTEM_NEWFOLDERWIZARD_ID, ICON_SYSTEM_NEWFOLDERWIZARD_ROOT, ICON_SYSTEM_NEWPROFILE, ICON_SYSTEM_NEWPROFILE_ID, ICON_SYSTEM_NEWPROFILE_ROOT, ICON_SYSTEM_NEWPROFILEWIZARD, ICON_SYSTEM_NEWPROFILEWIZARD_ID, ICON_SYSTEM_NEWPROFILEWIZARD_ROOT, ICON_SYSTEM_OK, ICON_SYSTEM_OK_ID, ICON_SYSTEM_OK_ROOT, ICON_SYSTEM_PERSPECTIVE, ICON_SYSTEM_PERSPECTIVE_ID, ICON_SYSTEM_PERSPECTIVE_ROOT, ICON_SYSTEM_PROCESS, ICON_SYSTEM_PROCESS_ID, ICON_SYSTEM_PROCESS_ROOT, ICON_SYSTEM_PROFILE, ICON_SYSTEM_PROFILE_ACTIVE, ICON_SYSTEM_PROFILE_ACTIVE_ID, ICON_SYSTEM_PROFILE_ACTIVE_ROOT, ICON_SYSTEM_PROFILE_ID, ICON_SYSTEM_PROFILE_ROOT, ICON_SYSTEM_PROPERTIES, ICON_SYSTEM_PROPERTIES_ID, ICON_SYSTEM_PROPERTIES_ROOT, ICON_SYSTEM_REFRESH, ICON_SYSTEM_REFRESH_ID, ICON_SYSTEM_REFRESH_ROOT, ICON_SYSTEM_REMOVE_SHELL, ICON_SYSTEM_REMOVE_SHELL_ID, ICON_SYSTEM_REMOVE_SHELL_ROOT, ICON_SYSTEM_RENAME, ICON_SYSTEM_RENAME_ID, ICON_SYSTEM_RENAME_ROOT, ICON_SYSTEM_ROOTDRIVE, ICON_SYSTEM_ROOTDRIVE_ID, ICON_SYSTEM_ROOTDRIVE_ROOT, ICON_SYSTEM_ROOTDRIVEOPEN, ICON_SYSTEM_ROOTDRIVEOPEN_ID, ICON_SYSTEM_ROOTDRIVEOPEN_ROOT, ICON_SYSTEM_RUN, ICON_SYSTEM_RUN_ID, ICON_SYSTEM_RUN_ROOT, ICON_SYSTEM_SEARCH, ICON_SYSTEM_SEARCH_ID, ICON_SYSTEM_SEARCH_RESULT, ICON_SYSTEM_SEARCH_RESULT_ID, ICON_SYSTEM_SEARCH_RESULT_ROOT, ICON_SYSTEM_SEARCH_ROOT, ICON_SYSTEM_SELECTFILTERPOOLS, ICON_SYSTEM_SELECTFILTERPOOLS_ID, ICON_SYSTEM_SELECTFILTERPOOLS_ROOT, ICON_SYSTEM_SELECTPROFILE, ICON_SYSTEM_SELECTPROFILE_ID, ICON_SYSTEM_SELECTPROFILE_ROOT, ICON_SYSTEM_SERVICE, ICON_SYSTEM_SERVICE_ID, ICON_SYSTEM_SERVICE_ROOT, ICON_SYSTEM_SHELL, ICON_SYSTEM_SHELL_ID, ICON_SYSTEM_SHELL_ROOT, ICON_SYSTEM_SHELLLIVE, ICON_SYSTEM_SHELLLIVE_ID, ICON_SYSTEM_SHELLLIVE_ROOT, ICON_SYSTEM_SHOW_MONITOR, ICON_SYSTEM_SHOW_MONITOR_ID, ICON_SYSTEM_SHOW_MONITOR_ROOT, ICON_SYSTEM_SHOW_SHELL, ICON_SYSTEM_SHOW_SHELL_ID, ICON_SYSTEM_SHOW_SHELL_ROOT, ICON_SYSTEM_SHOW_TABLE, ICON_SYSTEM_SHOW_TABLE_ID, ICON_SYSTEM_SHOW_TABLE_ROOT, ICON_SYSTEM_STOP, ICON_SYSTEM_STOP_ID, ICON_SYSTEM_STOP_ROOT, ICON_SYSTEM_TARGET, ICON_SYSTEM_TARGET_ID, ICON_SYSTEM_TARGET_ROOT, ICON_SYSTEM_WARNING, ICON_SYSTEM_WARNING_ID, ICON_SYSTEM_WARNING_ROOT, ICON_SYSTEM_WORKWITHCOMPILECMDS, ICON_SYSTEM_WORKWITHCOMPILECMDS_ID, ICON_SYSTEM_WORKWITHCOMPILECMDS_ROOT, ICON_SYSTEM_WORKWITHFILTERPOOLS, ICON_SYSTEM_WORKWITHFILTERPOOLS_ID, ICON_SYSTEM_WORKWITHFILTERPOOLS_ROOT, ICON_SYSTEM_WORKWITHNAMEDTYPES, ICON_SYSTEM_WORKWITHNAMEDTYPES_ID, ICON_SYSTEM_WORKWITHNAMEDTYPES_ROOT, ICON_SYSTEM_WORKWITHUSERACTIONS, ICON_SYSTEM_WORKWITHUSERACTIONS_ID, ICON_SYSTEM_WORKWITHUSERACTIONS_ROOT, ICON_WIZARD_DIR, PLUGIN_ID, PREFIX

Constructor Summary

protected	SystemNewFilterWizardConfigurator() Constructor for SystemNewFilterWizardConfigurator.
protected	SystemNewFilterWizardConfigurator(String pageTitle) Constructor for SystemNewFilterWizardConfigurator when you want to change the page title

Method Summary

String	getPage1Description() Return the description for page 1 (which prompts for the filter string)
String	getPage1Title() Return the page title for page 1 (which prompts for the filter string)
String	getPage2Description() Return the description for page 2 (which prompts for the name and filter pool)
String	getPage2HelpID() Return the help ID for page 2
String	getPage2NamePromptLabel() Return the label for the filter name prompt on page 2.
String	getPage2NamePromptTooltip() Return the tooltip for the filter name prompt on page 2.
String	getPage2NameVerbage() Return the verbage for the name prompt on page 2
String	getPage2PoolPromptLabel() Return the label for the filter pool prompt on page 2.
String	getPage2PoolPromptTooltip() Return the label for the filter pool prompt on page 2.
String	getPage2PoolVerbage() Return the verbage for the name prompt on page 2
String	getPage2PoolVerbageTip() Return the verbage tooltip for the name prompt on page 2
String	getPage2Title() Return the page title for page 2 (which prompts for the name and filter pool)
String	getPage2UniqueToConnectionLabel() Get the "Unique to this connection" checkbox label
String	getPage2UniqueToConnectionToolTip() Set the "Unique to this connection" checkbox tooltip
String	getPage3Description() Return the description for page 3 (which shows 2 tips)
String	getPage3Tip1() Return the description for page 3 (which shows 2 tips)
String	getPage3Tip2() Return the second tip on page 3
String	getPage3Title() Return the page title for page 3 (which shows 2 tips)
String	getPageTitle() Return the default page title to use for each page, unless overridden individually
void	setPage1Description(String description) Set the description for page 1
void	setPage2HelpID(String helpId) Set the help ID for page 2
void	setPage3Tip1(String tip) Set the first tip to show for page 3
void	setPage3Tip2(String tip) Set the second tip to show for page 3
void	setPageTitle(String pageTitle) Set the default page title.

Methods inherited from class java.lang.Object

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

Constructor Detail

SystemNewFilterWizardConfigurator

protected SystemNewFilterWizardConfigurator()

Constructor for SystemNewFilterWizardConfigurator.

SystemNewFilterWizardConfigurator

protected SystemNewFilterWizardConfigurator(String pageTitle)

Constructor for SystemNewFilterWizardConfigurator when you want to change the page title

Method Detail

getPageTitle

public String getPageTitle()

Return the default page title to use for each page, unless overridden individually

Specified by:

getPageTitle in interface ISystemNewFilterWizardConfigurator

getPage1Title

public String getPage1Title()

Return the page title for page 1 (which prompts for the filter string)

Specified by:

getPage1Title in interface ISystemNewFilterWizardConfigurator

getPage1Description

public String getPage1Description()

Return the description for page 1 (which prompts for the filter string)

Specified by:

getPage1Description in interface ISystemNewFilterWizardConfigurator

getPage2Title

public String getPage2Title()

Return the page title for page 2 (which prompts for the name and filter pool)

Specified by:

getPage2Title in interface ISystemNewFilterWizardConfigurator

getPage2Description

public String getPage2Description()

Return the description for page 2 (which prompts for the name and filter pool)

Specified by:

getPage2Description in interface ISystemNewFilterWizardConfigurator

getPage2HelpID

public String getPage2HelpID()

Return the help ID for page 2

Specified by:

getPage2HelpID in interface ISystemNewFilterWizardConfigurator

getPage2NameVerbage

public String getPage2NameVerbage()

Return the verbage for the name prompt on page 2

Specified by:

getPage2NameVerbage in interface ISystemNewFilterWizardConfigurator

getPage2PoolVerbage

public String getPage2PoolVerbage()

Return the verbage for the name prompt on page 2

Specified by:

getPage2PoolVerbage in interface ISystemNewFilterWizardConfigurator

getPage2PoolVerbageTip

public String getPage2PoolVerbageTip()

Return the verbage tooltip for the name prompt on page 2

Specified by:

getPage2PoolVerbageTip in interface ISystemNewFilterWizardConfigurator

getPage2NamePromptLabel

public String getPage2NamePromptLabel()

Description copied from interface: ISystemNewFilterWizardConfigurator

Return the label for the filter name prompt on page 2.

Specified by:

getPage2NamePromptLabel in interface ISystemNewFilterWizardConfigurator

getPage2NamePromptTooltip

public String getPage2NamePromptTooltip()

Description copied from interface: ISystemNewFilterWizardConfigurator

Return the tooltip for the filter name prompt on page 2.

Specified by:

getPage2NamePromptTooltip in interface ISystemNewFilterWizardConfigurator

getPage2PoolPromptLabel

public String getPage2PoolPromptLabel()

Description copied from interface: ISystemNewFilterWizardConfigurator

Return the label for the filter pool prompt on page 2.

Specified by:

getPage2PoolPromptLabel in interface ISystemNewFilterWizardConfigurator

getPage2PoolPromptTooltip

public String getPage2PoolPromptTooltip()

Description copied from interface: ISystemNewFilterWizardConfigurator

Return the label for the filter pool prompt on page 2.

Specified by:

getPage2PoolPromptTooltip in interface ISystemNewFilterWizardConfigurator

getPage2UniqueToConnectionLabel

public String getPage2UniqueToConnectionLabel()

Get the "Unique to this connection" checkbox label

Specified by:

getPage2UniqueToConnectionLabel in interface ISystemNewFilterWizardConfigurator

getPage2UniqueToConnectionToolTip

public String getPage2UniqueToConnectionToolTip()

Set the "Unique to this connection" checkbox tooltip

Specified by:

getPage2UniqueToConnectionToolTip in interface ISystemNewFilterWizardConfigurator

getPage3Title

public String getPage3Title()

Return the page title for page 3 (which shows 2 tips)

Specified by:

getPage3Title in interface ISystemNewFilterWizardConfigurator

getPage3Description

public String getPage3Description()

Return the description for page 3 (which shows 2 tips)

Specified by:

getPage3Description in interface ISystemNewFilterWizardConfigurator

getPage3Tip1

public String getPage3Tip1()

Return the description for page 3 (which shows 2 tips)

Specified by:

getPage3Tip1 in interface ISystemNewFilterWizardConfigurator

getPage3Tip2

public String getPage3Tip2()

Return the second tip on page 3

Specified by:

getPage3Tip2 in interface ISystemNewFilterWizardConfigurator

setPageTitle

public void setPageTitle(String pageTitle)

Set the default page title. Sometimes this is all you want to change and don't want to subclass.

setPage1Description

public void setPage1Description(String description)

Set the description for page 1

setPage2HelpID

public void setPage2HelpID(String helpId)

Set the help ID for page 2

setPage3Tip1

public void setPage3Tip1(String tip)

Set the first tip to show for page 3

setPage3Tip2

public void setPage3Tip2(String tip)

Set the second tip to show for page 3