com.ibm.rational.common.test.editor.framework

Class TestEditorPlugin

  • All Implemented Interfaces:
    com.ibm.rational.common.test.editor.framework.kernel.interfaces.ILoggingConstants, com.ibm.rational.common.test.editor.framework.preferences.CBPreferenceConstants, ILTPlugin, com.ibm.rational.test.lt.core.logging.ILTSubComponent, org.osgi.framework.BundleActivator


    public class TestEditorPlugin
    extends AbstractUIPlugin
    implements com.ibm.rational.common.test.editor.framework.kernel.interfaces.ILoggingConstants, ILTPlugin, com.ibm.rational.common.test.editor.framework.preferences.CBPreferenceConstants

    The main UI plug-in class.

    • Field Detail

      • PLUGIN_ID

        public static final String PLUGIN_ID
      • ms_ACTIVE_EDITOR_TYPE

        public static String ms_ACTIVE_EDITOR_TYPE
      • ms_RPT_COMMAND_CONTEXT_ID

        public static String ms_RPT_COMMAND_CONTEXT_ID
      • USER_EDITOR_MODE

        public static final int USER_EDITOR_MODE
      • RQM_EDITOR_MODE

        public static final int RQM_EDITOR_MODE
      • PREF_PREVIEW_LINKED

        public static final String PREF_PREVIEW_LINKED
      • PREF_USE_ERROR_COLOR

        public static final String PREF_USE_ERROR_COLOR
      • PREF_SEARCH_DECORATOR_COLOR

        public static final String PREF_SEARCH_DECORATOR_COLOR
      • PREF_SEARCH_DECORATOR_TEXT

        public static final String PREF_SEARCH_DECORATOR_TEXT
      • PREF_USE_SEARCH_DECORATOR

        public static final String PREF_USE_SEARCH_DECORATOR
      • PREF_SEARCH_SAVE_TYPES

        public static final String PREF_SEARCH_SAVE_TYPES
      • PREF_SEARCH_SAVE_TEXT

        public static final String PREF_SEARCH_SAVE_TEXT
      • PREF_FORCEWRAP_THRESHOLD

        public static final String PREF_FORCEWRAP_THRESHOLD
      • ENABLE_UNDO_REDO_SUPPORT

        public static boolean ENABLE_UNDO_REDO_SUPPORT
        This variable indicates whether Undo/Redo commands should be enabled in TestEditor instances. Changing this value has no effect on already opened editors.
      • OLD_CONFIRM_REMOVE

        public static final boolean OLD_CONFIRM_REMOVE
    • Constructor Detail

      • TestEditorPlugin

        public TestEditorPlugin()
    • Method Detail

      • getDefault

        public static TestEditorPlugin getDefault()
        Returns the shared instance.
      • getInstance

        public static TestEditorPlugin getInstance()
        Returns the shared instance.
      • getWorkspace

        public static IWorkspace getWorkspace()
        Returns the workspace instance.
      • getResourceBundleManager

        public static org.eclipse.hyades.test.core.util.ResourceBundleManager getResourceBundleManager()
      • start

        public void start(org.osgi.framework.BundleContext context)
                   throws Exception
        Specified by:
        start in interface org.osgi.framework.BundleActivator
        Overrides:
        start in class AbstractUIPlugin
        Throws:
        Exception
      • getID

        public static String getID()
        Returns this plugin's id.
        Returns:
        String
      • stop

        public void stop(org.osgi.framework.BundleContext context)
                  throws Exception
        Specified by:
        stop in interface org.osgi.framework.BundleActivator
        Overrides:
        stop in class AbstractUIPlugin
        Throws:
        Exception
      • saveEditorState

        public static void saveEditorState(TestEditor testEditor)
      • getPluginHelper

        public static PluginHelper getPluginHelper()
      • getLogger

        public PDLogger getLogger()
        Returns:
        Returns the m_logger.
      • getTranslatableResourceBundle

        public ResourceBundle getTranslatableResourceBundle()
        Specified by:
        getTranslatableResourceBundle in interface com.ibm.rational.test.lt.core.logging.ILTSubComponent
      • getNonTranslatableResourceBundle

        public ResourceBundle getNonTranslatableResourceBundle()
        Specified by:
        getNonTranslatableResourceBundle in interface com.ibm.rational.test.lt.core.logging.ILTSubComponent
      • recallLastModifiedDate

        public static long recallLastModifiedDate(String path)
        Deprecated. 
        Parameters:
        path -
      • setLastModifiedDate

        public static void setLastModifiedDate(String path,
                               long date)
        Deprecated. 
        Parameters:
        path -
      • getActiveEditor

        public TestEditor getActiveEditor()
        TestEditorPlugin keeps track of which TestEditor is active (editor window has keyboard focus).
        Returns:
        current editor, or null.
      • setActiveEditor

        public void setActiveEditor(TestEditor activeEditor)
        TestEditorPlugin keeps track of which TestEditor is active (editor window has keyboard focus).
        Parameters:
        activeEditor - CommonEditorExtension
        See Also:
        TestEditorPlugin.getActiveEditor()
      • addEditorListener

        public void addEditorListener(IEditorStateListener listener)
        Adds specified IEditorStateListener to list of listeners.
        Parameters:
        listener -
      • removeEditorListener

        public void removeEditorListener(IEditorStateListener listener)
        Removes specified IEditorStateListener from list of listeners.
        Parameters:
        listener -
      • getOpenEditors

        public TestEditor[] getOpenEditors()
        Returns:
        TestEditor[] Array of all currently opened TestEditors. Caller should not assume any particular type of editor, rather, an instanceof should be used to look for objects of interest.
      • getDialogSettingsSection

        public IDialogSettings getDialogSettingsSection(String name,
                                               IDialogSettings parent)
        DialogSections are used to store state information.
        Parameters:
        name - String name of the DialogSection to return. If name subsection is not found in parent, it is created.
        parent - IDialogSettings parent dialog section, or null. If parent is null, the @link AbstractUIPlugin#getDialogSettings() is called. Its return value is used as a parent.
        Returns:
        IDialogSettings
      • getImageManager

        public TestEditorImages getImageManager()
        Returns:
        Returns the img.
      • runErrorCheckingJob

        public void runErrorCheckingJob(TestEditor editor)
        Schedules an Error Checking Job for the editor.
        Parameters:
        editor -
      • cacheSyncPointName

        public static void cacheSyncPointName(String name)
      • removeSyncPointName

        public static void removeSyncPointName(String name)
      • getSyncPointsNames

        public static String[] getSyncPointsNames()
      • getTestInfoProvider

        public com.ibm.rational.common.test.editor.framework.extensions.TestInformationProvider getTestInfoProvider(String providerId)
      • getFindDuplicateIDsJob

        public static Job getFindDuplicateIDsJob()
      • setEditorMode

        public static int setEditorMode(int mode)
      • getEditorMode

        public static int getEditorMode()
        Returns the mode of the editor (user or RQM).
        Returns:
        The editors mode.
      • getColor

        public static Color getColor(String key)
        Extract color from color registry
        Parameters:
        key - String color name.
        Returns:
        Color
      • getColorManager

        public com.ibm.rational.common.test.editor.framework.TestEditorColors getColorManager()
      • getExtensionRegistry

        public com.ibm.rational.common.test.editor.framework.internal.extensibility.TestEditorExtensionsRegistry getExtensionRegistry()
      • getInteractionHandlerManager

        public com.ibm.rational.common.test.editor.framework.internal.change.service.InputHandlerManager getInteractionHandlerManager()
      • logError

        public void logError(String msg)
      • logError

        public void logError(Throwable t)
      • logDebug

        public void logDebug(String msg)
      • logWarning

        public void logWarning(String msg)
      • isDebugEnabled

        public static boolean isDebugEnabled(String option)
      • isDumpEnabled

        public static boolean isDumpEnabled(String option)
      • startEditorTracking

        public void startEditorTracking(IWorkbenchPage page)
IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2013. All rights reserved.