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

java.lang.Object
  Composite
      com.ibm.etools.iseries.rse.ui.widgets.QSYSBasePrompt
          com.ibm.etools.iseries.rse.ui.widgets.QSYSProgramObjectPrompt

All Implemented Interfaces:

IIBMiHistoryKeys

Direct Known Subclasses:

QSYSModulePrompt

public class QSYSProgramObjectPrompt
extends QSYSBasePrompt
implements 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...
   * Program
            ______________________v  Browse...
   * Service Program
            ______________________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(IISeriesObjectPromptListener)

Field Summary

protected boolean	allowEmpty
protected boolean	allowGeneric
protected boolean	allowLibl
protected Button	browseProgramButton
protected Button	browseServiceProgramButton
static String	copyright
static String	CURLIB
protected ISeriesObjectFilterString	filterString
static String	LIBL
protected ValidatorIBMiObject	libValidator
protected IQSYSObjectPromptListener	listener
protected String[]	objTypes
static String	PGM
protected ValidatorIBMiProgram	pgmValidator
protected Button	programRadioButton
protected SystemHistoryCombo	promptProgramCombo
protected Label	promptProgramLabel
protected SystemHistoryCombo	promptServiceProgramCombo
protected Label	promptServiceProgramLabel
protected Button	serviceProgramRadioButton
static String	SRVPGM

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.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

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

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

QSYSProgramObjectPrompt(Composite parent, int style, boolean allowGeneric, boolean allowLibl)
Constructor

QSYSProgramObjectPrompt(Composite parent, int style, boolean allowGeneric, boolean allowLibl, boolean allowEmpty)
Constructor

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
void	addObjectModifyListener(ModifyListener listener) Register a listener interested in object entry field modify events
protected void	addOurButtonSelectionListener() Library's Browse button pressed handler
void	addRadioButtonsSelectionListener(SelectionListener listener) Register a listener interested in a radio button selection events.
void	addSelectionListener(SelectionListener listener) Register a listener interested in an item is selected in either the library combo box or the object combo box
protected void	createObjectWidgets(boolean allowGeneric) Create our unique object-related widgets.
void	enableProgramPrompt() Program is selected by the user
void	enableServiceProgramPrompt() Service Program is selected by the user
Button	getAcriveProgramObjectBrowseButton() Return the object Browse...
SystemHistoryCombo	getActiveProgramObjectCombo() Get combobox of the active program object control
String[]	getActiveProgramObjectItems() Get the items in the object combo field
String	getActiveProgramObjectName() Get the user entered or selected object name.
String	getActiveProgramObjectType() Get program object type of the active program object control either *PGM or *SRVPGM
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, int programType) Overridable method.
protected ISeriesObjectFilterString	getObjectFilterString() Get the object filter string to use in building the quick filter string.
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
SystemHistoryCombo	getProgramCombo() Return the combo box widget for the Program prompt
String	getQualifiedName() Get the qualified name: library/programObject
SystemHistoryCombo	getServiceProgramCombo() Return the combo box widget for the Service Program prompt
protected void	handleBrowseButtonSelectionEvent(IQSYSSelectObjectAction browseObjectAction, SystemHistoryCombo programObjectCombo) Enables our browse button for objects.
protected void	init(boolean allowGeneric, boolean allowLibl, boolean allowEmpty) Do initialization.
boolean	isProgramRadioButtonSelected() Getter method for programRadioButton selection
boolean	isServiceProgramRadioButtonSelected() Getter method for serviceProgramRadioButton selection
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	populateProgramObjectCombo(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	removeRadioButtonSelectionListener(SelectionListener listener) Remove a previously set radio button selection events listener.
void	removeSelectionListener(SelectionListener listener) Remove a previously set combo box selection listener.
boolean	setActiveProgramObjectFocus() Set the focus to the object combo field
void	setActiveProgramObjectItems(String[] items) Set the items in the object combo field
void	setActiveProgramObjectName(String name) Set the object name displayed in the combo box.
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(ValidatorIBMiObject 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.
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(ValidatorIBMiProgram pgmValidator) 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.
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

PGM

public static final String PGM

See Also:

Constant Field Values

SRVPGM

public static final String SRVPGM

See Also:

Constant Field Values

LIBL

public static final String LIBL

See Also:

Constant Field Values

CURLIB

public static final String CURLIB

See Also:

Constant Field Values

programRadioButton

protected Button programRadioButton

serviceProgramRadioButton

protected Button serviceProgramRadioButton

promptProgramLabel

protected Label promptProgramLabel

promptProgramCombo

protected SystemHistoryCombo promptProgramCombo

browseProgramButton

protected Button browseProgramButton

promptServiceProgramLabel

protected Label promptServiceProgramLabel

promptServiceProgramCombo

protected SystemHistoryCombo promptServiceProgramCombo

browseServiceProgramButton

protected Button browseServiceProgramButton

listener

protected IQSYSObjectPromptListener listener

allowGeneric

protected boolean allowGeneric

allowLibl

protected boolean allowLibl

allowEmpty

protected boolean allowEmpty

objTypes

protected String[] objTypes

filterString

protected ISeriesObjectFilterString filterString

libValidator

protected ValidatorIBMiObject libValidator

pgmValidator

protected ValidatorIBMiProgram pgmValidator

Constructor Detail

QSYSProgramObjectPrompt

public QSYSProgramObjectPrompt(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)

QSYSProgramObjectPrompt

public QSYSProgramObjectPrompt(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)

QSYSProgramObjectPrompt

public QSYSProgramObjectPrompt(Composite parent,
                               int style,
                               boolean allowGeneric,
                               boolean allowLibl)

Constructor

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)

QSYSProgramObjectPrompt

public QSYSProgramObjectPrompt(Composite parent,
                               int style,
                               boolean allowGeneric,
                               boolean allowLibl,
                               boolean allowEmpty)

Constructor

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

allowEmpty - Pass true to allow for empty library and object names

See Also:

#setDefaultConnection(SystemConnection)

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)

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.

getLibraryCombo

public SystemHistoryCombo getLibraryCombo()

Return the combo box widget for the library prompt

getProgramCombo

public SystemHistoryCombo getProgramCombo()

Return the combo box widget for the Program prompt

getServiceProgramCombo

public SystemHistoryCombo getServiceProgramCombo()

Return the combo box widget for the Service Program prompt

getActiveProgramObjectCombo

public SystemHistoryCombo getActiveProgramObjectCombo()

Get combobox of the active program object control

isProgramRadioButtonSelected

public boolean isProgramRadioButtonSelected()

Getter method for programRadioButton selection

isServiceProgramRadioButtonSelected

public boolean isServiceProgramRadioButtonSelected()

Getter method for serviceProgramRadioButton selection

getActiveProgramObjectType

public String getActiveProgramObjectType()

Get program object type of the active program object control either *PGM or *SRVPGM

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)

getActiveProgramObjectName

public String getActiveProgramObjectName()

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

setActiveProgramObjectName

public void setActiveProgramObjectName(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: library/programObject

getLibraryBrowseButton

public Button getLibraryBrowseButton()

Return the library Browse... button widget

getAcriveProgramObjectBrowseButton

public Button getAcriveProgramObjectBrowseButton()

Return the object Browse... button widget

setLibraryItems

public void setLibraryItems(String[] items)

Set the items in the library combo field

setActiveProgramObjectItems

public void setActiveProgramObjectItems(String[] items)

Set the items in the object combo field

getActiveProgramObjectItems

public String[] getActiveProgramObjectItems()

Get the items in the object combo field

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

setActiveProgramObjectFocus

public boolean setActiveProgramObjectFocus()

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:

addSelectionListener(SelectionListener)

removeSelectionListener

public void removeSelectionListener(SelectionListener listener)

Remove a previously set combo box selection listener.

Overrides:

removeSelectionListener in class QSYSBasePrompt

See Also:

removeSelectionListener(SelectionListener)

addRadioButtonsSelectionListener

public void addRadioButtonsSelectionListener(SelectionListener listener)

Register a listener interested in a radio button selection events.

removeRadioButtonSelectionListener

public void removeRadioButtonSelectionListener(SelectionListener listener)

Remove a previously set radio button selection events listener.

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(ValidatorIBMiObject 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(ValidatorIBMiProgram pgmValidator)

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.

enableProgramPrompt

public void enableProgramPrompt()

Program is selected by the user

enableServiceProgramPrompt

public void enableServiceProgramPrompt()

Service Program is selected by the user

init

protected void init(boolean allowGeneric,
                    boolean allowLibl,
                    boolean allowEmpty)

Do initialization. Internal use.

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,
                                                        int programType)

Overridable method. Returns action to be called when Browse... pressed for the object. programTypes we need are: IISeriesSelectionTypes.BROWSEFOR_OBJECT IISeriesSelectionTypes.BROWSEFOR_PGM IISeriesSelectionTypes.BROWSEFOR_SRVPGM For a complete list:

See Also:

Internal use.

populateLibraryCombo

protected void populateLibraryCombo(SystemHistoryCombo combo,
                                    boolean allowGeneric,
                                    boolean allowLibl)

Populates our library combo. Internal use.

populateProgramObjectCombo

protected void populateProgramObjectCombo(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

handleBrowseButtonSelectionEvent

protected void handleBrowseButtonSelectionEvent(IQSYSSelectObjectAction browseObjectAction,
                                                SystemHistoryCombo programObjectCombo)

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.