Rational Developer for Power Systems Software
V7.6

com.ibm.etools.systems.editor
Class SystemEditorUtilities

java.lang.Object
  extended by com.ibm.etools.systems.editor.SystemEditorUtilities
Direct Known Subclasses:
ISeriesEditorUtilities

public class SystemEditorUtilities
extends Object


Field Summary
static String Copyright
           
 
Constructor Summary
SystemEditorUtilities()
           
 
Method Summary
static LpexView[] getAllLpexViews(LpexTextEditor editor)
          Retrieves a list of all the view open in an editor.
static TextEditorAction getBaseEditorAction(ITextEditor editor, String actionId)
          Method getBaseEditorAction.
static IFile getIFile(ITextEditor editor)
          Method getIFile.
static IMenuManager getSourceMenu(IMenuManager menuManager)
           
static void removeAllShowLines(LpexTextEditor editor)
          Removes all show lines from the bottom of the document to the top, including compile errors.
static void removeAllShowLines(LpexTextEditor editor, boolean ignoreCompileErrors)
          Removes all show lines from the bottom of the document to the top, optionally including compile errors.
static void removeMessages(LpexTextEditor editor, int iElementStart, int iElementEnd)
          Removes all messages from all views open in the specified editor
static void removeMessages(LpexTextEditor editor, int iElementStart, int iElementEnd, boolean ignoreCompileErrors)
          Removes all messages from all views open in the specified editor, optionally including compile errors.
static void removeMessages(LpexView view, int iElementStart, int iElementEnd, boolean ignoreCompileErrors, LpexTextEditor editor)
          Removes all message show elements associated with the given range of elements.
static void setDateArea(LpexView view)
          Method setDateArea.
static void updateEditors()
          Updates all open editors with the show date preference
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

Copyright

public static final String Copyright
See Also:
Constant Field Values
Constructor Detail

SystemEditorUtilities

public SystemEditorUtilities()
Method Detail

getAllLpexViews

public static LpexView[] getAllLpexViews(LpexTextEditor editor)
Retrieves a list of all the view open in an editor.

Parameters:
editor - the editor to retrieve the view.
Returns:
an array of LpexView. If the view was not split, then there will only be the primary view in the list.

getBaseEditorAction

public static TextEditorAction getBaseEditorAction(ITextEditor editor,
                                                   String actionId)
Method getBaseEditorAction. Retrieves and creates (if necessary) the common editor action needed to put in the source menu

Parameters:
editor - the editor to which the action belongs to
actionId - the id of the action to retrieve
Returns:
TextEditorAction the action retrieved from or created for the editor

removeAllShowLines

public static void removeAllShowLines(LpexTextEditor editor)
Removes all show lines from the bottom of the document to the top, including compile errors.


removeAllShowLines

public static void removeAllShowLines(LpexTextEditor editor,
                                      boolean ignoreCompileErrors)
Removes all show lines from the bottom of the document to the top, optionally including compile errors.


removeMessages

public static void removeMessages(LpexTextEditor editor,
                                  int iElementStart,
                                  int iElementEnd,
                                  boolean ignoreCompileErrors)
Removes all messages from all views open in the specified editor, optionally including compile errors.


removeMessages

public static void removeMessages(LpexTextEditor editor,
                                  int iElementStart,
                                  int iElementEnd)
Removes all messages from all views open in the specified editor


removeMessages

public static void removeMessages(LpexView view,
                                  int iElementStart,
                                  int iElementEnd,
                                  boolean ignoreCompileErrors,
                                  LpexTextEditor editor)
Removes all message show elements associated with the given range of elements.


getIFile

public static IFile getIFile(ITextEditor editor)
Method getIFile. retrieves the IFile object for source open in an editor

Parameters:
editor - the editor in which the source is open
Returns:
IFile the IFile found

getSourceMenu

public static IMenuManager getSourceMenu(IMenuManager menuManager)

setDateArea

public static void setDateArea(LpexView view)
Method setDateArea. Configures the window to show the date area as appropriate. Normally setDateArea(LpexView) is called. This method is used when the view is being initialized and the parser has not been set in the view yet

Since:
6.0 58407

updateEditors

public static void updateEditors()
Updates all open editors with the show date preference


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.