Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.remotebuild.actions
Class RBAction

java.lang.Object
  extended by Action
      extended by com.ibm.etools.iseries.remotebuild.actions.RBAction
Direct Known Subclasses:
ResourceAction, SaveEditorsAction

public abstract class RBAction
extends Action


Constructor Summary
RBAction()
           
 
Method Summary
 IRunnableContext getRunnableContext()
           
 Shell getShell()
           
 RBStatus getStatus()
           
 boolean isCanceled()
           
 void setCanceled(boolean b)
           
 void setRunnableContext(IRunnableContext context)
           
 void setShell(Shell shell)
           
 void setStatus(RBStatus status)
          Sets the status of the operation.
protected  void showStatusMessage(RBStatus status)
          Shows a status message in a dialog box.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RBAction

public RBAction()
Method Detail

isCanceled

public final boolean isCanceled()
Returns:
a boolean indicating that the action has been canceled while it was running. If the action has not been run, this is false.

getStatus

public final RBStatus getStatus()
Returns:
the status of this action. This will be RBStatus.OK if the action has not yet been run.

setCanceled

public final void setCanceled(boolean b)
Parameters:
b - the boolean that indicates that this operation has been canceled.

setStatus

public final void setStatus(RBStatus status)
Sets the status of the operation.

Parameters:
status - the status of this operation.

getShell

public final Shell getShell()
Returns:
the shell that can act as a parent shell for any dialogs that this action requires. Will return null if the shell has not previously been set and no workbench windows are active.

setShell

public final void setShell(Shell shell)
Parameters:
shell - the shell that can act as a parent shell for any dialogs.

showStatusMessage

protected final void showStatusMessage(RBStatus status)
Shows a status message in a dialog box. If the dialog is canceled this action will also be canceled.

Parameters:
status - the RBStatus to show.

getRunnableContext

public IRunnableContext getRunnableContext()
Returns:
the IRunnableContext for this action. If it has not been set, but a shell exists, it will return a ProgressMonitorDialog with that shell as a parent. If the shell is null, the ProgressMonitorDialog will be a root window.

setRunnableContext

public void setRunnableContext(IRunnableContext context)
Parameters:
monitor - the progress monitor to be used for this action.

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.