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.
Modifier and Type | Field and Description |
---|---|
static boolean |
ENABLE_UNDO_REDO_SUPPORT
This variable indicates whether Undo/Redo commands should be enabled in TestEditor
instances.
|
static String |
ms_ACTIVE_EDITOR_TYPE |
static String |
ms_RPT_COMMAND_CONTEXT_ID |
static boolean |
OLD_CONFIRM_REMOVE |
static String |
PLUGIN_ID |
static String |
PREF_FORCEWRAP_THRESHOLD |
static String |
PREF_PREVIEW_LINKED |
static String |
PREF_SEARCH_DECORATOR_COLOR |
static String |
PREF_SEARCH_DECORATOR_TEXT |
static String |
PREF_SEARCH_SAVE_TEXT |
static String |
PREF_SEARCH_SAVE_TYPES |
static String |
PREF_USE_ERROR_COLOR |
static String |
PREF_USE_SEARCH_DECORATOR |
static int |
RQM_EDITOR_MODE |
static int |
USER_EDITOR_MODE |
PLUGIN_PREFERENCE_SCOPE, PREFERENCES_DEFAULT_OVERRIDE_BASE_NAME, PREFERENCES_DEFAULT_OVERRIDE_FILE_NAME
RPCA0100W, RPCA0101W, RPCA0102W, RPCA0103W, RPCA0104W, RPCA0105E, RPCA0106E, RPCA0107E, RPCA0108E, RPCA0109E, RPCA0110E, RPCA1001E, RPCA1001W, RPCA1002E
FG_DOCUMENTATION, FG_REGEX_GROUP, FG_REGEX_MATCH, PCN_DISABLED_COLOR_BG, PCN_DISABLED_COLOR_FG, PCN_DISABLED_PREFIX, PCN_DISPLAY_NESTED_COMMENTS, PCN_INFO_COLOR, PCN_INFO_COLOR_USED, PCN_KEEP_CHILDREN_OPTION, PCN_KEEP_CHILDREN_OPTION2, PCN_MOVE_INTO_IF_OPTION, PCN_MOVE_INTO_LOOP_OPTION, PCN_MOVE_INTO_OTHER_OPTION, PCN_MOVE_INTO_RS_OPTION, PCN_MOVE_INTO_TRANS_OPTION, PCN_RANGE_EVEN_BG, PCN_RANGE_ODD_BG, PCN_SEARCH_MATCH_BG, PCN_SEARCH_MATCH_FG, PREFIX_CAPTURE_SELECTION_UPON_INSERT
Constructor and Description |
---|
TestEditorPlugin() |
Modifier and Type | Method and Description |
---|---|
void |
addEditorListener(IEditorStateListener listener)
Adds specified
IEditorStateListener to list of listeners. |
static void |
cacheSyncPointName(String name) |
static IStatus |
errorStatus(String msg,
Throwable t) |
boolean |
fireEditorEvent(int event_type,
TestEditor editor)
Notifies listeners of changes in the state of
TestEditor . |
TestEditor |
getActiveEditor()
TestEditorPlugin keeps track of which
TestEditor is active (editor window has keyboard focus). |
static Color |
getColor(String key)
Extract color from color registry
|
com.ibm.rational.common.test.editor.framework.TestEditorColors |
getColorManager() |
static ColorRegistry |
getColorRegistry()
Returns the plugin's color registry.
|
static TestEditorPlugin |
getDefault()
Returns the shared instance.
|
IDialogSettings |
getDialogSettingsSection(String name,
IDialogSettings parent)
DialogSections are used to store state information.
|
TestEditor |
getEditorFor(CBActionElement element)
Returns an editor that has the model to which the argument
element belongs. |
static int |
getEditorMode()
Returns the mode of the editor (user or RQM).
|
static IDialogSettings |
getEditorState(TestEditor testEditor) |
com.ibm.rational.common.test.editor.framework.internal.extensibility.TestEditorExtensionsRegistry |
getExtensionRegistry() |
static Job |
getFindDuplicateIDsJob() |
static String |
getID()
Returns this plugin's id.
|
TestEditorImages |
getImageManager() |
static TestEditorPlugin |
getInstance()
Returns the shared instance.
|
com.ibm.rational.common.test.editor.framework.internal.change.service.InputHandlerManager |
getInteractionHandlerManager() |
PDLogger |
getLogger() |
ResourceBundle |
getNonTranslatableResourceBundle() |
TestEditor[] |
getOpenEditors() |
static PluginHelper |
getPluginHelper() |
static org.eclipse.hyades.test.core.util.ResourceBundleManager |
getResourceBundleManager() |
static String |
getString(String key)
Returns a string from Test Editor plugin.properties file
|
static String |
getString(String key,
String arg)
Returns a string from Test Editor plugin.properties file
|
static String |
getString(String key,
String[] args)
Returns a string from Test Editor plugin.properties file
|
static String[] |
getSyncPointsNames() |
com.ibm.rational.common.test.editor.framework.extensions.TestInformationProvider |
getTestInfoProvider(String providerId) |
ResourceBundle |
getTranslatableResourceBundle() |
static IWorkspace |
getWorkspace()
Returns the workspace instance.
|
static boolean |
isDebugEnabled(String option) |
static boolean |
isDumpEnabled(String option) |
void |
logDebug(String msg) |
void |
logError(String msg) |
void |
logError(String msg,
Throwable t) |
void |
logError(Throwable t) |
void |
logWarning(String msg) |
static long |
recallLastModifiedDate(String path)
Deprecated.
|
void |
removeEditorListener(IEditorStateListener listener)
Removes specified
IEditorStateListener from list of listeners. |
static void |
removeSyncPointName(String name) |
void |
runErrorCheckingJob(TestEditor editor)
Schedules an Error Checking Job for the
editor . |
void |
saveDialogSettings() |
static void |
saveEditorState(TestEditor testEditor) |
void |
setActiveEditor(TestEditor activeEditor)
TestEditorPlugin keeps track of which
TestEditor is active (editor window has keyboard focus). |
static int |
setEditorMode(int mode) |
static void |
setLastModifiedDate(String path,
long date)
Deprecated.
|
void |
start(org.osgi.framework.BundleContext context) |
void |
startEditorTracking(IWorkbenchPage page) |
void |
stop(org.osgi.framework.BundleContext context) |
createImageRegistry, getDialogSettings, getImageRegistry, getPreferenceStore, getWorkbench, imageDescriptorFromPlugin, initializeDefaultPluginPreferences, initializeDefaultPreferences, initializeImageRegistry, loadDialogSettings, loadPreferenceStore, refreshPluginActions, savePreferenceStore, shutdown, startup
find, find, getBundle, getDescriptor, getLog, getPluginPreferences, getStateLocation, internalInitializeDefaultPluginPreferences, isDebugging, openStream, openStream, savePluginPreferences, setDebugging, toString
public static final String PLUGIN_ID
public static String ms_ACTIVE_EDITOR_TYPE
public static String ms_RPT_COMMAND_CONTEXT_ID
public static final int USER_EDITOR_MODE
public static final int RQM_EDITOR_MODE
public static final String PREF_PREVIEW_LINKED
public static final String PREF_USE_ERROR_COLOR
public static final String PREF_SEARCH_DECORATOR_COLOR
public static final String PREF_SEARCH_DECORATOR_TEXT
public static final String PREF_USE_SEARCH_DECORATOR
public static final String PREF_SEARCH_SAVE_TYPES
public static final String PREF_SEARCH_SAVE_TEXT
public static final String PREF_FORCEWRAP_THRESHOLD
public static boolean ENABLE_UNDO_REDO_SUPPORT
public static final boolean OLD_CONFIRM_REMOVE
public static TestEditorPlugin getDefault()
public static TestEditorPlugin getInstance()
public static IWorkspace getWorkspace()
public static org.eclipse.hyades.test.core.util.ResourceBundleManager getResourceBundleManager()
public static String getString(String key) throws NullPointerException, MissingResourceException
public static String getString(String key, String arg) throws NullPointerException, MissingResourceException
public static String getString(String key, String[] args) throws NullPointerException, MissingResourceException
public void start(org.osgi.framework.BundleContext context) throws Exception
start
in interface org.osgi.framework.BundleActivator
start
in class AbstractUIPlugin
Exception
public static String getID()
public void stop(org.osgi.framework.BundleContext context) throws Exception
stop
in interface org.osgi.framework.BundleActivator
stop
in class AbstractUIPlugin
Exception
public static void saveEditorState(TestEditor testEditor)
public void saveDialogSettings()
saveDialogSettings
in class AbstractUIPlugin
public static IDialogSettings getEditorState(TestEditor testEditor)
public static PluginHelper getPluginHelper()
public PDLogger getLogger()
public ResourceBundle getTranslatableResourceBundle()
getTranslatableResourceBundle
in interface com.ibm.rational.test.lt.core.logging.ILTSubComponent
public ResourceBundle getNonTranslatableResourceBundle()
getNonTranslatableResourceBundle
in interface com.ibm.rational.test.lt.core.logging.ILTSubComponent
public static long recallLastModifiedDate(String path)
path
- public static void setLastModifiedDate(String path, long date)
path
- public TestEditor getActiveEditor()
TestEditor
is active (editor window has keyboard focus).null
.public void setActiveEditor(TestEditor activeEditor)
TestEditor
is active (editor window has keyboard focus).activeEditor
- CommonEditorExtensionTestEditorPlugin.getActiveEditor()
public void addEditorListener(IEditorStateListener listener)
IEditorStateListener
to list of listeners.listener
- public void removeEditorListener(IEditorStateListener listener)
IEditorStateListener
from list of listeners.listener
- public boolean fireEditorEvent(int event_type, TestEditor editor)
TestEditor
.event_type
- Stringeditor
- TestEditor
that has caused a change.true
.IEditorStateListener
,
TestEditorPlugin.addEditorListener(IEditorStateListener)
,
TestEditorPlugin.removeEditorListener(IEditorStateListener)
public TestEditor[] getOpenEditors()
instanceof
should be used to look for objects of interest.public TestEditor getEditorFor(CBActionElement element)
element
belongs.element
- CBActionElement
TestEditor
or null
.public IDialogSettings getDialogSettingsSection(String name, IDialogSettings parent)
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.public TestEditorImages getImageManager()
public void runErrorCheckingJob(TestEditor editor)
editor
.editor
- public static void cacheSyncPointName(String name)
public static void removeSyncPointName(String name)
public static String[] getSyncPointsNames()
public com.ibm.rational.common.test.editor.framework.extensions.TestInformationProvider getTestInfoProvider(String providerId)
public static Job getFindDuplicateIDsJob()
public static int setEditorMode(int mode)
public static int getEditorMode()
public static ColorRegistry getColorRegistry()
TestEditorPlugin.getColor(String)
instead.TestEditorPlugin.getColor(String)
public static Color getColor(String key)
key
- String color name.public com.ibm.rational.common.test.editor.framework.TestEditorColors getColorManager()
public com.ibm.rational.common.test.editor.framework.internal.extensibility.TestEditorExtensionsRegistry getExtensionRegistry()
public com.ibm.rational.common.test.editor.framework.internal.change.service.InputHandlerManager getInteractionHandlerManager()
public void logError(String msg)
public void logError(Throwable t)
public void logDebug(String msg)
public void logWarning(String msg)
public static boolean isDebugEnabled(String option)
public static boolean isDumpEnabled(String option)
public void startEditorTracking(IWorkbenchPage page)
© Copyright IBM Corp. 2013. All rights reserved.