The Robot Application Programming Interface Delegate Project
RAPID Logo

ViewID Class Reference

Collaboration diagram for ViewID:

List of all members.

Static Public Member Functions

static String getUniqueSecondaryID (String viewID)
 Get a unique secondary id for the given view.
static String getUniqueSecondaryID (String viewID, String optionsString)
 Get a unique secondary id for the given view.
static String getUniqueID (String viewID)
 Create a full ID string including the View ID and secondary ID.
static String getUniqueID (String viewID, String optionString)
static String getUniqueID (String viewID, Map< String, String > optionMap)
static Map< String, String > getOptionMap (String secondaryId)
 Get a map of key,value options from a secondary id.
static Map< String, String > getOptionMap (String secondaryId, Map< String, String > options)
static Map< String, String > getOptionMap (ViewPart viewPart)
 Convenience method.
static Map< String, String > getOptionMap (ViewPart viewPart, Map< String, String > options)
 Convenience method.
static String getOptionString (Map< String, String > optionMap)

Member Function Documentation

static Map<String,String> getOptionMap ( String  secondaryId) [static]

Options are separated by semicolon (';') character and are of the form option=value. e.g. "vip=4321;foo=bar;option=sweet"

Parameters:
secondaryIdViewPart secondary id, obtained from ViewPart.getViewSite().getSecondaryId();
Returns:
map of options
static Map<String,String> getOptionMap ( ViewPart  viewPart) [static]
Parameters:
viewPartViewPart reference
Returns:
ViewID.getOptionMap(viewPart.getViewSite().getSecondaryId())

Here is the call graph for this function:

static Map<String,String> getOptionMap ( ViewPart  viewPart,
Map< String, String >  options 
) [static]
Parameters:
viewPartViewPart reference
optionsmap to fill and return
Returns:
options

Here is the call graph for this function:

static Map<String,String> getOptionMap ( String  secondaryId,
Map< String, String >  options 
) [static]
static String getOptionString ( Map< String, String >  optionMap) [static]
Parameters:
optionMap
Returns:
string in the form of ";option1=value1;option2=value2"
static String getUniqueID ( String  viewID,
Map< String, String >  optionMap 
) [static]
Parameters:
viewID
optionMap
Returns:

Here is the call graph for this function:

static String getUniqueID ( String  viewID,
String  optionString 
) [static]
Parameters:
viewID
optionString
See also:
getOptionMap(String secondaryId)
Returns:

Here is the call graph for this function:

static String getUniqueID ( String  viewID) [static]
Parameters:
viewIDID string of the view
Returns:
viewID + ":" + uniqueSecondaryID

Here is the call graph for this function:

static String getUniqueSecondaryID ( String  viewID,
String  optionsString 
) [static]

If there is no active workbench window / page, this will return a random number between 0 and 9999

Parameters:
viewID
optionse.g. "vip=4321;foo=bar;option=sweet"
Returns:
static String getUniqueSecondaryID ( String  viewID) [static]

If there is no active workbench window / page, this will return a random number between 0 and 9999

Parameters:
viewID
Returns:

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines