Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.rse.ui.wizard.cmds
Class AbstractNewQSYSObjectWizardAdvPage

java.lang.Object
  extended by AbstractSystemWizardPage
      extended by com.ibm.etools.iseries.rse.ui.wizard.cmds.AbstractNewQSYSObjectWizardAdvPage
All Implemented Interfaces:
QSYSAUTLPromptListener
Direct Known Subclasses:
NewQSYSDataAreaWizardAdvPage, NewQSYSDataQWizardAdvPage, NewQSYSLibraryWizardAdvPage, NewQSYSMsgFileWizardAdvPage, NewQSYSSourceFileWizardAdvPage

public abstract class AbstractNewQSYSObjectWizardAdvPage
extends AbstractSystemWizardPage
implements QSYSAUTLPromptListener

Abstract base class for the Second page of the wizards for creating various types of new iSeries objects. This is the resulting of noticing much redundancy across these wizards.


Field Summary
protected  QSYSAUTLPrompt autCombo
           
static String CMDDFT
           
static String[] CMDDFT_ARRAY
           
protected  String cmdStringDelta
           
protected  Label commandSoFar
           
protected  String commandString
           
protected  IHost connection
           
static String copyright
           
protected  SystemMessage errorMessage
           
protected  String inpAut
           
protected  String newAut
           
static String NO
           
protected  Label previousFillerLabel
           
protected  Label previousLabel
           
static String YES
           
static String[] YESNO_ARRAY
           
 
Constructor Summary
AbstractNewQSYSObjectWizardAdvPage(Wizard wizard, IHost connection, String pageID, String title, String description, String helpID)
          Constructor.
 
Method Summary
 void authorizationNameChanged(SystemMessage error)
          From IISeriesAUTLPromptListener.
protected  String buildCommandString()
          Build up the full iSeries command from current contents...
protected abstract  String buildCommandStringDelta()
          For child subclasses.
protected  String buildOurCommandStringDelta()
          Build up the iSeries command delta for this page's contributions, from current contents...
 void ccsidChanged(SystemMessage error)
          From IISeriesCCSIDPromptListener.
 Control createContents(Composite parent)
          CreateContents is the one method that must be overridden from the parent class.
protected  Combo createYesNoCombo(Composite composite_prompts, int nbrColumns, String label, String tooltip)
          Create a readonly combo with only *CMDDFT, *YES and *NO options.
 String getAuthority()
          Get Authority parameter value
 String getCommandString()
          Return the command string to execute remotely
protected  String getCommandStringDelta()
          Get the command string delta this page appends to that of the first page
protected  Control getInitialFocusControl()
          Return the Control to be given initial focus.
protected  AbstractNewQSYSObjectWizard getOurWizard()
          Return the parent wizard
 void handleEvent(Event e)
          Handles events generated by controls on this page.
protected abstract  boolean internalIsPageComplete()
          Do page completion testing beyond what the base class does.
 boolean isPageComplete()
          Return true if the page is complete, so to enable Finish.
 boolean performFinish()
          Completes processing of the wizard.
protected abstract  Control performFinishValidation()
          Do validation beyond what the base class does, when Finish is pressed.
protected abstract  void populateControls(Composite composite_prompts, int nbrColumns)
          Populate the content area with additional controls beyond what the parent supplies...
protected abstract  void prepareControls()
          Pre-fill any child-class-unique controls with passed-in data, and set any keystroke listeners...
 void setAuthority(String aut)
          Set Authority parameter value
 void setConnection(IHost connection)
          Set the connection.
 void setVisible(boolean visible)
          Override of parent so we can update the command-so-far to show what was changed on the second page
protected abstract  void sizeControls(Composite composite_prompts, int nbrColumns)
          Adjust the size of any child-class-unique controls...
 void widgetDefaultSelected(SelectionEvent event)
          From SelectionListener.
 void widgetSelected(SelectionEvent event)
          From SelectionListener.
 
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

autCombo

protected QSYSAUTLPrompt autCombo

commandSoFar

protected Label commandSoFar

previousLabel

protected Label previousLabel

previousFillerLabel

protected Label previousFillerLabel

connection

protected IHost connection

errorMessage

protected SystemMessage errorMessage

inpAut

protected String inpAut

newAut

protected String newAut

commandString

protected String commandString

cmdStringDelta

protected String cmdStringDelta

CMDDFT

public static final String CMDDFT
See Also:
Constant Field Values

CMDDFT_ARRAY

public static final String[] CMDDFT_ARRAY

YES

public static final String YES
See Also:
Constant Field Values

NO

public static final String NO
See Also:
Constant Field Values

YESNO_ARRAY

public static final String[] YESNO_ARRAY
Constructor Detail

AbstractNewQSYSObjectWizardAdvPage

public AbstractNewQSYSObjectWizardAdvPage(Wizard wizard,
                                          IHost connection,
                                          String pageID,
                                          String title,
                                          String description,
                                          String helpID)
Constructor.

Method Detail

getOurWizard

protected AbstractNewQSYSObjectWizard getOurWizard()
Return the parent wizard


setConnection

public void setConnection(IHost connection)
Set the connection. This can be called later if null is passed in the constructor


setAuthority

public void setAuthority(String aut)
Set Authority parameter value


createContents

public Control createContents(Composite parent)
CreateContents is the one method that must be overridden from the parent class. In this method, we populate an SWT container with widgets and return the container to the caller (JFace). This is used as the contents of this page.


getInitialFocusControl

protected Control getInitialFocusControl()
Return the Control to be given initial focus. Override from parent. Return control to be given initial focus.


handleEvent

public void handleEvent(Event e)
Handles events generated by controls on this page. Overridden from parent.


widgetSelected

public void widgetSelected(SelectionEvent event)
From SelectionListener. Called when widget selected


widgetDefaultSelected

public void widgetDefaultSelected(SelectionEvent event)
From SelectionListener. Called when widget selected via Enter


buildCommandString

protected String buildCommandString()
Build up the full iSeries command from current contents...


buildOurCommandStringDelta

protected String buildOurCommandStringDelta()
Build up the iSeries command delta for this page's contributions, from current contents...


authorizationNameChanged

public void authorizationNameChanged(SystemMessage error)
From IISeriesAUTLPromptListener. Called as user types an authorizationlist name. Given string is error message.

Specified by:
authorizationNameChanged in interface QSYSAUTLPromptListener
Parameters:
error - Will be null if the input is valid, or a translated msg if not

ccsidChanged

public void ccsidChanged(SystemMessage error)
From IISeriesCCSIDPromptListener. Called as user types an CCSID value. Given string is error message.


performFinish

public boolean performFinish()
Completes processing of the wizard. If this method returns true, the wizard will close; otherwise, it will stay active. This method is an override from the parent Wizard class.

Returns:
whether the wizard finished successfully

isPageComplete

public boolean isPageComplete()
Return true if the page is complete, so to enable Finish. Called by wizard framework.


setVisible

public void setVisible(boolean visible)
Override of parent so we can update the command-so-far to show what was changed on the second page


getCommandString

public String getCommandString()
Return the command string to execute remotely


getAuthority

public String getAuthority()
Get Authority parameter value


getCommandStringDelta

protected String getCommandStringDelta()
Get the command string delta this page appends to that of the first page


createYesNoCombo

protected Combo createYesNoCombo(Composite composite_prompts,
                                 int nbrColumns,
                                 String label,
                                 String tooltip)
Create a readonly combo with only *CMDDFT, *YES and *NO options. The label widget, if you need it, is set to previousLabel. It is overridden for each call to this. The filler label widget, if you need it and it exists, is set to previousFillerLabel. It is overridden for each call to this.


populateControls

protected abstract void populateControls(Composite composite_prompts,
                                         int nbrColumns)
Populate the content area with additional controls beyond what the parent supplies...


prepareControls

protected abstract void prepareControls()
Pre-fill any child-class-unique controls with passed-in data, and set any keystroke listeners...


sizeControls

protected abstract void sizeControls(Composite composite_prompts,
                                     int nbrColumns)
Adjust the size of any child-class-unique controls...


buildCommandStringDelta

protected abstract String buildCommandStringDelta()
For child subclasses. Build the command string for the additional parameters not handled by the base class.


performFinishValidation

protected abstract Control performFinishValidation()
Do validation beyond what the base class does, when Finish is pressed. Return the control to set focus to if any error is found. Also, set the errorMessage instance variable if an error is found. Further, set any newXXX instance variables you want to access via getXXX methods after successful finish.


internalIsPageComplete

protected abstract boolean internalIsPageComplete()
Do page completion testing beyond what the base class does. Return true if it is ok to enable Finish.


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.