Eclipse GEF
2.1

org.eclipse.gef.ui.parts
Class GraphicalEditorWithPalette

java.lang.Object
  |
  +--org.eclipse.ui.part.WorkbenchPart
        |
        +--org.eclipse.ui.part.EditorPart
              |
              +--org.eclipse.gef.ui.parts.GraphicalEditor
                    |
                    +--org.eclipse.gef.ui.parts.GraphicalEditorWithPalette
All Implemented Interfaces:
CommandStackListener, IAdaptable, IEditorPart, IExecutableExtension, ISaveablePart, ISelectionListener, IWorkbenchPart

public abstract class GraphicalEditorWithPalette
extends GraphicalEditor

This class serves as a quick starting point for clients who are new to GEF. It will create an Editor containing a Split composite, with one side contianing a PaletteViewer, and the other a GraphicalViewer.

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.


Field Summary
 
Fields inherited from interface org.eclipse.ui.IEditorPart
PROP_DIRTY, PROP_INPUT
 
Fields inherited from interface org.eclipse.ui.IWorkbenchPart
PROP_TITLE
 
Constructor Summary
GraphicalEditorWithPalette()
           
 
Method Summary
protected  void configurePaletteViewer()
          Called to configure the viewer before it receives its contents.
protected  void createPaletteViewer(Composite parent)
          Creates the palette on the given composite.
 void createPartControl(Composite parent)
          Realizes the Editor by creating it's Control.
protected  int getInitialPaletteSize()
          Returns the initial palette size in pixels.
protected abstract  PaletteRoot getPaletteRoot()
          Returns the PaletteRoot for the palette viewer.
protected  PaletteViewer getPaletteViewer()
          Returns the PaletteViewer.
protected  void handlePaletteResized(int newSize)
          Called whenever the user resizes the palette.
protected  void hookPaletteViewer()
          Called when the palette viewer is set.
protected  void initializePaletteViewer()
          Called to populate the palette viewer.
protected  void setPaletteViewer(PaletteViewer paletteViewer)
          Sets the palette viewer
 
Methods inherited from class org.eclipse.gef.ui.parts.GraphicalEditor
commandStackChanged, configureGraphicalViewer, createActions, createGraphicalViewer, dispose, firePropertyChange, getActionRegistry, getAdapter, getCommandStack, getEditDomain, getGraphicalViewer, getPropertyActions, getSelectionActions, getSelectionSynchronizer, getStackActions, hookGraphicalViewer, init, initializeActionRegistry, initializeGraphicalViewer, selectionChanged, setActionRegistry, setEditDomain, setFocus, setGraphicalViewer, updateActions
 
Methods inherited from class org.eclipse.ui.part.EditorPart
doSave, doSaveAs, getEditorInput, getEditorSite, getTitleToolTip, gotoMarker, isDirty, isSaveAsAllowed, isSaveOnCloseNeeded, setInput
 
Methods inherited from class org.eclipse.ui.part.WorkbenchPart
addPropertyListener, getConfigurationElement, getDefaultImage, getSite, getTitle, getTitleImage, removePropertyListener, setInitializationData, setSite, setTitle, setTitleImage, setTitleToolTip
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.ui.IWorkbenchPart
addPropertyListener, getSite, getTitle, getTitleImage, removePropertyListener
 

Constructor Detail

GraphicalEditorWithPalette

public GraphicalEditorWithPalette()
Method Detail

configurePaletteViewer

protected void configurePaletteViewer()
Called to configure the viewer before it receives its contents.


createPaletteViewer

protected void createPaletteViewer(Composite parent)
Creates the palette on the given composite.

Parameters:
parent - the composite

createPartControl

public void createPartControl(Composite parent)
Description copied from class: GraphicalEditor
Realizes the Editor by creating it's Control.

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

Specified by:
createPartControl in interface IWorkbenchPart
Overrides:
createPartControl in class GraphicalEditor
Parameters:
parent - the parent composite
See Also:
IWorkbenchPart.createPartControl(org.eclipse.swt.widgets.Composite)

getPaletteRoot

protected abstract PaletteRoot getPaletteRoot()
Returns the PaletteRoot for the palette viewer.

Returns:
the palette root

getInitialPaletteSize

protected int getInitialPaletteSize()
Returns the initial palette size in pixels. Subclasses may override this method to return a persisted value.

Returns:
the initial size of the palette in pixels.
See Also:
handlePaletteResized(int)

getPaletteViewer

protected PaletteViewer getPaletteViewer()
Returns the PaletteViewer.

Returns:
the palette viewer

handlePaletteResized

protected void handlePaletteResized(int newSize)
Called whenever the user resizes the palette.

Parameters:
newSize - the new size in pixels

hookPaletteViewer

protected void hookPaletteViewer()
Called when the palette viewer is set. By default, the EditDomain is given the palette viewer.


initializePaletteViewer

protected void initializePaletteViewer()
Called to populate the palette viewer.


setPaletteViewer

protected void setPaletteViewer(PaletteViewer paletteViewer)
Sets the palette viewer

Parameters:
paletteViewer - the palette viewer

Eclipse GEF
2.1

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