Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.rse.ui
Class IBMiWidgetHelpers

java.lang.Object
  extended by com.ibm.etools.iseries.rse.ui.IBMiWidgetHelpers
All Implemented Interfaces:
IIBMiHistoryKeys

public class IBMiWidgetHelpers
extends Object
implements IIBMiHistoryKeys

Static methods that can be used when writing SWT GUI code for iSeries. They simply make it more productive.


Field Summary
static String[] ALL_OBJTYPES
           
static String copyright
           
static String[] crtCmds
           
static String[][] KNOWN_OBJATTRS_BYTYPE
          List of object attributes by object type.
static String[] KNOWN_OBJATTRS_TYPES
           
static String[] mbrTypes
           
static String[] mbrTypesPlusAsterisk
           
static String[] objAttrs
           
static String[] OBJATTRS_FILE
           
static String[] OBJATTRS_FNTSRC
           
static String[] OBJATTRS_LIB
           
static String[] OBJATTRS_MENU
           
static String[] OBJATTRS_MODULE
           
static String[] OBJATTRS_PGM
           
static String[] OBJATTRS_SRVPGM
           
static String[] objTypes
           
static String[] objTypesMinusAsterisk
           
static String[] specialCmds
           
static String[] specialFiles
           
static String[] specialLibs
           
static String[] specialLibsNonGeneric
           
static String[] specialLibsNonGenericNonLibl
           
static String[] specialMbrs
           
static String[] specialObjs
           
 
Fields inherited from interface com.ibm.etools.iseries.rse.ui.IIBMiHistoryKeys
ATTR_OBJ, Copyright, GENERIC_ATTR_OBJ, GENERIC_NAME_CMD, GENERIC_NAME_DTAARA, GENERIC_NAME_DTAQ, GENERIC_NAME_FILE, GENERIC_NAME_FILE_DSPF, GENERIC_NAME_FILE_DSPF_PRTF, GENERIC_NAME_FILE_DTA, GENERIC_NAME_FILE_PRTF, GENERIC_NAME_FILE_SRC, GENERIC_NAME_FILE_SRC_DTA, GENERIC_NAME_FLD, GENERIC_NAME_JOBD, GENERIC_NAME_LIB, GENERIC_NAME_LIB_NOLIBL, GENERIC_NAME_MBR, GENERIC_NAME_MODULE, GENERIC_NAME_MSGF, GENERIC_NAME_OBJ, GENERIC_NAME_PGM, GENERIC_NAME_PGM_SRVPGM, GENERIC_NAME_RCD, GENERIC_NAME_SRVPGM, GENERIC_PREFIX, GENERIC_TYPE_MBR, GENERIC_TYPE_OBJ, HISTORY_PREFIX, JOB_CURR_USERID, JOB_NAME, JOB_NUMBER, JOB_SUBSYSTEM, JOB_USER, KEY_NAME, NAME_ASPDEV, NAME_AUTL, NAME_AUTL_AUT, NAME_AUTL_CRTAUT, NAME_CMD, NAME_DTAARA, NAME_DTAQ, NAME_FILE, NAME_FILE_DSPF, NAME_FILE_DSPF_PRTF, NAME_FILE_DTA, NAME_FILE_PRTF, NAME_FILE_SRC, NAME_FILE_SRC_DTA, NAME_FLD, NAME_JOBD, NAME_LIB, NAME_LIB_NOCURLIB, NAME_LIB_NOLIBL, NAME_MBR, NAME_MODULE, NAME_MSGF, NAME_OBJ, NAME_PGM, NAME_PGM_SRVPGM, NAME_RCD, NAME_SRVPGM, RELEASE_JOB_COMMAND, SAVF_LIB_HISTORY_KEY, SAVF_OBJ_HISTORY_KEY, SAVF_RSTLIB_HISTORY_KEY, SAVF_SAVELIB_HISTORY_KEY, SPLF_FILE, SPLF_USER, STRING_FIND, TYPE_MBR, TYPE_OBJ
 
Constructor Summary
IBMiWidgetHelpers()
           
 
Method Summary
static boolean AttrsKnownForThisType(String objType)
          Given an iSeries object type, returns true if that type is one for which a definitive list of object attributes are known.
static Combo createFieldCombo(Composite parent, Listener listener)
          Creates an iSeries Field combox box.
static Combo createIFSPathCombo(Composite parent, Listener listener)
          Creates an iSeries IFS path combox box.
static Combo createLibraryCombo(Composite parent, Listener listener)
          Creates an iSeries Library combox box.
static SystemHistoryCombo createLibraryHistoryCombo(Composite parent, SelectionListener listener, boolean allowGeneric)
          Creates an iSeries Library combox box that has a history.
static Combo createMbrCombo(Composite parent, Listener listener)
          Creates an iSeries Member combo box.
static Combo createMbrTypeCombo(Composite parent, Listener listener)
          Creates an iSeries Member Type combo box.
static List createMbrTypeList(Composite parent, Listener listener, String label, int columnSpan)
          Creates an iSeries Member Type list box.
static Combo createObjAttrCombo(Composite parent, Listener listener)
          Creates an iSeries Object Attribute combox box.
static List createObjAttrList(Composite parent, Listener listener, String label, int columnSpan)
          Creates an iSeries Object Attribute list box.
static List createObjAttrList(Composite parent, Listener listener, String label, int columnSpan, String objType)
          Creates an iSeries Object Attribute list box, populated with the attributes for the given type.
static Combo createObjCombo(Composite parent, Listener listener)
          Creates an iSeries Object combox box.
static SystemHistoryCombo createObjectHistoryCombo(Composite parent, SelectionListener listener, boolean allowGeneric)
          Creates an iSeries Object combox box that has a history.
static Combo createObjTypeCombo(Composite parent, Listener listener)
          Creates an iSeries Object Type combox box.
static List createObjTypeList(Composite parent, Listener listener, String label, int columnSpan)
          Creates an iSeries Object Type list box.
static Combo createRecordCombo(Composite parent, Listener listener)
          Creates an iSeries Record combox box.
static String[] getCrtCommandFilterStrings()
          Return CRT command string This is just a bunch of command name filters like CRT*
static String[] getMbrTypes()
          Return known member types
static String[] getSpecialCommandFilterStrings()
          Return array of special command filter strings.
static String[] getSpecialFileFilterStrings()
          Return array of special file filter strings: *LIBL/* OBJTYPE(*FILE) *LIBL/* OBJTYPE(*FILE) OBJATTR(PF-SRC) *LIBL/* OBJTYPE(*FILE) OBJATTR(PF-DTA)
static String[] getSpecialLibraryFilterStrings()
          Return array of special library filter strings: *LIBL *USRLIBL *CURLIB *ALLLIB *ALL
static String[] getSpecialMemberFilterStrings()
          Return array of special member filter strings: *CURLIB/Q*SRC(*) MBRTYPE(*) *CURLIB/Q*SRC(*) MBRTYPE(RPG*) *CURLIB/Q*SRC(*) MBRTYPE(CBL*) *CURLIB/Q*SRC(*) MBRTYPE(CL*) *CURLIB/Q*SRC(*) MBRTYPE(DSPF PRTF PF LF)
static String[] getSpecialObjectFilterStrings()
          Return array of special object filter strings: *CURLIB/* *CURLIB/* OBJTYPE(*FILE) *CURLIB/* OBJTYPE(*FILE) OBJATTR(PF-SRC) *CURLIB/* OBJTYPE(*PGM)
static IBMiCommandsLogViewPart showIBMiCommandsLogView()
          Show the iSeries Commands Log view
static IBMiCommandsLogViewPart showIBMiCommandsLogView(boolean toTop, ISubSystem subsystem)
          Show the iSeries Commands Log view (optionally bring view to top)
 
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

specialLibsNonGenericNonLibl

public static final String[] specialLibsNonGenericNonLibl

specialLibsNonGeneric

public static final String[] specialLibsNonGeneric

specialLibs

public static final String[] specialLibs

specialObjs

public static final String[] specialObjs

specialFiles

public static final String[] specialFiles

specialMbrs

public static final String[] specialMbrs

specialCmds

public static final String[] specialCmds

crtCmds

public static final String[] crtCmds

mbrTypes

public static final String[] mbrTypes

mbrTypesPlusAsterisk

public static final String[] mbrTypesPlusAsterisk

objTypes

public static final String[] objTypes

objTypesMinusAsterisk

public static final String[] objTypesMinusAsterisk

ALL_OBJTYPES

public static final String[] ALL_OBJTYPES

objAttrs

public static final String[] objAttrs

OBJATTRS_FILE

public static final String[] OBJATTRS_FILE

OBJATTRS_FNTSRC

public static final String[] OBJATTRS_FNTSRC

OBJATTRS_LIB

public static final String[] OBJATTRS_LIB

OBJATTRS_MENU

public static final String[] OBJATTRS_MENU

OBJATTRS_MODULE

public static final String[] OBJATTRS_MODULE

OBJATTRS_PGM

public static final String[] OBJATTRS_PGM

OBJATTRS_SRVPGM

public static final String[] OBJATTRS_SRVPGM

KNOWN_OBJATTRS_TYPES

public static final String[] KNOWN_OBJATTRS_TYPES

KNOWN_OBJATTRS_BYTYPE

public static final String[][] KNOWN_OBJATTRS_BYTYPE
List of object attributes by object type. The objects we recognize are in KNOWN_OBJATTRS_TYPES

Constructor Detail

IBMiWidgetHelpers

public IBMiWidgetHelpers()
Method Detail

getSpecialLibraryFilterStrings

public static String[] getSpecialLibraryFilterStrings()
Return array of special library filter strings:


getSpecialObjectFilterStrings

public static String[] getSpecialObjectFilterStrings()
Return array of special object filter strings:


getSpecialFileFilterStrings

public static String[] getSpecialFileFilterStrings()
Return array of special file filter strings:


getSpecialMemberFilterStrings

public static String[] getSpecialMemberFilterStrings()
Return array of special member filter strings:


getSpecialCommandFilterStrings

public static String[] getSpecialCommandFilterStrings()
Return array of special command filter strings. This is just a bunch of command name filters like DSP*, CHG*, CRT*, DLT*, WRK*


getCrtCommandFilterStrings

public static String[] getCrtCommandFilterStrings()
Return CRT command string This is just a bunch of command name filters like CRT*


createLibraryCombo

public static Combo createLibraryCombo(Composite parent,
                                       Listener listener)
Creates an iSeries Library combox box. Does NOT create the leading prompt or anything except the combo.


createLibraryHistoryCombo

public static SystemHistoryCombo createLibraryHistoryCombo(Composite parent,
                                                           SelectionListener listener,
                                                           boolean allowGeneric)
Creates an iSeries Library combox box that has a history. Does NOT create the leading prompt or anything except the combo.


createObjCombo

public static Combo createObjCombo(Composite parent,
                                   Listener listener)
Creates an iSeries Object combox box. Does NOT create the leading prompt or anything except the combo.


createObjectHistoryCombo

public static SystemHistoryCombo createObjectHistoryCombo(Composite parent,
                                                          SelectionListener listener,
                                                          boolean allowGeneric)
Creates an iSeries Object combox box that has a history. Does NOT create the leading prompt or anything except the combo.


createObjTypeCombo

public static Combo createObjTypeCombo(Composite parent,
                                       Listener listener)
Creates an iSeries Object Type combox box. Does NOT create the leading prompt or anything except the combo.


createObjTypeList

public static List createObjTypeList(Composite parent,
                                     Listener listener,
                                     String label,
                                     int columnSpan)
Creates an iSeries Object Type list box. Does create the heading optionally (you can pass null for this)

Parameters:
parent - Hosting composite
listener - Listener to get events. Can be null.
label - Heading label. Can be null.
columnSpan - How many columns should the list and heading span

createObjAttrCombo

public static Combo createObjAttrCombo(Composite parent,
                                       Listener listener)
Creates an iSeries Object Attribute combox box. Does NOT create the leading prompt or anything except the combo.


createObjAttrList

public static List createObjAttrList(Composite parent,
                                     Listener listener,
                                     String label,
                                     int columnSpan)
Creates an iSeries Object Attribute list box. Does create the heading optionally (you can pass null for this)

Parameters:
parent - Hosting composite
listener - Listener to get events. Can be null.
label - Heading label. Can be null.
columnSpan - How many columns should the list and heading span

createObjAttrList

public static List createObjAttrList(Composite parent,
                                     Listener listener,
                                     String label,
                                     int columnSpan,
                                     String objType)
Creates an iSeries Object Attribute list box, populated with the attributes for the given type. The type will only affect the list contents if it is non-null and it is a type for which we know definitively the list of attributes. Does create the heading optionally (you can pass null for this)

Parameters:
parent - Hosting composite
listener - Listener to get events. Can be null.
label - Heading label. Can be null.
columnSpan - How many columns should the list and heading span

AttrsKnownForThisType

public static boolean AttrsKnownForThisType(String objType)
Given an iSeries object type, returns true if that type is one for which a definitive list of object attributes are known.


createMbrCombo

public static Combo createMbrCombo(Composite parent,
                                   Listener listener)
Creates an iSeries Member combo box. Does NOT create the leading prompt or anything except the combo.


getMbrTypes

public static String[] getMbrTypes()
Return known member types


createMbrTypeCombo

public static Combo createMbrTypeCombo(Composite parent,
                                       Listener listener)
Creates an iSeries Member Type combo box. Does NOT create the leading prompt or anything except the combo.


createMbrTypeList

public static List createMbrTypeList(Composite parent,
                                     Listener listener,
                                     String label,
                                     int columnSpan)
Creates an iSeries Member Type list box. Does create the heading optionally (you can pass null for this)

Parameters:
parent - Hosting composite
listener - Listener to get events. Can be null.
label - Heading label. Can be null.
columnSpan - How many columns should the list and heading span

createRecordCombo

public static Combo createRecordCombo(Composite parent,
                                      Listener listener)
Creates an iSeries Record combox box. Does NOT create the leading prompt or anything except the combo.


createFieldCombo

public static Combo createFieldCombo(Composite parent,
                                     Listener listener)
Creates an iSeries Field combox box. Does NOT create the leading prompt or anything except the combo.


createIFSPathCombo

public static Combo createIFSPathCombo(Composite parent,
                                       Listener listener)
Creates an iSeries IFS path combox box. Does NOT create the leading prompt or anything except the combo.


showIBMiCommandsLogView

public static IBMiCommandsLogViewPart showIBMiCommandsLogView()
Show the iSeries Commands Log view


showIBMiCommandsLogView

public static IBMiCommandsLogViewPart showIBMiCommandsLogView(boolean toTop,
                                                              ISubSystem subsystem)
Show the iSeries Commands Log view (optionally bring view to top)

Parameters:
toTop - true if the view should be brought to the top if it is in a stacked notebook
subsystem - The subsystem folder (connection) that should be shown in the view, null if no changes should be made to which subsystem is shown.

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.