com.ibm.etools.iseries.rse.ui
Class QSYSFilterStringBaseEditPane

java.lang.Object
  SystemFilterStringEditPane
      com.ibm.etools.iseries.rse.ui.QSYSFilterStringBaseEditPane

Direct Known Subclasses:

QSYSFilterStringEditPaneCommands, QSYSFilterStringEditPaneJobs, QSYSFilterStringEditPaneLibraries, QSYSFilterStringEditPaneMembers, QSYSFilterStringEditPaneObjects, QSYSFilterStringEditPaneSplf

public class QSYSFilterStringBaseEditPane
extends SystemFilterStringEditPane

This is a base class edit pane for prompting for an iSeries filter string. Abstracts out common stuff. Add @SuppressWarnings since org.eclipse.rse.internal.ui.actions.SystemTestFilterStringAction is an internal class in openRSE. Need to address that.

Field Summary

protected boolean	calledFromVerify
protected SystemPromptDialog	callerDialog
protected ISystemWizard	callerWizard
protected IBMiConnectionCombo	conn400Combo
static String	copyright
protected IHost	defaultConn
protected boolean	wantConnectionPrompt

Constructor Summary

QSYSFilterStringBaseEditPane(Shell shell)
Constructor

QSYSFilterStringBaseEditPane(Shell shell, ISystemWizard wizard)
Constructor when usage is for a wizard.

QSYSFilterStringBaseEditPane(Shell shell, SystemPromptDialog dialog)
Constructor when usage is for a dialog.

Method Summary

protected boolean	areFieldsComplete() Must be overridden if createContents is overridden.
protected boolean	areISeriesFieldsComplete() Override point for subclasses
protected void	connectionChanged(IHost connection) SubClasses that need to know when the connection changes (in those cases where there is a conn prompt at the top) should override this method.
Control	createContents(Composite parent) Method createContents.
Control	createISeriesContents(Composite parent) Method createISeriesContents.
protected void	doInitializeFields() Initialize the input fields.
protected void	doInitializeISeriesFields() Must be overridden.
protected void	doResetISeriesFields() Must be overridden.
IHost	getSystemConnection() Returns the System Connection selected from the Connection Combo
void	libraryNameChanged(SystemMessage errorMessage) The user has entered or selected text in the library entry field and it has been validated by the prompt combo
void	memberNameChanged(SystemMessage errorMessage) The user has entered or selected text in the member entry field and it has been validated by the ISeriesMemberPrompt.
void	objectNameChanged(SystemMessage errorMessage) The user has entered or selected text in the object entry field and it has been validated by the prompt combo.
void	processTest(Shell shell) Called by us or by owning dialog when common Test button is pressed
protected void	resetFields() Must not be overridden.
void	setCallerDialog(SystemPromptDialog dialog) Set the caller dialog.
void	setCallerWizard(ISystemWizard wizard) Set the caller wizard.
void	setChangeFilterMode(boolean changeMode) Intercept of parent so we can display our Test button only in change mode.
void	setShowConnectionPrompt(boolean show, IHost defaultConnection) Indicate you desire to include a prompt for a system connection in this edit pane.
SystemMessage	verify() Does complete verification of input fields.
protected Control	verifyISeries() Override point for subclasses.
void	widgetSelected(SelectionEvent event) User has selected something

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

callerWizard

protected ISystemWizard callerWizard

callerDialog

protected SystemPromptDialog callerDialog

conn400Combo

protected IBMiConnectionCombo conn400Combo

calledFromVerify

protected boolean calledFromVerify

wantConnectionPrompt

protected boolean wantConnectionPrompt

defaultConn

protected IHost defaultConn

Constructor Detail

QSYSFilterStringBaseEditPane

public QSYSFilterStringBaseEditPane(Shell shell)

Constructor

Parameters:

shell -

QSYSFilterStringBaseEditPane

public QSYSFilterStringBaseEditPane(Shell shell,
                                    ISystemWizard wizard)

Constructor when usage is for a wizard.

Parameters:

shell -

QSYSFilterStringBaseEditPane

public QSYSFilterStringBaseEditPane(Shell shell,
                                    SystemPromptDialog dialog)

Constructor when usage is for a dialog.

Parameters:

shell -

Method Detail

setCallerWizard

public void setCallerWizard(ISystemWizard wizard)

Set the caller wizard. This is unique to us as we sometimes need to resize the wizard when the user selects a More Types>> button, for example.

setCallerDialog

public void setCallerDialog(SystemPromptDialog dialog)

Set the caller dialog. This is unique to us as we sometimes need to resize the dialog when the user selects a More Types>> button, for example.

setShowConnectionPrompt

public void setShowConnectionPrompt(boolean show,
                                    IHost defaultConnection)

Indicate you desire to include a prompt for a system connection in this edit pane. Optionally pass a connection to default that prompt to.

doInitializeFields

protected void doInitializeFields()

Initialize the input fields. Does common stuff, then calls resetISeriesFields and then doInitializeISeriesFields

resetFields

protected void resetFields()

Must not be overridden. Reset the input fields. Does common stuff, then calls doResetISeriesFields

setChangeFilterMode

public void setChangeFilterMode(boolean changeMode)

Intercept of parent so we can display our Test button only in change mode.

Called by Change Filter dialog to set on our changeFilterMode flag in case we wish to distinguish between new filter and change filter modes

createContents

public Control createContents(Composite parent)

Method createContents.

Parameters:

parent -

Returns:

Control

createISeriesContents

public Control createISeriesContents(Composite parent)

Method createISeriesContents. Our default impl of createContents calls this.

Parameters:

parent -

Returns:

Control

doInitializeISeriesFields

protected void doInitializeISeriesFields()

Must be overridden. Called at initial creation time, and when input filter string changed. Always after calling resetISeriesFields

doResetISeriesFields

protected void doResetISeriesFields()

Must be overridden. This is called in the change filter dialog when the user selects "new", or selects another string. You must override this if you override createContents. Be sure to test if the contents have even been created yet!

areFieldsComplete

protected boolean areFieldsComplete()

Must be overridden if createContents is overridden.

This is called by the isComplete, to decide if the default information is complete enough to enable finish. It doesn't do validation, that will be done when finish is pressed.

We do common stuff and then defer to areISeriesFieldsComplete()

areISeriesFieldsComplete

protected boolean areISeriesFieldsComplete()

Override point for subclasses

verify

public SystemMessage verify()

Does complete verification of input fields. If this method returns null, there are no errors and the dialog or wizard can close;

Does common stuff and then defers to verifyISeries()

Returns:

error message if there is one, else null if ok

verifyISeries

protected Control verifyISeries()

Override point for subclasses. If you detect an error, you must set errorMessage (it is inited to null for you), and return the control in error.

libraryNameChanged

public void libraryNameChanged(SystemMessage errorMessage)

The user has entered or selected text in the library entry field and it has been validated by the prompt combo

Parameters:

errorMessage - Will be null if the input is valid, or a translated msg if not

objectNameChanged

public void objectNameChanged(SystemMessage errorMessage)

The user has entered or selected text in the object entry field and it has been validated by the prompt combo.

Parameters:

errorMessage - Will be null if the input is valid, or a translated msg if not

memberNameChanged

public void memberNameChanged(SystemMessage errorMessage)

The user has entered or selected text in the member entry field and it has been validated by the ISeriesMemberPrompt.

Parameters:

errorMessage - Will be null if the input is valid, or a translated msg if not

widgetSelected

public void widgetSelected(SelectionEvent event)

User has selected something

connectionChanged

protected void connectionChanged(IHost connection)

SubClasses that need to know when the connection changes (in those cases where there is a conn prompt at the top) should override this method.

processTest

public void processTest(Shell shell)

Called by us or by owning dialog when common Test button is pressed

getSystemConnection

public IHost getSystemConnection()

Returns the System Connection selected from the Connection Combo