Package org.eclipse.gef.ui.parts
Class GraphicalEditorWithFlyoutPalette
java.lang.Object
org.eclipse.core.commands.common.EventManager
org.eclipse.ui.part.WorkbenchPart
org.eclipse.ui.part.EditorPart
org.eclipse.gef.ui.parts.GraphicalEditor
org.eclipse.gef.ui.parts.GraphicalEditorWithFlyoutPalette
- All Implemented Interfaces:
- EventListener,- IAdaptable,- IExecutableExtension,- CommandStackEventListener,- CommandStackListener,- IEditorPart,- ISaveablePart,- ISelectionListener,- IWorkbenchPart,- IWorkbenchPart2,- IWorkbenchPart3,- IWorkbenchPartOrientation
This class serves as a quick starting point for clients who are new to GEF.
 It will create an Editor with a flyout palette. The flyout palette will only
 be visible when the palette view is not open.
 
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.
- Since:
- 3.0
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionprotected classA custom PalettePage that helps GraphicalEditorWithFlyoutPalette keep the two PaletteViewers (one displayed in the editor and the other displayed in the PaletteView) in sync when switching from one to the other (i.e., it helps maintain state across the two viewers).
- 
Field SummaryFields inherited from interface org.eclipse.ui.IEditorPartPROP_DIRTY, PROP_INPUTFields inherited from interface org.eclipse.ui.IWorkbenchPartPROP_TITLE
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionprotected FlyoutPaletteCompositecreatePaletteComposite(Composite parent) Creates a newFlyoutPaletteCompositeto be used by thisGraphicalEditorWithFlyoutPaletteprotected PaletteViewerProviderCreates a PaletteViewerProvider that will be used to create palettes for the view and the flyout.voidcreatePartControl(Composite parent) Realizes the Editor by creating it's Control.<T> TgetAdapter(Class<T> type) Returns the adapter for the specified key.protected Controlprotected FlyoutPaletteComposite.FlyoutPreferencesBy default, this method returns a FlyoutPreferences object that stores the flyout settings in the GEF plugin.protected abstract PaletteRootReturns the PaletteRoot for the palette viewer.protected final PaletteViewerProviderReturns the palette viewer provider that is used to create palettes for the view and the flyout.protected voidOverride to set the contents of the GraphicalViewer after it has been created.protected voidSets the edit domain for this editor.Methods inherited from class org.eclipse.gef.ui.parts.GraphicalEditorcommandStackChanged, configureGraphicalViewer, createActions, createGraphicalViewer, dispose, doSaveAs, firePropertyChange, getActionRegistry, getCommandStack, getEditDomain, getGraphicalViewer, getPropertyActions, getSelectionActions, getSelectionSynchronizer, getStackActions, hookGraphicalViewer, init, initializeActionRegistry, isDirty, isSaveAsAllowed, selectionChanged, setActionRegistry, setFocus, setGraphicalViewer, stackChanged, updateActionsMethods inherited from class org.eclipse.ui.part.EditorPartcheckSite, doSave, getEditorInput, getEditorSite, getTitleToolTip, isSaveOnCloseNeeded, setContentDescription, setInitializationData, setInput, setInputWithNotify, setPartNameMethods inherited from class org.eclipse.ui.part.WorkbenchPartaddPartPropertyListener, addPropertyListener, firePartPropertyChanged, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, getTitleImage, removePartPropertyListener, removePropertyListener, setPartProperty, setSite, setTitle, setTitleImage, setTitleToolTip, showBusyMethods inherited from class org.eclipse.core.commands.common.EventManageraddListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObjectMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.eclipse.ui.IWorkbenchPartaddPropertyListener, getSite, getTitle, getTitleImage, removePropertyListener
- 
Constructor Details- 
GraphicalEditorWithFlyoutPalettepublic GraphicalEditorWithFlyoutPalette()
 
- 
- 
Method Details- 
initializeGraphicalViewerprotected void initializeGraphicalViewer()Description copied from class:GraphicalEditorOverride to set the contents of the GraphicalViewer after it has been created.- Specified by:
- initializeGraphicalViewerin class- GraphicalEditor
- See Also:
 
- 
createPaletteViewerProviderCreates a PaletteViewerProvider that will be used to create palettes for the view and the flyout.- Returns:
- the palette provider
 
- 
createPalettePage- Returns:
- a newly-created GraphicalEditorWithFlyoutPalette.CustomPalettePage
 
- 
createPartControlDescription copied from class:GraphicalEditorRealizes 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:
- createPartControlin interface- IWorkbenchPart
- Overrides:
- createPartControlin class- GraphicalEditor
- Parameters:
- parent- the parent composite
- See Also:
 
- 
createPaletteCompositeCreates a newFlyoutPaletteCompositeto be used by thisGraphicalEditorWithFlyoutPalette- Parameters:
- parent- The- Composite, which should serve as the container for the to be created- FlyoutPaletteComposite.
- Returns:
- The FlyoutPaletteCompositeused by thisGraphicalEditorWithFlyoutPalette.
- Since:
- 3.10
 
- 
getAdapterDescription copied from class:GraphicalEditorReturns the adapter for the specified key.IMPORTANT certain requests, such as the property sheet, may be made before or after GraphicalEditor.createPartControl(Composite)is called. The order is unspecified by the Workbench.- Specified by:
- getAdapterin interface- IAdaptable
- Overrides:
- getAdapterin class- GraphicalEditor
- See Also:
 
- 
getGraphicalControl- Returns:
- the graphical viewer's control
 
- 
getPalettePreferencesBy default, this method returns a FlyoutPreferences object that stores the flyout settings in the GEF plugin. Sub-classes may override.- Returns:
- the FlyoutPreferences object used to save the flyout palette's preferences
 
- 
getPaletteRootReturns the PaletteRoot for the palette viewer.- Returns:
- the palette root
 
- 
getPaletteViewerProviderReturns the palette viewer provider that is used to create palettes for the view and the flyout. Creates one if it doesn't already exist.- Returns:
- the PaletteViewerProvider that can be used to create PaletteViewers for this editor
- See Also:
 
- 
setEditDomainSets the edit domain for this editor.- Overrides:
- setEditDomainin class- GraphicalEditor
- Parameters:
- ed- The new EditDomain
 
 
-