|
Eclipse GEF 2.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.eclipse.gef.ui.parts.AbstractEditPartViewer | +--org.eclipse.gef.ui.parts.GraphicalViewerImpl | +--org.eclipse.gef.ui.parts.ScrollingGraphicalViewer | +--org.eclipse.gef.ui.palette.PaletteViewer
Graphical viewer for the GEF palette.
Nested Class Summary |
Nested classes inherited from class org.eclipse.gef.EditPartViewer |
EditPartViewer.Conditional |
Field Summary |
Fields inherited from class org.eclipse.gef.ui.parts.AbstractEditPartViewer |
constantSelection, selection, selectionListeners |
Constructor Summary | |
PaletteViewer()
Constructor |
Method Summary | |
void |
addPaletteListener(PaletteListener paletteListener)
Adds the given PaletteListener as the one to be notified when the active tool on the palette changes. |
protected void |
createDefaultRoot()
Creates the default root editpart. |
void |
enableVerticalScrollbar(boolean value)
Indicates that the palette should scroll using a native vertical scrollbar as opposed to individual lightweight buttons that appear dynamically on each drawer. |
protected void |
fireModeChanged()
Notifies registered listeners of change in the active tool on the palette |
ToolEntry |
getActiveTool()
|
PaletteCustomizer |
getCustomizer()
|
PaletteCustomizerDialog |
getCustomizerDialog()
NOTE: A PaletteCustomizer must be set for this viewer using the setCustomizer(PaletteCustomizer) method before this method is invoked. |
PaletteViewerPreferences |
getPaletteViewerPreferences()
|
protected void |
handleDispose(DisposeEvent e)
Called if and when the Control is disposed. |
protected void |
hookControl()
Extended to tell the lightweight system what its control is. |
boolean |
isExpanded(PaletteDrawer drawer)
Returns true if the given PaletteDrawer is expanded |
boolean |
isPinned(PaletteDrawer drawer)
Returns true if the given PaletteDrawer is pinned |
void |
removePaletteListener(PaletteListener paletteListener)
The given PaletteListener will not be notified of active tool changes in the palette. |
void |
setActiveTool(ToolEntry newMode)
Sets the active entry for this palette. |
void |
setCustomizer(PaletteCustomizer customizer)
Sets the customizer. |
void |
setPaletteRoot(PaletteRoot root)
Sets the root for this palette. |
void |
setPaletteViewerPreferences(PaletteViewerPreferences prefs)
This palette will use the given PaletteViewerPreferences to store all its preferences. |
protected void |
unhookControl()
Called when the control is being set to null , but before it is null. |
Methods inherited from class org.eclipse.gef.ui.parts.ScrollingGraphicalViewer |
createControl, getFigureCanvas, reveal, setRootFigure |
Methods inherited from class org.eclipse.gef.ui.parts.GraphicalViewerImpl |
createLightweightSystem, findHandleAt, findObjectAtExcluding, flush, getEventDispatcher, getLayerManager, getLightweightSystem, getRootFigure, hookDropTarget, registerAccessibleEditPart, setContextMenu, setCursor, setDragSource, setEditDomain, setRootEditPart, setRouteEventsToEditDomain, unregisterAccessibleEditPart |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.eclipse.jface.viewers.ISelectionProvider |
addSelectionChangedListener, getSelection, removeSelectionChangedListener, setSelection |
Constructor Detail |
public PaletteViewer()
Method Detail |
public void addPaletteListener(PaletteListener paletteListener)
paletteListener
- The listener that needs to be notified of active tool
changes on the paletteprotected void createDefaultRoot()
GraphicalViewerImpl
createDefaultRoot
in class GraphicalViewerImpl
GraphicalViewerImpl.createDefaultRoot()
public void enableVerticalScrollbar(boolean value)
false
. Enabling this setting requires additional horizontal
screen space for the scrollbar. Therefore, its use is discouraged.
This setting must be changed prior to calling
ScrollingGraphicalViewer.createControl(Composite)
. After the control is
created, changing this setting will have no effect.
value
- true
if a vertical scrollbar should be displayedprotected void fireModeChanged()
public PaletteCustomizer getCustomizer()
public PaletteCustomizerDialog getCustomizerDialog()
setCustomizer(PaletteCustomizer)
method before this method is invoked.
public ToolEntry getActiveTool()
public PaletteViewerPreferences getPaletteViewerPreferences()
protected void handleDispose(DisposeEvent e)
AbstractEditPartViewer
Control
is disposed. Subclasses may extend this
method to perform additional cleanup.
handleDispose
in class GraphicalViewerImpl
GraphicalViewerImpl.handleDispose(
org.eclipse.swt.events.DisposeEvent)
protected void hookControl()
GraphicalViewerImpl
hookControl
in class GraphicalViewerImpl
GraphicalViewerImpl.hookControl()
public boolean isExpanded(PaletteDrawer drawer)
drawer
- the PaletteDrawer
public boolean isPinned(PaletteDrawer drawer)
drawer
- the PaletteDrawer
public void removePaletteListener(PaletteListener paletteListener)
paletteListener
- the PaletteListener which doesn't want to be notified of
active tool changes in the palette anymorepublic void setCustomizer(PaletteCustomizer customizer)
customizer
- the customizer to be setpublic void setActiveTool(ToolEntry newMode)
newMode
- the ToolEntry whose EditPart has to be set as the active tool
in this palettepublic void setPaletteRoot(PaletteRoot root)
root
- the PaletteRoot for this palettepublic void setPaletteViewerPreferences(PaletteViewerPreferences prefs)
NOTE: This method should be invoked by a client only once (before the first time
getPaletteViewerPreferences()
is invoked). Trying to invoke this method
after that could lead to problems where some preferences would still be stored in the
old preference store.
prefs
- the PaletteViewerPreferences that is to be used to store all the
preferences for this paletteprotected void unhookControl()
AbstractEditPartViewer
null
, but before it is null.
unhookControl
in class AbstractEditPartViewer
AbstractEditPartViewer.unhookControl()
|
Eclipse GEF 2.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |