Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.rse.ui.compile
Class IBMiCompileCommandEditPane

java.lang.Object
  extended by SystemCompileCommandEditPane
      extended by com.ibm.etools.iseries.rse.ui.compile.IBMiCompileCommandEditPane

public class IBMiCompileCommandEditPane
extends SystemCompileCommandEditPane

Refinement of the Compile Command edit pane for ISeries native member compile support. This edit pane is used in the Work With Compile Commands dialog.


Field Summary
static String Copyright
           
 
Constructor Summary
IBMiCompileCommandEditPane(SystemCompileManager compileManager, Shell shell, ISystemCompileCommandEditPaneHoster owningDialog, boolean caseSensitive)
          Constructor for ISeriesCompileCommandEditPane.
IBMiCompileCommandEditPane(SystemCompileManager compileManager, Shell shell, ISystemCompileCommandEditPaneHoster owningDialog, boolean caseSensitive, boolean ifsMode)
          Constructor for ISeriesCompileCommandEditPane for ifs mode.
 
Method Summary
 boolean createCommandLabelLineControls(Composite parent, int availableColumns)
          Overridable entry point for subclasses that wish to put something to the right of the "Command:" label.
 boolean createExtraButtons(Composite parent, int availableColumns)
          Overridden from parent Method createButtons.
protected  SystemMessage doAdditionalValidation(boolean doSetFocus)
          Overridable extension point for subclasses to do validation of options and such when Apply is pressed.
 void enableExtraButtons()
          Enable/disable our extra buttons
protected  SystemCommandViewerConfiguration getCommandTextViewerConfiguration()
          For child classes to return their own subclasses of the default configurator used to enable proposal support in the command entry field.
 void handleEvent(Event e)
          handles event when button pressed
protected  String preSaveMassage(String commandString)
          Opportunity for subclasses to perform any additional massaging of the user-entered command string, just prior to saving it.
protected  void processCommandTextChange(String newText, boolean hasError)
          Method called as user types into the command field.
protected  void processExtraButtonsChanges(SystemCompileCommand currentCmd)
          Overridable method for saving data in subclass-supplied additional GUI.
protected  void resetExtraButtons(SystemCompileCommand originalCmd)
          Overridable method for resetting GUI in subclass-supplied additional GUI, when in "edit" mode
protected  void resetExtraButtonsForNewMode()
          Overridable method for resetting GUI in subclass-supplied additional GUI, when in "new" mode
protected  void setCommandType(boolean qsys)
          Flip between QSYS and QSHELL command types
 
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
Constructor Detail

IBMiCompileCommandEditPane

public IBMiCompileCommandEditPane(SystemCompileManager compileManager,
                                  Shell shell,
                                  ISystemCompileCommandEditPaneHoster owningDialog,
                                  boolean caseSensitive,
                                  boolean ifsMode)
Constructor for ISeriesCompileCommandEditPane for ifs mode.


IBMiCompileCommandEditPane

public IBMiCompileCommandEditPane(SystemCompileManager compileManager,
                                  Shell shell,
                                  ISystemCompileCommandEditPaneHoster owningDialog,
                                  boolean caseSensitive)
Constructor for ISeriesCompileCommandEditPane.

Method Detail

processCommandTextChange

protected void processCommandTextChange(String newText,
                                        boolean hasError)
Method called as user types into the command field. An override of our parent method


preSaveMassage

protected String preSaveMassage(String commandString)
Opportunity for subclasses to perform any additional massaging of the user-entered command string, just prior to saving it.

We use this opportunity to test if the command is an ibm-supplied cmd, and if so fill it with any missing parameters.


handleEvent

public void handleEvent(Event e)
handles event when button pressed

See Also:
Listener

setCommandType

protected void setCommandType(boolean qsys)
Flip between QSYS and QSHELL command types


getCommandTextViewerConfiguration

protected SystemCommandViewerConfiguration getCommandTextViewerConfiguration()
For child classes to return their own subclasses of the default configurator used to enable proposal support in the command entry field.


createCommandLabelLineControls

public boolean createCommandLabelLineControls(Composite parent,
                                              int availableColumns)
Overridable entry point for subclasses that wish to put something to the right of the "Command:" label. We don't actually do anything because we don't need to prompt for batch vs interactive vs normal for compile.

Returns:
true if something entered to take up the available columns, false otherwise (will be padded)

createExtraButtons

public boolean createExtraButtons(Composite parent,
                                  int availableColumns)
Overridden from parent Method createButtons. - Creates custom buttons for edit pane in UDA

Parameters:
parent - - composite to put the extra buttons in
Returns:
true if something entered to take up the available columns, false otherwise (will be padded)

enableExtraButtons

public void enableExtraButtons()
Enable/disable our extra buttons


resetExtraButtonsForNewMode

protected void resetExtraButtonsForNewMode()
Overridable method for resetting GUI in subclass-supplied additional GUI, when in "new" mode


resetExtraButtons

protected void resetExtraButtons(SystemCompileCommand originalCmd)
Overridable method for resetting GUI in subclass-supplied additional GUI, when in "edit" mode


processExtraButtonsChanges

protected void processExtraButtonsChanges(SystemCompileCommand currentCmd)
Overridable method for saving data in subclass-supplied additional GUI.


doAdditionalValidation

protected SystemMessage doAdditionalValidation(boolean doSetFocus)
Overridable extension point for subclasses to do validation of options and such when Apply is pressed. If you do report an error, consider setting the focus to the appropriate widget, if setFocus is set.

Returns:
error message if an error detected, else null

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.