Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.rse.ui.widgets
Class QSYSObjectPrompt

java.lang.Object
  extended by Composite
      extended by com.ibm.etools.iseries.rse.ui.widgets.QSYSBasePrompt
          extended by com.ibm.etools.iseries.rse.ui.widgets.QSYSObjectPrompt
All Implemented Interfaces:
IIBMiConstants, IIBMiHistoryKeys
Direct Known Subclasses:
QSYSDataAreaPrompt, QSYSDataQPrompt, QSYSFilePrompt, QSYSJobDPrompt, QSYSMsgFilePrompt, QSYSProgramPrompt

public class QSYSObjectPrompt
extends QSYSBasePrompt
implements IIBMiConstants, IIBMiHistoryKeys

This re-usable composite widget is for prompting the user for an object name. The object name widget is a combo that lists special values and previously entered (historical) names. Beside the combo is a button with a Browse label for selecting an object from a remote list. Of course objects are qualified by library names so this also prompts for the library.

The composite is layed as follows:


   Library: ______________________v  Browse...
   Object : ______________________v  Browse...
 

You must specify whether this prompt is for a generic object name like ABC* or a scalar object name like ABC1. Beyond appropriate error checking it also affects the special-values contents of the dropdown.

See Also:
setObjectChangeListener(IQSYSObjectPromptListener)

Field Summary
protected  boolean allowGeneric
           
protected  boolean allowLibl
           
protected  IQSYSSelectObjectAction browseObjectAction
           
protected  Button browseObjectButton
           
static String copyright
           
protected  ISeriesObjectFilterString filterString
           
protected  String historyKey
           
protected  String libHistoryKey
           
protected  String libName
           
protected  ValidatorIBMiLibrary libValidator
           
protected  IQSYSObjectPromptListener listener
           
protected  String objectName
           
protected  String[] objTypes
           
protected  ValidatorIBMiObject objValidator
           
protected  SystemHistoryCombo promptObjectCombo
           
protected  Label promptObjectLabel
           
 
Fields inherited from class com.ibm.etools.iseries.rse.ui.widgets.QSYSBasePrompt
browseAction, browseButton, defaultConnection, enableBrowse, gridColumns, ignoreChanges, onlyConnection, promptCombo, promptLabel, rb, showNewConnection, testing
 
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.IIBMiHistoryKeys
ATTR_OBJ, Copyright, GENERIC_ATTR_OBJ, GENERIC_NAME_CMD, GENERIC_NAME_DTAARA, GENERIC_NAME_DTAQ, GENERIC_NAME_FILE, GENERIC_NAME_FILE_DSPF, GENERIC_NAME_FILE_DSPF_PRTF, GENERIC_NAME_FILE_DTA, GENERIC_NAME_FILE_PRTF, GENERIC_NAME_FILE_SRC, GENERIC_NAME_FILE_SRC_DTA, GENERIC_NAME_FLD, GENERIC_NAME_JOBD, GENERIC_NAME_LIB, GENERIC_NAME_LIB_NOLIBL, GENERIC_NAME_MBR, GENERIC_NAME_MODULE, GENERIC_NAME_MSGF, GENERIC_NAME_OBJ, GENERIC_NAME_PGM, GENERIC_NAME_PGM_SRVPGM, GENERIC_NAME_RCD, GENERIC_NAME_SRVPGM, GENERIC_PREFIX, GENERIC_TYPE_MBR, GENERIC_TYPE_OBJ, HISTORY_PREFIX, JOB_CURR_USERID, JOB_NAME, JOB_NUMBER, JOB_SUBSYSTEM, JOB_USER, KEY_NAME, NAME_ASPDEV, NAME_AUTL, NAME_AUTL_AUT, NAME_AUTL_CRTAUT, NAME_CMD, NAME_DTAARA, NAME_DTAQ, NAME_FILE, NAME_FILE_DSPF, NAME_FILE_DSPF_PRTF, NAME_FILE_DTA, NAME_FILE_PRTF, NAME_FILE_SRC, NAME_FILE_SRC_DTA, NAME_FLD, NAME_JOBD, NAME_LIB, NAME_LIB_NOCURLIB, NAME_LIB_NOLIBL, NAME_MBR, NAME_MODULE, NAME_MSGF, NAME_OBJ, NAME_PGM, NAME_PGM_SRVPGM, NAME_RCD, NAME_SRVPGM, RELEASE_JOB_COMMAND, SAVF_LIB_HISTORY_KEY, SAVF_OBJ_HISTORY_KEY, SAVF_RSTLIB_HISTORY_KEY, SAVF_SAVELIB_HISTORY_KEY, SPLF_FILE, SPLF_USER, STRING_FIND, TYPE_MBR, TYPE_OBJ
 
Constructor Summary
QSYSObjectPrompt(Composite parent)
          Constructor when generic names are allowed and no special style is desired for the composite
QSYSObjectPrompt(Composite parent, int style)
          Constructor when generic names are allowed
QSYSObjectPrompt(Composite parent, int style, boolean allowGeneric, boolean allowLibl)
          Constructor when you want to affect whether generic and *LIBL names are allowed for the library
QSYSObjectPrompt(Composite parent, int style, boolean allowGeneric, boolean allowLibl, String libraryHistoryKey, String objectHistoryKey)
          Full constructor when you want to affect whether generic and *LIBL names are allowed for the library, and you want to specify unique history keys for the combo boxes.
 
Method Summary
 void addBrowseButtonSelectionListener(SelectionListener listener)
          Register a listener interested in when the either the library or object browse button is selected
 void addLibraryModifyListener(ModifyListener listener)
          Register a listener interested in library entry field modify events
protected  void addObjectButtonSelectionListener()
          Enables our browse button for objects.
 void addObjectModifyListener(ModifyListener listener)
          Register a listener interested in object entry field modify events
protected  void addOurButtonSelectionListener()
          Library's Browse button pressed handler
 void addSelectionListener(SelectionListener listener)
          Register a listener interested in an item is selected in either the library combo box or the object combo box
 boolean allowsGeneric()
          Returns whether generics are allowed.
protected  void createObjectWidgets(boolean allowGeneric)
          Create our unique object-related widgets.
protected  IIBMiSelectAction getBrowseAction(Shell shell, IHost defaultConnection, boolean onlyConnection)
          Overridable method.
 Button getLibraryBrowseButton()
          Return the library Browse...
 SystemHistoryCombo getLibraryCombo()
          Return the combo box widget for the library prompt
 String getLibraryName()
          Get the user entered or selected library name.
 Label getLibraryPromptLabel()
          Return the library prompt label widget.
protected  IQSYSSelectObjectAction getObjectBrowseAction(Shell shell, IHost defaultConnection, boolean onlyConnection)
          Overridable method.
 Button getObjectBrowseButton()
          Return the object Browse...
 SystemHistoryCombo getObjectCombo()
          Return the combo box widget for the object prompt
protected  ISeriesObjectFilterString getObjectFilterString()
          Get the object filter string to use in building the quick filter string.
 String[] getObjectItems()
          Get the items in the object combo field
 String getObjectName()
          Get the user entered or selected object name.
 Label getObjectPromptLabel()
          Return the object prompt label widget
protected  String[] getObjectTypes()
          Override from parent so we can set the file types for the browse button's default filter
 String getQualifiedName()
          Get the qualified name: lib/obj
protected  void init(boolean allowGeneric, boolean allowLibl)
          Do initialization.
protected  boolean isSpecialName(String nameWithAsterisk)
          Overridable method to distinguish between a generic name like *A and a special name like *USRPRF
protected  void populateLibraryCombo(SystemHistoryCombo combo, boolean allowGeneric, boolean allowLibl)
          Populates our library combo.
protected  void populateObjectCombo(SystemHistoryCombo combo, boolean allowGeneric)
          Populates our object combo.
 void removeBrowseButtonSelectionListener(SelectionListener listener)
          Remove a previously set browse button selection listener.
 void removeLibraryModifyListener(ModifyListener listener)
          Remove a previously set library entry field listener.
 void removeObjectChangeListener()
          Remove object change listener previously set in setProgramChangeListener
 void removeObjectModifyListener(ModifyListener listener)
          Remove a previously set object entry field listener.
 void removeSelectionListener(SelectionListener listener)
          Remove a previously set combo box selection listener.
 void setDefaultConnection(IHost defaultConnection)
          Set the default connection to preselect when Browse is pressed.
 void setEnabled(boolean enabled)
          Disable/Enable all the child controls.
 void setLibraryBrowseButtonFocus()
          Set the focus to the library browse button
 void setLibraryBrowseButtonToolTipText(String tip)
          Set the tooltip text for the library browse button
 boolean setLibraryFocus()
          Set the focus to the library combo field
 void setLibraryItems(String[] items)
          Set the items in the library combo field
 void setLibraryName(String name)
          Set the library name displayed in the combo box.
 void setLibraryPromptLabel(String label)
          Set the Library prompt label text
 void setLibraryToolTipText(String tip)
          Set the tooltip text for the library combo field
 void setLibraryValidator(ValidatorIBMiLibrary libValidator)
          Set the library validator for syntax checking There is one supplied for you so you rarely need to call this.
 void setObjectBrowseButtonFocus()
          Set the focus to the object browse button
 void setObjectBrowseButtonToolTipText(String tip)
          Set the tooltip text for the object browse button
 void setObjectChangeListener(IQSYSObjectPromptListener listener)
          Identify caller that is interested in being informed of live error checking status.
 boolean setObjectFocus()
          Set the focus to the object combo field
 void setObjectItems(String[] items)
          Set the items in the object combo field
 void setObjectName(String name)
          Set the object name displayed in the combo box.
 void setObjectPromptLabel(String label)
          Set the Object prompt label text
 void setObjectToolTipText(String tip)
          Set the tooltip text for the object combo field
 void setObjectTypes(String[] types)
          Set the object types to filter by.
 void setObjectValidator(ValidatorIBMiObject objValidator)
          Set the object validator for syntax checking There is one supplied for you so you rarely need to call this.
 void setSystemConnection(IHost onlyConnection)
          Set the system connection to use when Browse is pressed.
Unlike setDefaultConnection, this has the result of not allowing the user to select or create any other connection.
 void updateHistory()
          Update the history with current entry field setting.
 SystemMessage validateLibInput()
          Validate library string, as it is typed, or in batch if you wish to call directly.
 SystemMessage validateObjInput()
          Validate object string, as it is typed, or in batch if you wish to call directly.
 
Methods inherited from class com.ibm.etools.iseries.rse.ui.widgets.QSYSBasePrompt
addModifyListener, addSelectionChangedListener, createCombo, createHistoryCombo, createPushButton, createPushButton, getBrowseButton, getCombo, getGridColumns, getItems, getPromptLabel, getSelection, getText, lineUpWith, lineUpWith, prepareComposite, removeModifyListener, removeSelectionChangedListener, setBrowseButtonFocus, setBrowseButtonLabel, setBrowseButtonToolTipText, setButtonWidthHint, setButtonWidthHint, setFocus, setHost, setIgnoreChanges, setItems, setPromptLabel, setSelection, setShowNewConnectionPrompt, setText, setToolTipText, setWidthHint, showBrowseButton, showBrowseButton, updateHistory
 
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

promptObjectLabel

protected Label promptObjectLabel

promptObjectCombo

protected SystemHistoryCombo promptObjectCombo

browseObjectButton

protected Button browseObjectButton

listener

protected IQSYSObjectPromptListener listener

allowGeneric

protected boolean allowGeneric

allowLibl

protected boolean allowLibl

objTypes

protected String[] objTypes

filterString

protected ISeriesObjectFilterString filterString

libValidator

protected ValidatorIBMiLibrary libValidator

objValidator

protected ValidatorIBMiObject objValidator

browseObjectAction

protected IQSYSSelectObjectAction browseObjectAction

historyKey

protected String historyKey

libHistoryKey

protected String libHistoryKey

objectName

protected String objectName

libName

protected String libName
Constructor Detail

QSYSObjectPrompt

public QSYSObjectPrompt(Composite parent)
Constructor when generic names are allowed and no special style is desired for the composite

Parameters:
parent - Parent composite
See Also:
#setDefaultConnection(SystemConnection)

QSYSObjectPrompt

public QSYSObjectPrompt(Composite parent,
                        int style)
Constructor when generic names are allowed

Parameters:
parent - Parent composite
style - The SWT style flags for overall composite widget. Typically just pass SWT.NULL
See Also:
#setDefaultConnection(SystemConnection)

QSYSObjectPrompt

public QSYSObjectPrompt(Composite parent,
                        int style,
                        boolean allowGeneric,
                        boolean allowLibl)
Constructor when you want to affect whether generic and *LIBL names are allowed for the library

Parameters:
parent - Parent composite
style - The SWT style flags for overall composite widget. Typically just pass SWT.NULL
defaultConnection - The system connection to preselect when Browse is pressed.
allowGeneric - Pass true to allow generic names in the entry field
allowLibl - Pass false if allowGeneric is false, to restrict user from entering/selecting "*LIBL" for the library
See Also:
#setDefaultConnection(SystemConnection)

QSYSObjectPrompt

public QSYSObjectPrompt(Composite parent,
                        int style,
                        boolean allowGeneric,
                        boolean allowLibl,
                        String libraryHistoryKey,
                        String objectHistoryKey)
Full constructor when you want to affect whether generic and *LIBL names are allowed for the library, and you want to specify unique history keys for the combo boxes.

Parameters:
parent - Parent composite
style - The SWT style flags for overall composite widget. Typically just pass SWT.NULL
defaultConnection - The system connection to preselect when Browse is pressed.
allowGeneric - Pass true to allow generic names in the entry field
allowLibl - Pass false if allowGeneric is false, to restrict user from entering/selecting "*LIBL" for the library
libraryHistoryKey - Pass the key value to use for the library combo, or null to use the default supplied key
objectHistoryKey - Pass the key value to use for the object combo, or null to use the default supplied key
See Also:
#setDefaultConnection(SystemConnection), SystemHistoryCombo#setDefaultHistory(String[])
Method Detail

setObjectChangeListener

public void setObjectChangeListener(IQSYSObjectPromptListener listener)
Identify caller that is interested in being informed of live error checking status. Will be called back for either libary or object changes.


removeObjectChangeListener

public void removeObjectChangeListener()
Remove object change listener previously set in setProgramChangeListener


setDefaultConnection

public void setDefaultConnection(IHost defaultConnection)
Set the default connection to preselect when Browse is pressed.

Overrides:
setDefaultConnection in class QSYSBasePrompt
See Also:
#setSystemConnection(SystemConnection)

getLibraryCombo

public SystemHistoryCombo getLibraryCombo()
Return the combo box widget for the library prompt


getObjectCombo

public SystemHistoryCombo getObjectCombo()
Return the combo box widget for the object prompt


getLibraryName

public String getLibraryName()
Get the user entered or selected library name. Same as calling QSYSBasePrompt.getText()


setLibraryName

public void setLibraryName(String name)
Set the library name displayed in the combo box. Same as calling QSYSBasePrompt.setText(String)


getObjectName

public String getObjectName()
Get the user entered or selected object name. Same as calling QSYSBasePrompt.getText()


setObjectName

public void setObjectName(String name)
Set the object name displayed in the combo box. Same as calling QSYSBasePrompt.setText(String)


setObjectTypes

public void setObjectTypes(String[] types)
Set the object types to filter by. Each must by of form type:attr.


getQualifiedName

public String getQualifiedName()
Get the qualified name: lib/obj


getLibraryBrowseButton

public Button getLibraryBrowseButton()
Return the library Browse... button widget


getObjectBrowseButton

public Button getObjectBrowseButton()
Return the object Browse... button widget


setLibraryItems

public void setLibraryItems(String[] items)
Set the items in the library combo field


setObjectItems

public void setObjectItems(String[] items)
Set the items in the object combo field


getObjectItems

public String[] getObjectItems()
Get the items in the object combo field


setSystemConnection

public void setSystemConnection(IHost onlyConnection)
Set the system connection to use when Browse is pressed.
Unlike setDefaultConnection, this has the result of not allowing the user to select or create any other connection. If you call this, you probably also want to call QSYSBasePrompt.setShowNewConnectionPrompt(boolean).
If you do call QSYSBasePrompt.setShowNewConnectionPrompt(boolean) with false, then this method has the effect of either enabling or disabling the Browser button, depending if the connection is not-null or null, respectively. This is because if they cannot create a connection, and no connection is given, then there is no point in browsing. Note the button is enabled until you call this, so you probably will need to do a priming call with null, to disable it initially if the user selects their connection from another widget. It also means you want to do that priming call after calling QSYSBasePrompt.setShowNewConnectionPrompt(boolean) with false.

See Also:
#setDefaultConnection(SystemConnection), QSYSBasePrompt.setShowNewConnectionPrompt(boolean)

setEnabled

public void setEnabled(boolean enabled)
Disable/Enable all the child controls.

Overrides:
setEnabled in class QSYSBasePrompt

setLibraryPromptLabel

public void setLibraryPromptLabel(String label)
Set the Library prompt label text


setObjectPromptLabel

public void setObjectPromptLabel(String label)
Set the Object prompt label text


getLibraryPromptLabel

public Label getLibraryPromptLabel()
Return the library prompt label widget. Same as calling getPromptLabel()


getObjectPromptLabel

public Label getObjectPromptLabel()
Return the object prompt label widget


setLibraryToolTipText

public void setLibraryToolTipText(String tip)
Set the tooltip text for the library combo field


setObjectToolTipText

public void setObjectToolTipText(String tip)
Set the tooltip text for the object combo field


setLibraryBrowseButtonToolTipText

public void setLibraryBrowseButtonToolTipText(String tip)
Set the tooltip text for the library browse button


setObjectBrowseButtonToolTipText

public void setObjectBrowseButtonToolTipText(String tip)
Set the tooltip text for the object browse button


setLibraryFocus

public boolean setLibraryFocus()
Set the focus to the library combo field


setObjectFocus

public boolean setObjectFocus()
Set the focus to the object combo field


setLibraryBrowseButtonFocus

public void setLibraryBrowseButtonFocus()
Set the focus to the library browse button


setObjectBrowseButtonFocus

public void setObjectBrowseButtonFocus()
Set the focus to the object browse button


addSelectionListener

public void addSelectionListener(SelectionListener listener)
Register a listener interested in an item is selected in either the library combo box or the object combo box

Overrides:
addSelectionListener in class QSYSBasePrompt
See Also:
removeSelectionListener(SelectionListener)

removeSelectionListener

public void removeSelectionListener(SelectionListener listener)
Remove a previously set combo box selection listener.

Overrides:
removeSelectionListener in class QSYSBasePrompt
See Also:
addSelectionListener(SelectionListener)

addBrowseButtonSelectionListener

public void addBrowseButtonSelectionListener(SelectionListener listener)
Register a listener interested in when the either the library or object browse button is selected

Overrides:
addBrowseButtonSelectionListener in class QSYSBasePrompt
See Also:
#removeNewButtonSelectionListener(SelectionListener)

removeBrowseButtonSelectionListener

public void removeBrowseButtonSelectionListener(SelectionListener listener)
Remove a previously set browse button selection listener.

Overrides:
removeBrowseButtonSelectionListener in class QSYSBasePrompt
See Also:
#addNewButtonSelectionListener(SelectionListener)

addLibraryModifyListener

public void addLibraryModifyListener(ModifyListener listener)
Register a listener interested in library entry field modify events

See Also:
removeLibraryModifyListener(ModifyListener)

addObjectModifyListener

public void addObjectModifyListener(ModifyListener listener)
Register a listener interested in object entry field modify events

See Also:
removeObjectModifyListener(ModifyListener)

removeLibraryModifyListener

public void removeLibraryModifyListener(ModifyListener listener)
Remove a previously set library entry field listener.

See Also:
addLibraryModifyListener(ModifyListener)

removeObjectModifyListener

public void removeObjectModifyListener(ModifyListener listener)
Remove a previously set object entry field listener.

See Also:
addObjectModifyListener(ModifyListener)

updateHistory

public void updateHistory()
Update the history with current entry field setting.

This is called automatically for you when setText is called. However, for non-readonly versions, you should still call this yourself when OK is successfully pressed on the dialog box.

Overrides:
updateHistory in class QSYSBasePrompt

setLibraryValidator

public void setLibraryValidator(ValidatorIBMiLibrary libValidator)
Set the library validator for syntax checking There is one supplied for you so you rarely need to call this.


setObjectValidator

public void setObjectValidator(ValidatorIBMiObject objValidator)
Set the object validator for syntax checking There is one supplied for you so you rarely need to call this.


createObjectWidgets

protected void createObjectWidgets(boolean allowGeneric)
Create our unique object-related widgets. Internal use.


init

protected void init(boolean allowGeneric,
                    boolean allowLibl)
Do initialization. Internal use.


allowsGeneric

public boolean allowsGeneric()
Returns whether generics are allowed.


getBrowseAction

protected IIBMiSelectAction getBrowseAction(Shell shell,
                                            IHost defaultConnection,
                                            boolean onlyConnection)
Overridable method. Returns action to be called when Browse... pressed for the library Internal use.

Specified by:
getBrowseAction in class QSYSBasePrompt

getObjectBrowseAction

protected IQSYSSelectObjectAction getObjectBrowseAction(Shell shell,
                                                        IHost defaultConnection,
                                                        boolean onlyConnection)
Overridable method. Returns action to be called when Browse... pressed for the object Internal use.


populateLibraryCombo

protected void populateLibraryCombo(SystemHistoryCombo combo,
                                    boolean allowGeneric,
                                    boolean allowLibl)
Populates our library combo. Internal use.


populateObjectCombo

protected void populateObjectCombo(SystemHistoryCombo combo,
                                   boolean allowGeneric)
Populates our object combo. Internal use.


addOurButtonSelectionListener

protected void addOurButtonSelectionListener()
Library's Browse button pressed handler

Overrides:
addOurButtonSelectionListener in class QSYSBasePrompt

addObjectButtonSelectionListener

protected void addObjectButtonSelectionListener()
Enables our browse button for objects. Note this is surgical browse operation, and only for the object name within the given library. The library name is not updated by this request, only the object name is. Internal use.


isSpecialName

protected boolean isSpecialName(String nameWithAsterisk)
Overridable method to distinguish between a generic name like *A and a special name like *USRPRF


getObjectTypes

protected String[] getObjectTypes()
Override from parent so we can set the file types for the browse button's default filter


getObjectFilterString

protected ISeriesObjectFilterString getObjectFilterString()
Get the object filter string to use in building the quick filter string. Caller must set library and object name!


validateLibInput

public SystemMessage validateLibInput()
Validate library string, as it is typed, or in batch if you wish to call directly.


validateObjInput

public SystemMessage validateObjInput()
Validate object string, as it is typed, or in batch if you wish to call directly.


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.