Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.rse.ui.actions
Class QSYSSystemBaseAction

java.lang.Object
  extended by SystemBaseAction
      extended by com.ibm.etools.iseries.rse.ui.actions.QSYSSystemBaseAction
Direct Known Subclasses:
ISeriesDataTableViewHistoryAction, ISeriesDataTableViewNavigateAction, ISeriesDataTableViewRecordUpdateAction, ISeriesDataTableViewRefreshAction, ISeriesEditorRPGIndentViewPart.PrintAction, ISeriesShowCmdTableViewAction, ISeriesShowDataTableViewAction, ISeriesShowMbrTableViewAction, ISeriesShowObjTableViewAction, ISeriesTableViewGoAction, ISeriesTableViewHistoryAction, ISeriesTableViewLockAction, ISeriesTableViewPDMAction, ISeriesTableViewSelectAllAction, ISeriesTableViewShowAllAction, ISeriesTableViewShowColumnsAction, ISeriesTableViewShowPreferencesAction, ISeriesTableViewWorkWithAction, ISeriesVerifySourceAction, ObjTablePrintAction, ObjTableRefreshAction, QSYSAbstractLiblAction, QSYSChangeMessageDescriptionAction, QSYSChangeObjAction, QSYSChangePasswordAction, QSYSCompileModuleAction, QSYSCompileSingleProgramAction, QSYSCompileSingleServiceProgramAction, QSYSEditSrcPhysicalFileMemberAction, QSYSErrorListViewGoAction, QSYSErrorListViewInsertAllAction, QSYSErrorListViewInsertOpenAction, QSYSErrorListViewMessageLevelAction, QSYSErrorListViewRemoveAction, QSYSErrorListViewRemoveAddressedErrorsAction, QSYSErrorListViewRemoveOldErrorsAction, QSYSErrorListViewSeverityLevelAction, QSYSNewMessageDescriptionAction, QSYSOpenMbrWithLocalAction, QSYSOpenMemberAction, QSYSRunRemoteCommandAction, QSYSRunRemoteCommandOnSubsystemAction, QSYSSaveRestoreAction, QSYSShowEventsFileAction, QSYSShowMessageLogAction, QSYSUploadConflictAction, QSYSVerifyConnectionAction, RSECreateISeriesProjectAction, RSEMakeOfflineAction, SearchResultViewPDMAction, ShowFldTableViewAction

public abstract class QSYSSystemBaseAction
extends SystemBaseAction

Base action class for IBM i actions. This adds support to disable the action if user has chosen to work offline. It also adds a couple helper methods for IBMiConnections


Field Summary
static String copyright
           
 
Constructor Summary
QSYSSystemBaseAction(String text, ImageDescriptor image, Shell parent)
          Constructor for ISeriesSystemBaseAction when translated label is known.
QSYSSystemBaseAction(String text, Shell parent)
          Used for actions with no image icon.
QSYSSystemBaseAction(String text, String tooltip, ImageDescriptor image, Shell parent)
          Constructor for ISeriesSystemBaseAction when translated label and tooltip are known.
QSYSSystemBaseAction(String text, String tooltip, Shell parent)
          Used for actions with no image icon.
QSYSSystemBaseAction(String text, String tooltip, String description, ImageDescriptor image, Shell parent)
          Constructor for ISeriesSystemBaseAction when translated label and tooltip and description are all known.
QSYSSystemBaseAction(String text, String tooltip, String description, Shell parent)
          Used for actions with no image icon.
 
Method Summary
 IBMiConnection getIBMiConnection(Object element)
          Returns the ISeriesConnection from which this object originated
 void isAvailableOffline(boolean availableOffline)
          If this is one of those rare actions that is to be made available in offline mode, then call this in during or immediately after constructing to state that.
 boolean updateSelection(IStructuredSelection selection)
           
 
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

QSYSSystemBaseAction

public QSYSSystemBaseAction(String text,
                            ImageDescriptor image,
                            Shell parent)
Constructor for ISeriesSystemBaseAction when translated label is known. You must separately call setToolTipText and setDescription to enable these if desired.

Parameters:
text - string to display in menu or toolbar
image - icon to display in menu or toolbar. Can be null.
parent - Shell of parent window. Can be null if you don't know it, but call setShell when you do.

QSYSSystemBaseAction

public QSYSSystemBaseAction(String text,
                            String tooltip,
                            ImageDescriptor image,
                            Shell parent)
Constructor for ISeriesSystemBaseAction when translated label and tooltip are known. You must separately call setDescription to enable this if desired.

Parameters:
text - string to display in menu or toolbar
tooltip - string to display when user hovers mouse over action.
image - icon to display in menu or toolbar. Can be null.
parent - Shell of parent window. Can be null if you don't know it, but call setShell when you do.

QSYSSystemBaseAction

public QSYSSystemBaseAction(String text,
                            String tooltip,
                            String description,
                            ImageDescriptor image,
                            Shell parent)
Constructor for ISeriesSystemBaseAction when translated label and tooltip and description are all known.

Parameters:
text - string to display in menu or toolbar
tooltip - string to display when user hovers mouse over action.
description - string displayed in status bar of some displays. Longer than tooltip.
image - icon to display in menu or toolbar. Can be null.
parent - Shell of parent window. Can be null if you don't know it, but call setShell when you do.

QSYSSystemBaseAction

public QSYSSystemBaseAction(String text,
                            Shell parent)
Used for actions with no image icon. Constructor for ISeriesSystemBaseAction when translated label is known. You must separately call setToolTipText and setDescription to enable these if desired.

Parameters:
text - string to display in menu or toolbar
parent - Shell of parent window. Can be null if you don't know it, but call setShell when you do.

QSYSSystemBaseAction

public QSYSSystemBaseAction(String text,
                            String tooltip,
                            Shell parent)
Used for actions with no image icon. Constructor for ISeriesSystemBaseAction when translated label and tooltip are known. You must separately call setDescription to enable this if desired.

Parameters:
text - string to display in menu or toolbar
tooltip - string to display when user hovers mouse over action.
parent - Shell of parent window. Can be null if you don't know it, but call setShell when you do.

QSYSSystemBaseAction

public QSYSSystemBaseAction(String text,
                            String tooltip,
                            String description,
                            Shell parent)
Used for actions with no image icon. Constructor for ISeriesSystemBaseAction when translated label and tooltip and description are all known.

Parameters:
text - string to display in menu or toolbar
tooltip - string to display when user hovers mouse over action.
description - string displayed in status bar of some displays. Longer than tooltip.
parent - Shell of parent window. Can be null if you don't know it, but call setShell when you do.
Method Detail

isAvailableOffline

public void isAvailableOffline(boolean availableOffline)
If this is one of those rare actions that is to be made available in offline mode, then call this in during or immediately after constructing to state that.


updateSelection

public boolean updateSelection(IStructuredSelection selection)

getIBMiConnection

public IBMiConnection getIBMiConnection(Object element)
Returns the ISeriesConnection from which this object originated


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.