Rational Developer for Power Systems Software
V7.6

com.ibm.etools.systems.editor
Interface ISystemTextEditorProfile

All Known Implementing Classes:
IBMiIFSEditorProfile, QSYSEditorProfile, SystemTextEditorProfileDefault, SystemTextEditorProfileUniversal, SystemTextEditorProfileUniversalLocal

public interface ISystemTextEditorProfile

Editor profiles are used to personalize the base SystemTextEditor so that only one JLpex based text editor is required. Plugins may specify an editor extension while specifying the SystemTextEditor class as the text editor. The plugin can then extend the "profile" extension point, and specify a profile class and type string. When an IFile is opened for editing, the type string property of the IFile is loaded. A corresponding profile class for the same type string is loaded, and the calls are made to these methods whenever the corresponding JLpex calls are made.


Field Summary
static String Copyright
           
 
Method Summary
 void addDebugEditorMenuActions(IMenuManager menu, boolean isDebuggable, int currentElement)
          Add debug editor menu actions associated with this profile.
 void addDebugEditorRulerActions(IMenuManager menu, boolean isDebuggable, int currentElement)
          Add debug editor ruler actions associated with this profile.
 MenuManager createContextMenuManager(String text, String id)
          Creates a context menu manager.
 void createDebugMenuActions(LpexTextEditor editor)
          Create debug menu actions associated with this profile
 void createDebugRulerActions(LpexTextEditor editor, IVerticalRuler ruler)
          Create debug ruler actions associated with this profile.
 void doSave(LpexTextEditor editor, IProgressMonitor progressMonitor)
          Called when the editor's doSave is called.
 void editorContextMenuAboutToShow(LpexTextEditor editor, IMenuManager menu)
          Called when JLpex's editorContextMenuAboutToShow is called
 IAction getBreakpointRulerAction(LpexTextEditor editor)
          Returns the appropriate breakpoint ruler action associated with this profile.
 long getCompileMessageClassBitMask()
          Gty the bit mask for compile messages
 IAnnotationModel getDebuggerMarkerAnnotationModel(IResource resource, IEditorInput input)
          Get the debugger marker annotation model for this resource in this profile.
 String getTitle(LpexTextEditor editor)
          Get the title to display in the editor
 void initializeLpexView(LpexTextEditor editor, LpexView lpexView)
          Called when JLpex's initializeLpexView is called.
 boolean isEditorInputIncludedInContextMenu()
          Returns whether or not Editor Input actions should be included in the context menu.
 boolean isLocal()
          Queries if the profile is for local resources or remote resources.
 boolean isTargetDebuggable(IDebugTarget dbgtarget)
          Determine if the specified target is debuggable.
 boolean isUniqueContextMenuManagerRequired()
          Returns whether or not a unique menu manager is required by this profile.
 boolean performSaveAs(LpexTextEditor editor, IProgressMonitor progressMonitor)
          Called when JLpex's performSaveAs is called.
 boolean performSaveAs(LpexTextEditor editor, IProgressMonitor progressMonitor, String strFilename)
          Called when JLpex's performSaveAs is called.
 void resetMarkers(LpexTextEditor editor)
          Reset markers associated with the resource being edited.
 void updateProfile(LpexTextEditor editor)
          Called when JLpex's updateProfile is called.
 void updateProfile(LpexTextEditor editor, LpexView lpexView)
          Called when JLpex's updateProfile is called.
 

Field Detail

Copyright

static final String Copyright
See Also:
Constant Field Values
Method Detail

doSave

void doSave(LpexTextEditor editor,
            IProgressMonitor progressMonitor)
Called when the editor's doSave is called.


editorContextMenuAboutToShow

void editorContextMenuAboutToShow(LpexTextEditor editor,
                                  IMenuManager menu)
Called when JLpex's editorContextMenuAboutToShow is called


initializeLpexView

void initializeLpexView(LpexTextEditor editor,
                        LpexView lpexView)
Called when JLpex's initializeLpexView is called.


performSaveAs

boolean performSaveAs(LpexTextEditor editor,
                      IProgressMonitor progressMonitor)
Called when JLpex's performSaveAs is called. If true is returned, the editor's default saveAs is called. If false is returned, the editor's default saveAs is not called.


performSaveAs

boolean performSaveAs(LpexTextEditor editor,
                      IProgressMonitor progressMonitor,
                      String strFilename)
Called when JLpex's performSaveAs is called. If true is returned, the editor's default saveAs is called. If false is returned, the editor's default saveAs is not called.


updateProfile

void updateProfile(LpexTextEditor editor)
Called when JLpex's updateProfile is called.


updateProfile

void updateProfile(LpexTextEditor editor,
                   LpexView lpexView)
Called when JLpex's updateProfile is called.


getCompileMessageClassBitMask

long getCompileMessageClassBitMask()
Gty the bit mask for compile messages


getTitle

String getTitle(LpexTextEditor editor)
Get the title to display in the editor

Returns:
title to display if it can be determined, null for editor to display its default title.

isLocal

boolean isLocal()
Queries if the profile is for local resources or remote resources.

Returns:
true if resource is local, false if resource is remote

resetMarkers

void resetMarkers(LpexTextEditor editor)
Reset markers associated with the resource being edited.


getBreakpointRulerAction

IAction getBreakpointRulerAction(LpexTextEditor editor)
Returns the appropriate breakpoint ruler action associated with this profile.

Returns:
the breakpoint ruler action, null if there is no such action

createDebugRulerActions

void createDebugRulerActions(LpexTextEditor editor,
                             IVerticalRuler ruler)
Create debug ruler actions associated with this profile.


createDebugMenuActions

void createDebugMenuActions(LpexTextEditor editor)
Create debug menu actions associated with this profile


addDebugEditorMenuActions

void addDebugEditorMenuActions(IMenuManager menu,
                               boolean isDebuggable,
                               int currentElement)
Add debug editor menu actions associated with this profile. If the source is not debuggable, leave out the debug actions


addDebugEditorRulerActions

void addDebugEditorRulerActions(IMenuManager menu,
                                boolean isDebuggable,
                                int currentElement)
Add debug editor ruler actions associated with this profile. If the source is not debuggable, leave out the debug actions


isTargetDebuggable

boolean isTargetDebuggable(IDebugTarget dbgtarget)
Determine if the specified target is debuggable. Returns true if the target is debuggable.


getDebuggerMarkerAnnotationModel

IAnnotationModel getDebuggerMarkerAnnotationModel(IResource resource,
                                                  IEditorInput input)
Get the debugger marker annotation model for this resource in this profile. Returns an annotation model


isEditorInputIncludedInContextMenu

boolean isEditorInputIncludedInContextMenu()
Returns whether or not Editor Input actions should be included in the context menu. Example: Run As, Debug As, Team, etc.

Returns:
true if editor input actions are to be included in context menu, otherwise false

isUniqueContextMenuManagerRequired

boolean isUniqueContextMenuManagerRequired()
Returns whether or not a unique menu manager is required by this profile.

Returns:
true if a unique context menu manager will be provided by this editor profile, false otherwise.

createContextMenuManager

MenuManager createContextMenuManager(String text,
                                     String id)
Creates a context menu manager. Only called if isUniqueContextMenuManagerRequired() returns true.

Parameters:
text - the text of the menu manager.
id - the id of the menu manager.
Returns:
a menu manager.

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.