Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.rse.ui.uda
Class QSYSUDActionEditPane

java.lang.Object
  extended by SystemUDActionEditPane
      extended by com.ibm.etools.iseries.rse.ui.uda.QSYSUDActionEditPane

public class QSYSUDActionEditPane
extends SystemUDActionEditPane

Subclass of generic action edit pane, specialized for iSeries NFS user actions.


Field Summary
static String copyright
           
 
Constructor Summary
QSYSUDActionEditPane(QSYSUDActionSubsystem udaActionSubsys, ISystemUDAEditPaneHoster parent, ISystemUDTreeView tv)
          Constructor.
 
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  Control[] createExtraOptionCheckBoxes(Composite parent)
          Create additional option checkboxes, to go under default options.
protected  SystemMessage doAdditionalValidation(boolean doSetFocus)
          Overridable extension point for subclasses to do validation of options and such when Apply is pressed.
 void enableExtraButtons(boolean b)
          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.
protected  String getInvokeOnceRBKey()
          Return the root key for the "Invoke once" option, with which we will retrieve the label and tooltip.
 void handleEvent(Event e)
          handles event when button pressed
protected  void processCommandTextChange(String newText, boolean hasError)
          Method called as user types into the command field.
protected  void processExtraOptionsChanges(SystemUDActionElement currentAction)
          Overridable method for saving data in subclass-supplied additional options
protected  void resetExtraOptions(SystemUDActionElement originalAction)
          Overridable method for resetting data in subclass-supplied additional options
protected  void resetExtraOptionsForNewMode()
          Overridable method for resetting options in subclass-supplied additional options, when in "new" mode
 
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

QSYSUDActionEditPane

public QSYSUDActionEditPane(QSYSUDActionSubsystem udaActionSubsys,
                            ISystemUDAEditPaneHoster parent,
                            ISystemUDTreeView tv)
Constructor.

Method Detail

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.


getInvokeOnceRBKey

protected String getInvokeOnceRBKey()
Return the root key for the "Invoke once" option, with which we will retrieve the label and tooltip. Overridable in case a different label or tooltip is desired


processCommandTextChange

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


handleEvent

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

See Also:
Listener

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 add a drop-down where the user can select from "Normal", "Batch" and "Interactive" commands.

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)

createExtraOptionCheckBoxes

protected Control[] createExtraOptionCheckBoxes(Composite parent)
Create additional option checkboxes, to go under default options. Overridden from parent.

Parameters:
parent - - the options composite to place checkboxes in
Returns:
An array of the checkboxes created

enableExtraButtons

public void enableExtraButtons(boolean b)
Enable/disable our extra buttons


processExtraOptionsChanges

protected void processExtraOptionsChanges(SystemUDActionElement currentAction)
Overridable method for saving data in subclass-supplied additional options


resetExtraOptions

protected void resetExtraOptions(SystemUDActionElement originalAction)
Overridable method for resetting data in subclass-supplied additional options


resetExtraOptionsForNewMode

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


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.