Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 

Eclipse GEF
3.3

org.eclipse.gef.ui.parts
Class GraphicalEditor

java.lang.Object
  extended by
org.eclipse.gef.ui.parts.GraphicalEditor
Direct Known Subclasses:
GraphicalEditorWithFlyoutPalette, GraphicalEditorWithPalette

public abstract class GraphicalEditor
extends java.lang.Object

This class serves as a quick starting point for clients who are new to GEF. It will create an Editor containing a single GraphicalViewer as its control.

IMPORTANTThis class should only be used as a reference for creating your own EditorPart implementation. This class will not suit everyone's needs, and may change in the future. Clients may copy the implementation.


Constructor Summary
GraphicalEditor ()
          Constructs the editor part
 
Method Summary
 void commandStackChanged (java.util.EventObject event)
          When the command stack changes, the actions interested in the command stack are updated.
protected  void configureGraphicalViewer ()
          Called to configure the graphical viewer before it receives its contents.
protected  void createActions ()
          Creates actions for this editor.
protected  void createGraphicalViewer (Composite parent)
          Creates the GraphicalViewer on the specified Composite.
 void createPartControl (Composite parent)
          Realizes the Editor by creating it's Control.
 void dispose ()
           
 void doSaveAs ()
          Does nothing be default.
protected  void firePropertyChange (int property)
           
protected   ActionRegistry getActionRegistry ()
          Lazily creates and returns the action registry.
 java.lang.Object getAdapter (java.lang.Class type)
          Returns the adapter for the specified key.
protected   CommandStack getCommandStack ()
          Returns the command stack.
protected   DefaultEditDomain getEditDomain ()
          Returns the edit domain.
protected   GraphicalViewer getGraphicalViewer ()
          Returns the graphical viewer.
protected  java.util.List getPropertyActions ()
          Returns the list of IActions dependant on property changes in the Editor.
protected  java.util.List getSelectionActions ()
          Returns the list of IDs of Actions that are dependant on changes in the workbench's ISelectionService.
protected   SelectionSynchronizer getSelectionSynchronizer ()
          Returns the selection syncronizer object.
protected  java.util.List getStackActions ()
          Returns the list of IDs of Actions that are dependant on the CommmandStack's state.
protected  void hookGraphicalViewer ()
          Hooks the GraphicalViewer to the rest of the Editor.
 void init ( IEditorSite site, IEditorInput input)
          Sets the site and input for this editor then creates and initializes the actions.
protected  void initializeActionRegistry ()
          Initializes the ActionRegistry.
protected abstract  void initializeGraphicalViewer ()
          Override to set the contents of the GraphicalViewer after it has been created.
 boolean isDirty ()
          Returns true if the command stack is dirty
 boolean isSaveAsAllowed ()
          Returns false by default.
 void selectionChanged ( IWorkbenchPart part, ISelection selection)
           
protected  void setActionRegistry ( ActionRegistry registry)
          Sets the ActionRegistry for this EditorPart.
protected  void setEditDomain ( DefaultEditDomain ed)
          Sets the EditDomain for this EditorPart.
 void setFocus ()
           
protected  void setGraphicalViewer ( GraphicalViewer viewer)
          Sets the graphicalViewer for this EditorPart.
protected  void updateActions (java.util.List actionIds)
          A convenience method for updating a set of actions defined by the given List of action IDs.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GraphicalEditor

public GraphicalEditor()
Constructs the editor part

Method Detail

commandStackChanged

public void commandStackChanged(java.util.EventObject event)
When the command stack changes, the actions interested in the command stack are updated.

Parameters:
event - the change event

configureGraphicalViewer

protected void configureGraphicalViewer()
Called to configure the graphical viewer before it receives its contents. This is where the root editpart should be configured. Subclasses should extend or override this method as needed.


createActions

protected void createActions()
Creates actions for this editor. Subclasses should override this method to create and register actions with the ActionRegistry.


createGraphicalViewer

protected void createGraphicalViewer(Composite parent)
Creates the GraphicalViewer on the specified Composite.

Parameters:
parent - the parent composite

createPartControl

public void createPartControl(Composite parent)
Realizes the Editor by creating it's Control.

WARNING: This method may or may not be called by the workbench prior to dispose().

Parameters:
parent - the parent composite

dispose

public void dispose()
See Also:
IWorkbenchPart.dispose()

doSaveAs

public void doSaveAs()
Does nothing be default. This method should be overridden if isSaveAsAllowed() has been overridden to return true.

See Also:
ISaveablePart.doSaveAs()

firePropertyChange

protected void firePropertyChange(int property)
See Also:
WorkbenchPart.firePropertyChange(int)

getActionRegistry

protected 
ActionRegistry getActionRegistry()
Lazily creates and returns the action registry.

Returns:
the action registry

getAdapter

public java.lang.Object getAdapter(java.lang.Class type)
Returns the adapter for the specified key.

IMPORTANT certain requests, such as the property sheet, may be made before or after createPartControl(Composite) is called. The order is unspecified by the Workbench.

See Also:
org.eclipse.core.runtime.IAdaptable#getAdapter(java.lang.Class)

getCommandStack

protected 
CommandStack getCommandStack()
Returns the command stack.

Returns:
the command stack

getEditDomain

protected 
DefaultEditDomain getEditDomain()
Returns the edit domain.

Returns:
the edit domain

getGraphicalViewer

protected 
GraphicalViewer getGraphicalViewer()
Returns the graphical viewer.

Returns:
the graphical viewer

getPropertyActions

protected java.util.List getPropertyActions()
Returns the list of IActions dependant on property changes in the Editor. These actions should implement the UpdateAction interface so that they can be updated in response to property changes. An example is the "Save" action.

Returns:
the list of property-dependant actions

getSelectionActions

protected java.util.List getSelectionActions()
Returns the list of IDs of Actions that are dependant on changes in the workbench's ISelectionService. The associated Actions can be found in the action registry. Such actions should implement the UpdateAction interface so that they can be updated in response to selection changes.

Returns:
the list of selection-dependant action IDs
See Also:
updateActions(List)

getSelectionSynchronizer

protected 
SelectionSynchronizer getSelectionSynchronizer()
Returns the selection syncronizer object. The synchronizer can be used to sync the selection of 2 or more EditPartViewers.

Returns:
the syncrhonizer

getStackActions

protected java.util.List getStackActions()
Returns the list of IDs of Actions that are dependant on the CommmandStack's state. The associated Actions can be found in the action registry. These actions should implement the UpdateAction interface so that they can be updated in response to command stack changes. An example is the "undo" action.

Returns:
the list of stack-dependant action IDs

hookGraphicalViewer

protected void hookGraphicalViewer()
Hooks the GraphicalViewer to the rest of the Editor. By default, the viewer is added to the SelectionSynchronizer, which can be used to keep 2 or more EditPartViewers in sync. The viewer is also registered as the ISelectionProvider for the Editor's PartSite.


init

public void init(
IEditorSite site,
                 
IEditorInput input)
          throws 
PartInitException
Sets the site and input for this editor then creates and initializes the actions. Subclasses may extend this method, but should always call super.init(site, input) .

Throws:
PartInitException
See Also:
IEditorPart.init(IEditorSite, IEditorInput)

initializeActionRegistry

protected void initializeActionRegistry()
Initializes the ActionRegistry. This registry may be used by ActionBarContributors and/or ContextMenuProviders.

This method may be called on Editor creation, or lazily the first time getActionRegistry() is called.


initializeGraphicalViewer

protected abstract void initializeGraphicalViewer()
Override to set the contents of the GraphicalViewer after it has been created.

See Also:
createGraphicalViewer(Composite)

isDirty

public boolean isDirty()
Returns true if the command stack is dirty

See Also:
ISaveablePart.isDirty()

isSaveAsAllowed

public boolean isSaveAsAllowed()
Returns false by default. Subclasses must return true to allow doSaveAs() to be called.

See Also:
ISaveablePart.isSaveAsAllowed()

selectionChanged

public void selectionChanged(
IWorkbenchPart part,
                             
ISelection selection)
See Also:
ISelectionListener.selectionChanged(IWorkbenchPart, ISelection)

setActionRegistry

protected void setActionRegistry(
ActionRegistry registry)
Sets the ActionRegistry for this EditorPart.

Parameters:
registry - the registry

setEditDomain

protected void setEditDomain(
DefaultEditDomain ed)
Sets the EditDomain for this EditorPart.

Parameters:
ed - the domain

setFocus

public void setFocus()
See Also:
IWorkbenchPart.setFocus()

setGraphicalViewer

protected void setGraphicalViewer(
GraphicalViewer viewer)
Sets the graphicalViewer for this EditorPart.

Parameters:
viewer - the graphical viewer

updateActions

protected void updateActions(java.util.List actionIds)
A convenience method for updating a set of actions defined by the given List of action IDs. The actions are found by looking up the ID in the action registry. If the corresponding action is an UpdateAction, it will have its update() method called.

Parameters:
actionIds - the list of IDs to update

Eclipse GEF
3.3

Copyright (c) IBM Corp. and others 2000, 2007. All Rights Reserved.

 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire