|
IBM Rational Performance Tester SDK | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.rational.test.lt.recorder.ui.RecorderUi
public class RecorderUi
Provides a central access point to the UI features of the recording framework. This class also provides static routines for common operations, label and images.
Field Summary | |
---|---|
static String |
ANNOTATION_RECORDER_TOOLBAR
Boolean option to enable the annotation tool bar. |
static RecorderUi |
INSTANCE
The unique instance of the singleton class RecorderUi. |
Method Summary | |
---|---|
static void |
activateRecordingView(IWorkbenchWindow window)
Opens if necessary, and activates the Recording Control view in the specified workbench window, in the active page. |
static INewRecordingSessionWizard |
createNewRecordingSessionWizard()
Creates a NewRecordingSessionWizard. |
static String |
getAnnotationTypeLabel(String annotationType)
Returns a label for an annotation type. |
static String |
getClientTypeLabel(String clientType)
Returns a label for a client type. |
com.ibm.rational.test.lt.recorder.ui.internal.extensibility.RecorderUIExtensionRegistry |
getExtensionRegistry()
Returns the recording framework UI extension registry. |
static Image |
getImage(Object object)
Returns the most descriptive image for a recording framework object. |
static ImageDescriptor |
getImageDescriptor(Object object)
Returns the most descriptive image descriptor for a recording framework object. |
static String |
getLabel(Object object)
Returns a label for a recording framework object. |
static String |
getPacketTypeLabel(String packetType)
Returns a label for a packet type. |
static String |
getRecorderTypeLabel(String recorderType)
Returns a label for a recorder type. |
static String |
getRecordingSessionDescription(IRecordingSession session)
Returns a short description of a recording session content. |
static IRecordingSession |
launchSession(RecordingSessionConfiguration rsc,
IWorkbenchWindow window)
Launches a new recording session, based on the provided session configuration and displays it in the specified workbench window. |
static void |
openEditorView(IRecordingSession session,
IWorkbenchWindow window)
Opens if necessary, and activates the Recording Session editor for the specified recording session, in the active page of the specified workbench window. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String ANNOTATION_RECORDER_TOOLBAR
RecorderCore.ANNOTATION_RECORDER_TYPE
).
public static RecorderUi INSTANCE
Method Detail |
---|
public com.ibm.rational.test.lt.recorder.ui.internal.extensibility.RecorderUIExtensionRegistry getExtensionRegistry()
public static IRecordingSession launchSession(RecordingSessionConfiguration rsc, IWorkbenchWindow window)
rsc
- A recording session configuration.window
- The window where the session should be displayed. This parameter may be
null
if the session is not to be displayed.
null
if the session could not be created.public static void activateRecordingView(IWorkbenchWindow window) throws PartInitException
window
- A workbench window.
PartInitException
public static void openEditorView(IRecordingSession session, IWorkbenchWindow window) throws PartInitException
session
- A recording session.window
- A workbench window.
PartInitException
public static ImageDescriptor getImageDescriptor(Object object)
object
- An object from the recording framework. Supported types are IClient
,
IRecorder
, IRecordingSession
, IRecorderPacket
and
RecorderAnnotation
. This list may be extended in the future.
null
if the specified object is not
one of the types listed above.public static Image getImage(Object object)
object
- An object from the recording framework. Supported types are IClient
,
IRecorder
, IRecordingSession
, IRecorderPacket
and
RecorderAnnotation
. This list may be extended in the future.
null
if the specified object is not one of the types listed above.public static String getLabel(Object object)
object
- An object from the recording framework. Supported types are IClient
,
IRecorder
, IRecordingSession
, IRecorderPacket
and
RecorderAnnotation
. This list may be
extended in the future.
null
if the specified object is not one of the types listed above.public static String getClientTypeLabel(String clientType)
clientType
- A client type. If the client type is not registered on
the platform, a generic label with be returned.
public static String getRecorderTypeLabel(String recorderType)
recorderType
- A recorder type. If the recorder type is not registered on
the platform, a generic label with be returned.
public static String getPacketTypeLabel(String packetType)
packetType
- A packet type. If the packet type is not registered on
the platform, a generic label with be returned.
public static String getAnnotationTypeLabel(String annotationType)
annotationType
- An annotation type. If the annotation type is not registered on
the platform, a generic label with be returned.
public static INewRecordingSessionWizard createNewRecordingSessionWizard()
public static String getRecordingSessionDescription(IRecordingSession session)
|
IBM Rational Performance Tester SDK | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |