Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.rse.ui.actions.select
Class QSYSSelectMemberAndRemoteFileAction

java.lang.Object
  extended by SystemBaseDialogAction
      extended by com.ibm.etools.iseries.rse.ui.actions.select.IBMiSelectAbstractQSYSAndRemoteFileOrFolderAction
          extended by com.ibm.etools.iseries.rse.ui.actions.select.QSYSSelectMemberAndRemoteFileAction

public class QSYSSelectMemberAndRemoteFileAction
extends IBMiSelectAbstractQSYSAndRemoteFileOrFolderAction

A reusable action for a dialog prompting for a file member on a remote iSeries system or a remote file from IFS or another universal system.

This dialog offers a tree view for selecting the members:


     Browse for member
                                   
     .---------------------------------------------.
     | + Library1                                  |
     | - Library2                                  |
     |    + File1                                  |
     |    - File2                                  |
     |       Member1                               |
     |       Member2                               |
     |       Member3                               |
     | + Library3                                  |
     .---------------------------------------------.
 
 

To configure the dialog, call these input methods:

To override the default prompt labels and tooltip text, call these input methods:


Field Summary
static String copyright
           
protected  String[] mbrTypes
           
 
Fields inherited from class com.ibm.etools.iseries.rse.ui.actions.select.IBMiSelectAbstractQSYSAndRemoteFileOrFolderAction
addButton, addButtonCallback, addFilterStrings, addLabel, addToolTipText, autoExpandDepth, defaultConnection, dlg, EMPTY_OBJECT_ARRAY, EMPTY_STRING_ARRAY, fileMode, multipleSelectionMode, objTypes, onlyConnection, outputConnection, preSelectLibraryName, preSelectObjectName, rootLibraryName, selectionType, showLiblFilter, showNewConnectionPrompt, showPropertySheet, showPropertySheetDetailsButton, showPropertySheetDetailsButtonInitialState, showYourLibrariesPrompt, title, treeTip, verbage
 
Constructor Summary
  QSYSSelectMemberAndRemoteFileAction(Shell shell)
          Base constructor that offers the default configuration of the dialog All iseries connections are listed, and the first one is selected There is a "New Connection..." special connection object to create new iSeries connections All defaults can be changed via set methods.
protected QSYSSelectMemberAndRemoteFileAction(Shell shell, String label, String tooltip)
          Base constructor used by child classes, to supply their own action label.
 
Method Summary
 void addFileFilter(String fileFilter)
          Add a file filter to the initial list shown when a connection is expanded The file name can be simple or generic and must be qualified, as in LIB/FILE* This is just a specialization of addFilter(String).
 void addMemberFilter(String memberFilter)
          Add a member filter to the initial list shown when a connection is expanded The member name can be simple or generic and must be qualified, as in LIB/FILE(MBR*)
protected  Dialog createDialog(Shell shell)
          Intercept of parent to apply member-unique configuration settings.
protected  QSYSSelectQSYSAndRemoteFileOrFolderDialog getSelectDialog(Shell shell)
          This is the overridable point for the dialog.
 void reset()
          Reset all attributes to initial values.
 void setFileType(String fileType)
          Set the file type for the files to list members in.
 void setFileTypes(String[] fileTypes)
          Set the file types for the files to list members in.
 void setMemberTypes(String[] mbrTypes)
          Set the member types to subset by.
 
Methods inherited from class com.ibm.etools.iseries.rse.ui.actions.select.IBMiSelectAbstractQSYSAndRemoteFileOrFolderAction
addFilter, addLibraryFilter, enableAddMode, enableAddMode, getDialogValue, getFileSubSystem, getSelected, getSelectedConnection, getSelectedObjects, setAddModeLabel, setAutoExpandDepth, setDefaultConnection, setDialogTitle, setMessage, setMultipleSelectionMode, setObjectTypes, setPreSelection, setPreSelection, setRootLibrary, setSelectionTreeToolTipText, setSelectionValidator, setShowLiblFilter, setShowNewConnectionPrompt, setShowPropertySheet, setShowPropertySheet, setShowYourLibrariesPrompt, setSystemConnection
 
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

mbrTypes

protected String[] mbrTypes
Constructor Detail

QSYSSelectMemberAndRemoteFileAction

public QSYSSelectMemberAndRemoteFileAction(Shell shell)
Base constructor that offers the default configuration of the dialog All defaults can be changed via set methods.


QSYSSelectMemberAndRemoteFileAction

protected QSYSSelectMemberAndRemoteFileAction(Shell shell,
                                              String label,
                                              String tooltip)
Base constructor used by child classes, to supply their own action label.

Method Detail

addFileFilter

public void addFileFilter(String fileFilter)
Add a file filter to the initial list shown when a connection is expanded The file name can be simple or generic and must be qualified, as in LIB/FILE* This is just a specialization of addFilter(String). However we also check for the OBJTYPE(type:attr) information, and if not specified will append " OBJTYPE(*FILE:*)" to your filter string


addMemberFilter

public void addMemberFilter(String memberFilter)
Add a member filter to the initial list shown when a connection is expanded The member name can be simple or generic and must be qualified, as in LIB/FILE(MBR*)


setFileType

public void setFileType(String fileType)
Set the file type for the files to list members in. This can be a simple type like "*FILE" or a type and attribute separated by a colon, as in "*FILE:PF-SRC". The attribute can also be generic, as in "*FILE:PF-*".

The default is to list members in *FILE objects that are either data or source files. That is, "*FILE:PF-*"

For convenience you can skip the *FILE and just pass an attribute.


setFileTypes

public void setFileTypes(String[] fileTypes)
Set the file types for the files to list members in. Use this when you want to support multiple file types, such as *FILE:DSPF and *FILE:PRTF


setMemberTypes

public void setMemberTypes(String[] mbrTypes)
Set the member types to subset by. Each String can be a simple type like "RPG" or a generic type like "RPG*".


reset

public void reset()
Reset all attributes to initial values. Useful when reusing an action object

Overrides:
reset in class IBMiSelectAbstractQSYSAndRemoteFileOrFolderAction

createDialog

protected Dialog createDialog(Shell shell)
Intercept of parent to apply member-unique configuration settings.

Overrides:
createDialog in class IBMiSelectAbstractQSYSAndRemoteFileOrFolderAction
See Also:
#run()

getSelectDialog

protected QSYSSelectQSYSAndRemoteFileOrFolderDialog getSelectDialog(Shell shell)
Description copied from class: IBMiSelectAbstractQSYSAndRemoteFileOrFolderAction
This is the overridable point for the dialog.

Overrides:
getSelectDialog in class IBMiSelectAbstractQSYSAndRemoteFileOrFolderAction
See Also:
com.ibm.etools.iseries.core.ui.actions.select.ISeriesSelectAbstractQSYSAndRemoteFileOrFolderAction#getSelectDialog(org.eclipse.swt.widgets.Shell)

Rational Developer for Power Systems Software
V7.6

Copyright 2011 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.