Remote Systems
v6.4.1

com.ibm.etools.systems.editor
Class SystemTextEditorDefaultContextContributor

java.lang.Object
  extended bycom.ibm.etools.systems.editor.SystemTextEditorDefaultContextContributor
All Implemented Interfaces:
ISystemTextEditorContextContributor

public class SystemTextEditorDefaultContextContributor
extends Object
implements ISystemTextEditorContextContributor

Parsers implement this interface to contribute to menu and toolbars.


Field Summary
static String Copyright
           
 
Constructor Summary
SystemTextEditorDefaultContextContributor()
           
 
Method Summary
 void cleanupMenu(ITextEditor editor, IMenuManager menuManager)
          Cleanup the menu bar.
 void cleanupPopupMenu(ITextEditor editor, IMenuManager menuManager)
          Cleanup the popup menu.
 void cleanupToolBar(ITextEditor editor, IToolBarManager toolBarManager)
          Cleanup the toolbar.
static void contributeCompileMenuItems(ITextEditor editor, IMenuManager menuCompile, Shell shell)
          Method contributeCompileMenuItems.
 void contributeToMenu(ITextEditor editor, IMenuManager menuManager)
          Contribute to the menu bar.
 void contributeToPopupMenu(ITextEditor editor, IMenuManager menuManager)
          Contribute to popup menu.
 void contributeToToolBar(ITextEditor editor, IToolBarManager toolBarManager)
          Contribute to the toolbar.
 void createCompileMenu(ITextEditor editor, IMenuManager menuManager)
           
 void finishedSaving(ITextEditor editor)
          Method finishedSaving.
static TextEditorAction getBaseEditorAction(ITextEditor editor, String actionId)
          Method getBaseEditorAction.
static StructuredSelection getCompileSelectionObject(ITextEditor editor)
          Method getCompileSelectionObject.
static IFile getIFile(ITextEditor editor)
          Method getIFile.
 void saving(ITextEditor editor)
          Method saving.
 
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

SystemTextEditorDefaultContextContributor

public SystemTextEditorDefaultContextContributor()
Method Detail

cleanupMenu

public void cleanupMenu(ITextEditor editor,
                        IMenuManager menuManager)
Cleanup the menu bar.

Specified by:
cleanupMenu in interface ISystemTextEditorContextContributor

cleanupPopupMenu

public void cleanupPopupMenu(ITextEditor editor,
                             IMenuManager menuManager)
Cleanup the popup menu.

Specified by:
cleanupPopupMenu in interface ISystemTextEditorContextContributor

cleanupToolBar

public void cleanupToolBar(ITextEditor editor,
                           IToolBarManager toolBarManager)
Cleanup the toolbar.

Specified by:
cleanupToolBar in interface ISystemTextEditorContextContributor

contributeToMenu

public void contributeToMenu(ITextEditor editor,
                             IMenuManager menuManager)
Contribute to the menu bar.

Specified by:
contributeToMenu in interface ISystemTextEditorContextContributor

createCompileMenu

public void createCompileMenu(ITextEditor editor,
                              IMenuManager menuManager)

contributeCompileMenuItems

public static void contributeCompileMenuItems(ITextEditor editor,
                                              IMenuManager menuCompile,
                                              Shell shell)
Method contributeCompileMenuItems. Add the menu items to the compile menu

Parameters:
editor - the editor that the source is open in
menuCompile - the compile menu

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

getCompileSelectionObject

public static StructuredSelection getCompileSelectionObject(ITextEditor editor)
Method getCompileSelectionObject. retrieves the object needed for the compile actions

Parameters:
editor - the editor that the source is open in
Returns:
StructuredSelection the selection object to pass to the compile actions

contributeToPopupMenu

public void contributeToPopupMenu(ITextEditor editor,
                                  IMenuManager menuManager)
Contribute to popup menu.

Specified by:
contributeToPopupMenu in interface ISystemTextEditorContextContributor

contributeToToolBar

public void contributeToToolBar(ITextEditor editor,
                                IToolBarManager toolBarManager)
Contribute to the toolbar.

Specified by:
contributeToToolBar in interface ISystemTextEditorContextContributor

saving

public void saving(ITextEditor editor)
Method saving. Called before saving

Specified by:
saving in interface ISystemTextEditorContextContributor

finishedSaving

public void finishedSaving(ITextEditor editor)
Method finishedSaving. Called after saving

Specified by:
finishedSaving in interface ISystemTextEditorContextContributor

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

Remote Systems
v6.4.1

Copyright © 2005 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.