|
GEF (MVC) 3.8.1.201211122107 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.swt.widgets.Widget
org.eclipse.swt.widgets.Control
org.eclipse.swt.widgets.Scrollable
org.eclipse.swt.widgets.Composite
org.eclipse.gef.ui.palette.FlyoutPaletteComposite
public class FlyoutPaletteComposite
The FlyoutPaletteComposite is used to show a flyout palette alongside another control. The flyout palette auto-hides (thus maximizing space) when not in use, but can also be pinned open if so desired. It will only be visible when the PaletteView is not.
Nested Class Summary | |
---|---|
static interface |
FlyoutPaletteComposite.FlyoutPreferences
FlyoutPreferences is used to save/load the preferences for the flyout palette. |
Field Summary | |
---|---|
static int |
STATE_COLLAPSED
One of the two possible initial states of the flyout palette. |
static int |
STATE_PINNED_OPEN
One of the two possible initial states of the flyout palette. |
Fields inherited from class org.eclipse.swt.widgets.Control |
---|
view |
Constructor Summary | |
---|---|
FlyoutPaletteComposite(Composite parent,
int style,
IWorkbenchPage page,
PaletteViewerProvider pvProvider,
FlyoutPaletteComposite.FlyoutPreferences preferences)
Constructor |
Method Summary | |
---|---|
static FlyoutPaletteComposite.FlyoutPreferences |
createFlyoutPreferences(Preferences prefs)
This is a convenient method to get a default FlyoutPreferences object. |
void |
hookDropTargetListener(GraphicalViewer viewer)
This method hooks a DropTargetListener that collapses the flyout patette when the user drags something from the palette and moves the cursor to the primary viewer's control. |
void |
layout(boolean changed)
|
void |
setExternalViewer(PaletteViewer viewer)
If an external palette viewer is provided, palette state (that is captured in PaletteViewer.saveState(IMemento) -- active tool,
drawer expansion state, drawer pin state, etc.) will be maintained when
switching between the two viewers. |
void |
setGraphicalControl(Control graphicalViewer)
Sets the control along the side of which the palette is to be displayed. |
Methods inherited from class org.eclipse.swt.widgets.Composite |
---|
changed, checkSubclass, computeSize, drawBackground, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList |
Methods inherited from class org.eclipse.swt.widgets.Scrollable |
---|
computeTrim, getClientArea, getHorizontalBar, getScrollbarsMode, getVerticalBar |
Methods inherited from class org.eclipse.swt.widgets.Widget |
---|
addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, reskin, setData, setData, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int STATE_COLLAPSED
public static final int STATE_PINNED_OPEN
Constructor Detail |
---|
public FlyoutPaletteComposite(Composite parent, int style, IWorkbenchPage page, PaletteViewerProvider pvProvider, FlyoutPaletteComposite.FlyoutPreferences preferences)
parent
- The parent Compositestyle
- The style of the widget to construct; only SWT.BORDER is
allowedpage
- The current workbench pagepvProvider
- The provider that is to be used to create the flyout palettepreferences
- To save/retrieve the preferences for the flyoutMethod Detail |
---|
public static FlyoutPaletteComposite.FlyoutPreferences createFlyoutPreferences(Preferences prefs)
Preferences
. It's upto the owner plugin to
save
the changes before it
stops
.
prefs
- a plugin's Preferences
public void layout(boolean changed)
layout
in class Composite
Composite.layout(boolean)
public void setExternalViewer(PaletteViewer viewer)
PaletteViewer.saveState(IMemento)
-- active tool,
drawer expansion state, drawer pin state, etc.) will be maintained when
switching between the two viewers. Providing an external viewer, although
recommended, is optional.
viewer
- The palette viewer used in the PaletteViewpublic void setGraphicalControl(Control graphicalViewer)
graphicalViewer
- the control of the graphical viewer; cannot be
null
public void hookDropTargetListener(GraphicalViewer viewer)
viewer
- the primary viewer
|
GEF (MVC) 3.8.1.201211122107 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |