com.ibm.etools.iseries.rse.ui.dialogs
Class SelectQSYSDialog

java.lang.Object
  SystemPromptDialog
      com.ibm.etools.iseries.rse.ui.dialogs.SelectQSYSDialog

All Implemented Interfaces:

IIBMiConstants, IQSYSSelectionTypes

Direct Known Subclasses:

ClSelectCommand, QSYSSaveAsDialog

public class SelectQSYSDialog
extends SystemPromptDialog
implements IIBMiConstants, IQSYSSelectionTypes

Dialog for allowing users to select a library, object, member, etc from a remote iSeries.

Call these methods to configure the typical functionality of the dialog

• #setSystemConnection(SystemConnection) or #setDefaultConnection(SystemConnection)
• setObjectTypes(String[])
• setMemberTypes(String[])
• setShowPropertySheet(boolean)
• #enableAddMode(com.ibm.etools.systems.core.ui.IRemoteSelectionAddListener)
• setAddModeLabel(String, String)

Call these methods to configure the more advanced functionality of the dialog

• setShowNewConnectionPrompt(boolean) and setShowLiblFilter(boolean)
• setAutoExpandDepth(int)
• #setRootLibrary(SystemConnection, String)
• addFilter(String) or addFilters(Vector)
• setMultipleSelectionMode(boolean)
• #setPreSelection(SystemConnection,String,String) or #setPreSelection(SystemConnection,String,String)
• #setSelectionValidator(com.ibm.etools.systems.core.ui.IValidatorRemoteSelection)

Call these methods to configure the text on the dialog

• setMessage(String)
• setSelectionTreeToolTipText(String)

After running, call these methods to get the output:

• getSelectedObject() or getSelectedObjects()
• getSelectedConnection()

Field Summary

protected IRemoteSelectionAddListener	addButtonCallback
protected boolean	addMode
static String	copyright
protected QSYSSelectQSYSForm	form
protected boolean	multipleSelectionMode
protected IHost	outputConnection
protected int	selectionType
protected boolean	srcFilesOnly

Fields inherited from interface com.ibm.etools.iseries.rse.ui.IIBMiConstants

ICON_ACTION_NEWDTAARA_WIZ, ICON_ACTION_NEWDTAARA_WIZ_ID, ICON_ACTION_NEWDTAARA_WIZ_ROOT, ICON_ACTION_NEWDTAQ_WIZ, ICON_ACTION_NEWDTAQ_WIZ_ID, ICON_ACTION_NEWDTAQ_WIZ_ROOT, ICON_ACTION_NEWLIB_WIZ, ICON_ACTION_NEWLIB_WIZ_ID, ICON_ACTION_NEWLIB_WIZ_ROOT, ICON_ACTION_NEWMBR_WIZ, ICON_ACTION_NEWMBR_WIZ_ID, ICON_ACTION_NEWMBR_WIZ_ROOT, ICON_ACTION_NEWMSG_WIZ, ICON_ACTION_NEWMSG_WIZ_ID, ICON_ACTION_NEWMSG_WIZ_ROOT, ICON_ACTION_NEWMSGFILE_WIZ, ICON_ACTION_NEWMSGFILE_WIZ_ID, ICON_ACTION_NEWMSGFILE_WIZ_ROOT, ICON_ACTION_NEWOBJ_WIZ, ICON_ACTION_NEWOBJ_WIZ_ID, ICON_ACTION_NEWOBJ_WIZ_ROOT, ICON_ACTION_NEWSRCFILE_WIZ, ICON_ACTION_NEWSRCFILE_WIZ_ID, ICON_ACTION_NEWSRCFILE_WIZ_ROOT, ICON_CMD_FILTER_CMD, ICON_CMD_FILTER_CMD_ID, ICON_CMD_FILTER_CMD_ROOT, ICON_ERRORLIST_DELETED_LINE, ICON_ERRORLIST_DELETED_LINE_ID, ICON_ERRORLIST_DELETED_LINE_ROOT, ICON_ERRORLIST_GO_BACK, ICON_ERRORLIST_GO_BACK_DISABLE, ICON_ERRORLIST_GO_BACK_DISABLE_ID, ICON_ERRORLIST_GO_BACK_DISABLE_ROOT, ICON_ERRORLIST_GO_BACK_ID, ICON_ERRORLIST_GO_BACK_ROOT, ICON_ERRORLIST_GO_FORWARD, ICON_ERRORLIST_GO_FORWARD_DISABLE, ICON_ERRORLIST_GO_FORWARD_DISABLE_ID, ICON_ERRORLIST_GO_FORWARD_DISABLE_ROOT, ICON_ERRORLIST_GO_FORWARD_ID, ICON_ERRORLIST_GO_FORWARD_ROOT, ICON_ERRORLIST_MODIFIED_LINE, ICON_ERRORLIST_MODIFIED_LINE_ID, ICON_ERRORLIST_MODIFIED_LINE_ROOT, ICON_ERRORLIST_REMOVE, ICON_ERRORLIST_REMOVE_ALL, ICON_ERRORLIST_REMOVE_ALL_DISABLE, ICON_ERRORLIST_REMOVE_ALL_DISABLE_ID, ICON_ERRORLIST_REMOVE_ALL_DISABLE_ROOT, ICON_ERRORLIST_REMOVE_ALL_ID, ICON_ERRORLIST_REMOVE_ALL_ROOT, ICON_ERRORLIST_REMOVE_DISABLE, ICON_ERRORLIST_REMOVE_DISABLE_ID, ICON_ERRORLIST_REMOVE_DISABLE_ROOT, ICON_ERRORLIST_REMOVE_ID, ICON_ERRORLIST_REMOVE_ROOT, ICON_ERRORLIST_SEVERITY_ERROR, ICON_ERRORLIST_SEVERITY_ERROR_ID, ICON_ERRORLIST_SEVERITY_ERROR_ROOT, ICON_ERRORLIST_SEVERITY_INFORMATION, ICON_ERRORLIST_SEVERITY_INFORMATION_ID, ICON_ERRORLIST_SEVERITY_INFORMATION_ROOT, ICON_ERRORLIST_SEVERITY_SEVERE, ICON_ERRORLIST_SEVERITY_SEVERE_ID, ICON_ERRORLIST_SEVERITY_SEVERE_ROOT, ICON_ERRORLIST_SEVERITY_TERMINATING, ICON_ERRORLIST_SEVERITY_TERMINATING_ID, ICON_ERRORLIST_SEVERITY_TERMINATING_ROOT, ICON_ERRORLIST_SEVERITY_WARNING, ICON_ERRORLIST_SEVERITY_WARNING_ID, ICON_ERRORLIST_SEVERITY_WARNING_ROOT, ICON_EXT, ICON_JOB_FILTER_JOB, ICON_JOB_FILTER_JOB_ID, ICON_JOB_FILTER_JOB_ROOT, ICON_JOBSUBSYSTEM, ICON_JOBSUBSYSTEM_ID, ICON_JOBSUBSYSTEM_ROOT, ICON_NFS_ACTION_REFRESH, ICON_NFS_ACTION_REFRESH_DISABLE, ICON_NFS_ACTION_REFRESH_DISABLE_ID, ICON_NFS_ACTION_REFRESH_DISABLE_ROOT, ICON_NFS_ACTION_REFRESH_ID, ICON_NFS_ACTION_REFRESH_ROOT, ICON_NFS_ACTION_TABLEVIEW_UP, ICON_NFS_ACTION_TABLEVIEW_UP_DISABLED, ICON_NFS_ACTION_TABLEVIEW_UP_DISABLED_ID, ICON_NFS_ACTION_TABLEVIEW_UP_DISABLED_ROOT, ICON_NFS_ACTION_TABLEVIEW_UP_ID, ICON_NFS_ACTION_TABLEVIEW_UP_ROOT, ICON_NFS_FILTER_LIBLIST, ICON_NFS_FILTER_LIBLIST_ID, ICON_NFS_FILTER_LIBLIST_ROOT, ICON_NFS_FILTER_LIBRARY, ICON_NFS_FILTER_LIBRARY_ID, ICON_NFS_FILTER_LIBRARY_ROOT, ICON_NFS_FILTER_MEMBER, ICON_NFS_FILTER_MEMBER_ID, ICON_NFS_FILTER_MEMBER_ROOT, ICON_NFS_FILTER_OBJECT, ICON_NFS_FILTER_OBJECT_ID, ICON_NFS_FILTER_OBJECT_ROOT, ICON_NFS_FLD_TYPE_BIN, ICON_NFS_FLD_TYPE_BIN_ID, ICON_NFS_FLD_TYPE_BIN_ROOT, ICON_NFS_FLD_TYPE_CHAR, ICON_NFS_FLD_TYPE_CHAR_ID, ICON_NFS_FLD_TYPE_CHAR_ROOT, ICON_NFS_FLD_TYPE_DATE, ICON_NFS_FLD_TYPE_DATE_ID, ICON_NFS_FLD_TYPE_DATE_ROOT, ICON_NFS_FLD_TYPE_FLOAT, ICON_NFS_FLD_TYPE_FLOAT_ID, ICON_NFS_FLD_TYPE_FLOAT_ROOT, ICON_NFS_FLD_TYPE_HEX, ICON_NFS_FLD_TYPE_HEX_ID, ICON_NFS_FLD_TYPE_HEX_ROOT, ICON_NFS_FLD_TYPE_PACKED, ICON_NFS_FLD_TYPE_PACKED_ID, ICON_NFS_FLD_TYPE_PACKED_ROOT, ICON_NFS_FLD_TYPE_TIME, ICON_NFS_FLD_TYPE_TIME_ID, ICON_NFS_FLD_TYPE_TIME_ROOT, ICON_NFS_FLD_TYPE_TIMESTAMP, ICON_NFS_FLD_TYPE_TIMESTAMP_ID, ICON_NFS_FLD_TYPE_TIMESTAMP_ROOT, ICON_NFS_FLD_TYPE_ZONED, ICON_NFS_FLD_TYPE_ZONED_ID, ICON_NFS_FLD_TYPE_ZONED_ROOT, ICON_NFS_MBR_TYPE_DTA, ICON_NFS_MBR_TYPE_DTA_ID, ICON_NFS_MBR_TYPE_DTA_ROOT, ICON_NFS_MBR_TYPE_SRC, ICON_NFS_MBR_TYPE_SRC_ID, ICON_NFS_MBR_TYPE_SRC_ROOT, ICON_NFS_OBJ_MSGF_MESSAGE, ICON_NFS_OBJ_MSGF_MESSAGE_ID, ICON_NFS_OBJ_MSGF_MESSAGE_ROOT, ICON_NFS_OBJ_TYPE_BNDDIR, ICON_NFS_OBJ_TYPE_BNDDIR_ID, ICON_NFS_OBJ_TYPE_BNDDIR_ROOT, ICON_NFS_OBJ_TYPE_CMD, ICON_NFS_OBJ_TYPE_CMD_ID, ICON_NFS_OBJ_TYPE_CMD_ROOT, ICON_NFS_OBJ_TYPE_CURRLIB, ICON_NFS_OBJ_TYPE_CURRLIB_ID, ICON_NFS_OBJ_TYPE_CURRLIB_ROOT, ICON_NFS_OBJ_TYPE_DATAAREA, ICON_NFS_OBJ_TYPE_DATAAREA_ID, ICON_NFS_OBJ_TYPE_DATAAREA_ROOT, ICON_NFS_OBJ_TYPE_DATAQUEUE, ICON_NFS_OBJ_TYPE_DATAQUEUE_ID, ICON_NFS_OBJ_TYPE_DATAQUEUE_ROOT, ICON_NFS_OBJ_TYPE_DDMF, ICON_NFS_OBJ_TYPE_DDMF_ID, ICON_NFS_OBJ_TYPE_DDMF_ROOT, ICON_NFS_OBJ_TYPE_DISPLAYFILE, ICON_NFS_OBJ_TYPE_DISPLAYFILE_ID, ICON_NFS_OBJ_TYPE_DISPLAYFILE_ROOT, ICON_NFS_OBJ_TYPE_ISERIESOBJ, ICON_NFS_OBJ_TYPE_ISERIESOBJ_ID, ICON_NFS_OBJ_TYPE_ISERIESOBJ_ROOT, ICON_NFS_OBJ_TYPE_JOBDESCRIPTION, ICON_NFS_OBJ_TYPE_JOBDESCRIPTION_ID, ICON_NFS_OBJ_TYPE_JOBDESCRIPTION_ROOT, ICON_NFS_OBJ_TYPE_JOBQ, ICON_NFS_OBJ_TYPE_JOBQ_ID, ICON_NFS_OBJ_TYPE_JOBQ_ROOT, ICON_NFS_OBJ_TYPE_LF, ICON_NFS_OBJ_TYPE_LF_ID, ICON_NFS_OBJ_TYPE_LF_ROOT, ICON_NFS_OBJ_TYPE_LIBRARY, ICON_NFS_OBJ_TYPE_LIBRARY_ID, ICON_NFS_OBJ_TYPE_LIBRARY_ROOT, ICON_NFS_OBJ_TYPE_MESSAGEFILE, ICON_NFS_OBJ_TYPE_MESSAGEFILE_ID, ICON_NFS_OBJ_TYPE_MESSAGEFILE_ROOT, ICON_NFS_OBJ_TYPE_MODULE, ICON_NFS_OBJ_TYPE_MODULE_ID, ICON_NFS_OBJ_TYPE_MODULE_ROOT, ICON_NFS_OBJ_TYPE_MSGQ, ICON_NFS_OBJ_TYPE_MSGQ_ID, ICON_NFS_OBJ_TYPE_MSGQ_ROOT, ICON_NFS_OBJ_TYPE_OUTQ, ICON_NFS_OBJ_TYPE_OUTQ_ID, ICON_NFS_OBJ_TYPE_OUTQ_ROOT, ICON_NFS_OBJ_TYPE_PFSRC, ICON_NFS_OBJ_TYPE_PFSRC_ID, ICON_NFS_OBJ_TYPE_PFSRC_ROOT, ICON_NFS_OBJ_TYPE_PHYSICALFILE, ICON_NFS_OBJ_TYPE_PHYSICALFILE_ID, ICON_NFS_OBJ_TYPE_PHYSICALFILE_ROOT, ICON_NFS_OBJ_TYPE_PNLGRP, ICON_NFS_OBJ_TYPE_PNLGRP_ID, ICON_NFS_OBJ_TYPE_PNLGRP_ROOT, ICON_NFS_OBJ_TYPE_PRINTERFILE, ICON_NFS_OBJ_TYPE_PRINTERFILE_ID, ICON_NFS_OBJ_TYPE_PRINTERFILE_ROOT, ICON_NFS_OBJ_TYPE_PROGRAM, ICON_NFS_OBJ_TYPE_PROGRAM_ID, ICON_NFS_OBJ_TYPE_PROGRAM_ROOT, ICON_NFS_OBJ_TYPE_SAVF, ICON_NFS_OBJ_TYPE_SAVF_ID, ICON_NFS_OBJ_TYPE_SAVF_ROOT, ICON_NFS_OBJ_TYPE_SERVICEPGM, ICON_NFS_OBJ_TYPE_SERVICEPGM_ID, ICON_NFS_OBJ_TYPE_SERVICEPGM_ROOT, ICON_NFS_OBJ_TYPE_SQLPKG, ICON_NFS_OBJ_TYPE_SQLPKG_ID, ICON_NFS_OBJ_TYPE_SQLPKG_ROOT, ICON_NFS_OBJ_TYPE_SYSTEM400_MESSAGE, ICON_NFS_OBJ_TYPE_SYSTEM400_MESSAGE_ROOT, ICON_NFS_OBJ_TYPE_SYSTEM400_MESSAGESEVERE, ICON_NFS_OBJ_TYPE_SYSTEM400_MESSAGESEVERE_ROOT, ICON_NFS_OBJ_TYPE_TBL, ICON_NFS_OBJ_TYPE_TBL_ID, ICON_NFS_OBJ_TYPE_TBL_ROOT, ICON_NFS_OBJ_TYPE_USRQ, ICON_NFS_OBJ_TYPE_USRQ_ID, ICON_NFS_OBJ_TYPE_USRQ_ROOT, ICON_NFS_OBJ_TYPE_USRSPC, ICON_NFS_OBJ_TYPE_USRSPC_ID, ICON_NFS_OBJ_TYPE_USRSPC_ROOT, ICON_NFS_RCD_TYPE_NORMAL, ICON_NFS_RCD_TYPE_NORMAL_ID, ICON_NFS_RCD_TYPE_NORMAL_ROOT, ICON_NULL_FIELD, ICON_NULL_FIELD_ID, ICON_NULL_FIELD_OBJ, ICON_NULL_FIELD_OBJ_ID, ICON_NULL_FIELD_OBJ_ROOT, ICON_NULL_FIELD_ROOT, ICON_RELATIVE_PATH_DLCL16, ICON_RELATIVE_PATH_ELCL16, ICON_RELATIVE_PATH_ETOOL16, ICON_RELATIVE_PATH_FULL, ICON_RELATIVE_PATH_OBJ16, ICON_RELATIVE_PATH_WIZBAN, ICON_SHOW_IN_ERROR_LIST, ICON_SHOW_IN_ERROR_LIST_D, ICON_SHOW_IN_ERROR_LIST_D_ID, ICON_SHOW_IN_ERROR_LIST_D_ROOT, ICON_SHOW_IN_ERROR_LIST_ID, ICON_SHOW_IN_ERROR_LIST_ROOT, ICON_SUFFIX, ICON_SYSTEM_ASUBPROC, ICON_SYSTEM_ASUBPROC_ID, ICON_SYSTEM_ASUBPROC_ROOT, ICON_SYSTEM_CODE, ICON_SYSTEM_CODE_ID, ICON_SYSTEM_CODE_ROOT, ICON_SYSTEM_CODEDSU, ICON_SYSTEM_CODEDSU_ID, ICON_SYSTEM_CODEDSU_ROOT, ICON_SYSTEM_FILTER_WWLIBS, ICON_SYSTEM_FILTER_WWLIBS_ID, ICON_SYSTEM_FILTER_WWLIBS_ROOT, ICON_SYSTEM_FILTER_WWMBRS, ICON_SYSTEM_FILTER_WWMBRS_ID, ICON_SYSTEM_FILTER_WWMBRS_ROOT, ICON_SYSTEM_FILTER_WWOBJS, ICON_SYSTEM_FILTER_WWOBJS_ID, ICON_SYSTEM_FILTER_WWOBJS_ROOT, ICON_SYSTEM_INTERJOB, ICON_SYSTEM_INTERJOB_ID, ICON_SYSTEM_INTERJOB_ROOT, ICON_SYSTEM_JOB, ICON_SYSTEM_JOB_ID, ICON_SYSTEM_JOB_ROOT, ICON_SYSTEM_JOBACTIVE, ICON_SYSTEM_JOBACTIVE_ID, ICON_SYSTEM_JOBACTIVE_ROOT, ICON_SYSTEM_JOBQUEUED, ICON_SYSTEM_JOBQUEUED_ID, ICON_SYSTEM_JOBQUEUED_ROOT, ICON_SYSTEM_KEYFIELD, ICON_SYSTEM_KEYFIELD_ID, ICON_SYSTEM_KEYFIELD_ROOT, ICON_SYSTEM_MESSAGE_ID, ICON_SYSTEM_MESSAGESEVERE_ID, ICON_SYSTEM_NEWDTAARA, ICON_SYSTEM_NEWDTAARA_ID, ICON_SYSTEM_NEWDTAARA_ROOT, ICON_SYSTEM_NEWDTAQ, ICON_SYSTEM_NEWDTAQ_ID, ICON_SYSTEM_NEWDTAQ_ROOT, ICON_SYSTEM_NEWLIBRARY, ICON_SYSTEM_NEWLIBRARY_ID, ICON_SYSTEM_NEWLIBRARY_ROOT, ICON_SYSTEM_NEWMEMBER, ICON_SYSTEM_NEWMEMBER_ID, ICON_SYSTEM_NEWMEMBER_ROOT, ICON_SYSTEM_NEWMSG, ICON_SYSTEM_NEWMSG_ID, ICON_SYSTEM_NEWMSG_ROOT, ICON_SYSTEM_NEWMSGFILE, ICON_SYSTEM_NEWMSGFILE_ID, ICON_SYSTEM_NEWMSGFILE_ROOT, ICON_SYSTEM_NEWSRCFILE, ICON_SYSTEM_NEWSRCFILE_ID, ICON_SYSTEM_NEWSRCFILE_ROOT, ICON_SYSTEM_RUN, ICON_SYSTEM_RUN_ID, ICON_SYSTEM_RUN_ROOT, ICON_SYSTEM_SERVERJOB, ICON_SYSTEM_SERVERJOB_ID, ICON_SYSTEM_SERVERJOB_ROOT, PLUGIN_ID, PREFIX, RSE_TEMP_LIB, RUN_IN_BATCH, RUN_IN_BATCH_CMD_PREFIX, RUN_IN_INTERACTIVE, RUN_IN_INTERACTIVE_CMD_PREFIX, RUN_IN_RSESERVER, RUN_IN_RSESERVER_CMD_PREFIX, RUN_IN_RSESERVERMULTITHREADED, RUN_IN_RSESERVERMULTITHREADED_CMD_PREFIX, validJobNameChars, VARIANTS

Fields inherited from interface com.ibm.etools.iseries.rse.ui.widgets.IQSYSSelectionTypes

BROWSEFOR_ANY, BROWSEFOR_COMMAND, BROWSEFOR_CRT_COMMAND, BROWSEFOR_DTAARA, BROWSEFOR_DTAQ, BROWSEFOR_FIELD, BROWSEFOR_FILE, BROWSEFOR_JOB, BROWSEFOR_JOBD, BROWSEFOR_JOBQ, BROWSEFOR_LIBRARY, BROWSEFOR_MEMBER, BROWSEFOR_MESSAGE, BROWSEFOR_MODULE, BROWSEFOR_MSGF, BROWSEFOR_OBJECT, BROWSEFOR_PGM, BROWSEFOR_PGM_MODULE, BROWSEFOR_PGMSRVPGM, BROWSEFOR_PROCEDURE, BROWSEFOR_RECORD, BROWSEFOR_SRVPGM, Copyright

Constructor Summary

SelectQSYSDialog(Shell shell, int selectionType, boolean srcFilesOnly)
Constructor

SelectQSYSDialog(Shell shell, String title, int selectionType, boolean srcFilesOnly)
Constructor when you want to supply your own title.

Method Summary

protected Object	addButtonPressed(IHost selectedConnection, Object[] selectedObjects) The user has pressed the Add button.
void	addFilter(String filterString) Add a filter that users can expand to start their search.
void	addFilters(Vector<String> filterStrings) Add one or more filters that users can expand to start their search.
boolean	close() We have to override close to ensure that we reset the form to null
protected Control	createInner(Composite parent) Private method.
protected ISystemMessageLine	createMessageLine(Composite c) Create message line.
void	enableAddMode(IRemoteSelectionAddListener caller) Enable Add mode.
protected QSYSSelectQSYSForm	getForm(int selectionTypes, boolean srcFilesOnly) Private method.
protected Control	getInitialFocusControl() Private method.
boolean	getMultipleSelectionMode() Return the multiple selection mode as set by setMultipleSelectionMode(boolean)
IHost	getSelectedConnection() Return selected connection
Object	getSelectedObject() Return selected ISeriesXXX object (or first one if multiple selection enabled)
Object[]	getSelectedObjects() Return all selected objects.
protected boolean	processAdd() Private method.
protected boolean	processDetails(boolean hideMode) Private method.
protected boolean	processOK() Private method.
void	setAddModeLabel(String addLabel, String addToolTipText) Method that allows setting the label and tooltip text of the Add button.
void	setAutoExpandDepth(int depth) Specify the zero-based auto-expand level for the tree.
void	setDefaultConnection(IHost conn) Set the connection to pre-select and expand
void	setMemberTypes(String[] mbrTypes) Set the members types and attributes to subset by, when the selection mode is members
void	setMessage(String message) Set the message shown at the top of the form
void	setMultipleSelectionMode(boolean multiple) Set multiple selection mode.
void	setObjectTypes(String[] objTypes) Set the object types and attributes to subset by, when the selection mode is objects (this is called for you for other types of selections).
void	setPageComplete(boolean complete)
void	setPreSelection(IHost connection, String libraryName) Set an library to preselect.
void	setPreSelection(IHost connection, String libraryName, String objectName) Set an object to preselect.
void	setRootLibrary(IHost connection, String libraryName) Set the root library from which to start listing objects.
void	setSelectionTreeToolTipText(String tip) Set the tooltip text for the remote systems tree from which an item is selected.
void	setSelectionValidator(IValidatorRemoteSelection selectionValidator) Specify a validator to use when the user selects a remote object.
void	setShowLiblFilter(boolean show) Set to false to not show "*LIBL" library filter on initial expand of a connection.
void	setShowNewConnectionPrompt(boolean show) Set to true if a "New Connection..." special connection is to be shown for creating new connections
void	setShowPropertySheet(boolean show) Show the property sheet on the right hand side, to show the properties of the selected object.
void	setShowPropertySheet(boolean show, boolean initialState) Show the property sheet on the right hand side, to show the properties of the selected object.
void	setShowYourLibrariesPrompt(boolean show) Set to false to not show "YourLibraries..." special filter prompt
void	setSystemConnection(IHost conn) Set the system connection to restrict the user to selecting files or folders from

Methods inherited from class java.lang.Object

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

Field Detail

copyright

public static final String copyright

See Also:

Constant Field Values

form

protected QSYSSelectQSYSForm form

srcFilesOnly

protected boolean srcFilesOnly

selectionType

protected int selectionType

outputConnection

protected IHost outputConnection

multipleSelectionMode

protected boolean multipleSelectionMode

addMode

protected boolean addMode

addButtonCallback

protected IRemoteSelectionAddListener addButtonCallback

Constructor Detail

SelectQSYSDialog

public SelectQSYSDialog(Shell shell,
                        int selectionType,
                        boolean srcFilesOnly)

Constructor

Parameters:

shell - The shell to hang the dialog off of

selectionType - An enumeration indicating the type of object to browse for, as specified in IQSYSSelectionTypes

srcFilesOnly - If the selection type is files or members, indicate whether to restrict to source files

SelectQSYSDialog

public SelectQSYSDialog(Shell shell,
                        String title,
                        int selectionType,
                        boolean srcFilesOnly)

Constructor when you want to supply your own title.

Parameters:

shell - The shell to hang the dialog off of

title - The title to give the dialog

selectionType - An enumeration indicating the type of object to browse for, as specified in com.ibm.etools.iseries.core.ui.widgets.IISeriesSelectionTypes

srcFilesOnly - If the selection type is files or members, indicate whether to restrict to source files

Method Detail

setSystemConnection

public void setSystemConnection(IHost conn)

Set the system connection to restrict the user to selecting files or folders from

setDefaultConnection

public void setDefaultConnection(IHost conn)

Set the connection to pre-select and expand

setShowNewConnectionPrompt

public void setShowNewConnectionPrompt(boolean show)

Set to true if a "New Connection..." special connection is to be shown for creating new connections

setShowYourLibrariesPrompt

public void setShowYourLibrariesPrompt(boolean show)

Set to false to not show "YourLibraries..." special filter prompt

setShowLiblFilter

public void setShowLiblFilter(boolean show)

Set to false to not show "*LIBL" library filter on initial expand of a connection. Default is true. If you turn off this and you turn off setShowYourLibrariesPrompt, then the expansion of a connection will be an empty list. So, you must call addLibraryFilter to supply your own, or call setRootLibrary such that expanding a connection immediately lists the contens of that library as per the objTypes setting.

setMessage

public void setMessage(String message)

Set the message shown at the top of the form

setSelectionTreeToolTipText

public void setSelectionTreeToolTipText(String tip)

Set the tooltip text for the remote systems tree from which an item is selected.

setAutoExpandDepth

public void setAutoExpandDepth(int depth)

Specify the zero-based auto-expand level for the tree. The default is zero, meaning only show the connections

addFilter

public void addFilter(String filterString)

Add a filter that users can expand to start their search.

This is really a filter string versus a filter, but it is realized in the GUI as a temporary filter.

addFilters

public void addFilters(Vector<String> filterStrings)

Add one or more filters that users can expand to start their search.

These are really filter strings versus filters, but they are realized in the GUI as temporary filters.

Parameters:

filterstrings - Vector of strings

setRootLibrary

public void setRootLibrary(IHost connection,
                           String libraryName)

Set the root library from which to start listing objects. What this means is that when a connection is expanded, the user will immediately see the contents of the given library, subject to the object types you have specified via setObjectTypes.

Parameters:

connection - The connection to the remote system containing the root library

libraryName - The name of the library to start listing from

setPreSelection

public void setPreSelection(IHost connection,
                            String libraryName)

Set an library to preselect. This will:

• Set the connection as the default connection
• Add a filter for the parent library
• Pre-expand the library filter
• Pre-select the library after expansion

setPreSelection

public void setPreSelection(IHost connection,
                            String libraryName,
                            String objectName)

Set an object to preselect. This will:

• Set the connection as the default connection
• Add a filter for the contents of the given library, honoring the object types for this selection type
• Pre-expand the parent library filter
• Pre-select the given object after expansion

setObjectTypes

public void setObjectTypes(String[] objTypes)

Set the object types and attributes to subset by, when the selection mode is objects (this is called for you for other types of selections).

Each String can be a simple type like "*FILE" or a type and attribute, colon-separated, like "*FILE:DSPF".

setMemberTypes

public void setMemberTypes(String[] mbrTypes)

Set the members types and attributes to subset by, when the selection mode is members

Each String can be a simple type like "RPG" or a generic string like "RPG*"

enableAddMode

public void enableAddMode(IRemoteSelectionAddListener caller)

Enable Add mode. This means the OK button is replaced with an Add button, and the Cancel with a Close button. When Add is pressed, the caller is called back. The dialog is not exited until Close is pressed.

The caller will be called back when any remote object(s) is/are selected to decide whether to enable the Add button. It is also called when Add is pressed.

setAddModeLabel

public void setAddModeLabel(String addLabel,
                            String addToolTipText)

Method that allows setting the label and tooltip text of the Add button. If you pass null for the label, the default is used ("Add").

setShowPropertySheet

public void setShowPropertySheet(boolean show)

Show the property sheet on the right hand side, to show the properties of the selected object.

This overload always shows the property sheet

Default is false

setShowPropertySheet

public void setShowPropertySheet(boolean show,
                                 boolean initialState)

Show the property sheet on the right hand side, to show the properties of the selected object.

This overload shows a Details>>> button so the user can decide if they want to see the property sheet.

Parameters:

show - True if show the property sheet within the dialog

initialState - True if the property is to be initially displayed, false if it is not to be displayed until the user presses the Details button.

setMultipleSelectionMode

public void setMultipleSelectionMode(boolean multiple)

Set multiple selection mode. Default is single selection only.

If you set this to true you must use getSelectedObjects()

Further, if you turn this on, it has the side effect of allowing the user to select any remote object. The assumption being if you are prompting for children, you also want to allow the user to select a parent, with the meaning being that all children within the parent are implicitly selected.

To restrict what types of objects can be selected, use #setSelectionValidator(com.ibm.etools.systems.core.ui.IValidatorRemoteSelection)

getMultipleSelectionMode

public boolean getMultipleSelectionMode()

Return the multiple selection mode as set by setMultipleSelectionMode(boolean)

setSelectionValidator

public void setSelectionValidator(IValidatorRemoteSelection selectionValidator)

Specify a validator to use when the user selects a remote object. This allows you to decide if OK should be enabled or not for that remote object

getSelectedObject

public Object getSelectedObject()

Return selected ISeriesXXX object (or first one if multiple selection enabled)

getSelectedObjects

public Object[] getSelectedObjects()

Return all selected objects. This method will return an array of one unless you have called setMultipleSelectionMode(true)!

See Also:

setMultipleSelectionMode(boolean)

getSelectedConnection

public IHost getSelectedConnection()

Return selected connection

getInitialFocusControl

protected Control getInitialFocusControl()

Private method.

See Also:

SystemPromptDialog#getInitialFocusControl()

createInner

protected Control createInner(Composite parent)

Private method.

See Also:

SystemPromptDialog#createInner(Composite)

getForm

protected QSYSSelectQSYSForm getForm(int selectionTypes,
                                     boolean srcFilesOnly)

Private method. Get the contents.

createMessageLine

protected ISystemMessageLine createMessageLine(Composite c)

Create message line. Intercept so we can set msg line of form.

processOK

protected boolean processOK()

Private method.

Called when user presses OK button. Return true to close dialog. Return false to not close dialog.

processDetails

protected boolean processDetails(boolean hideMode)

Private method.

Called when user presses DETAILS button.

Note the text is automatically toggled for us! We need only do whatever the functionality is that we desire

Parameters:

hideMode - the current state of the details toggle, prior to this request. If we return true from this method, this state and the button text will be toggled.

Returns:

true if the details state toggle was successful, false if it failed.

setPageComplete

public void setPageComplete(boolean complete)

close

public boolean close()

We have to override close to ensure that we reset the form to null

processAdd

protected boolean processAdd()

Private method.

Called when user presses Add button.

addButtonPressed

protected Object addButtonPressed(IHost selectedConnection,
                                  Object[] selectedObjects)

The user has pressed the Add button. Do something appropriate with the request. If this action fails for some reason, or you wish to display a completion message, return message text that will be displayed in the dialog's message line. Else, return null.

Parameters:

selectedConnection - The connection the object was selected in

selectedObjects - Will be a list of selected objects, such as ISeriesLibrary or ISeriesMember

Returns:

A String or SystemMessage object that will be displayed if the action fails, null if the action was successfull