Eclipse GEF
3.0.1

org.eclipse.gef.ui.palette
Interface FlyoutPaletteComposite.FlyoutPreferences

Enclosing interface:
FlyoutPaletteComposite

public static interface FlyoutPaletteComposite.FlyoutPreferences

FlyoutPreferences is used to save/load the preferences for the flyout palette.

Since:
3.0

Method Summary
 int getDockLocation()
          When there is no saved dock location, this method can return any int (preferrably a non-positive int).
 int getPaletteState()
          When there is no saved state, this method can return any non-positive int.
 int getPaletteWidth()
          When there is no saved width, this method can return any int (preferrably a non-positive int).
 void setDockLocation(int location)
          This method is invoked when the flyout palette's dock location is changed.
 void setPaletteState(int state)
          This method is invoked when the flyout palette's default state is changed.
 void setPaletteWidth(int width)
          This method is invoked when the flyout palette is resized.
 

Method Detail

getDockLocation

public int getDockLocation()
When there is no saved dock location, this method can return any int (preferrably a non-positive int).

Returns:
the saved dock location of the Palette

getPaletteState

public int getPaletteState()
When there is no saved state, this method can return any non-positive int. Undesired behaviour is possible if a positve int that coincides with one of the state constants is returned.

Returns:
the saved state of the palette (collapsed or pinned open)

getPaletteWidth

public int getPaletteWidth()
When there is no saved width, this method can return any int (preferrably a non-positive int).

Returns:
the saved width of the flyout palette

setDockLocation

public void setDockLocation(int location)
This method is invoked when the flyout palette's dock location is changed. The provided dock location should be persisted and returned in getDockLocation().

Parameters:
location - an int representing the dock location

setPaletteState

public void setPaletteState(int state)
This method is invoked when the flyout palette's default state is changed. The provided state should be persisted and returned in getPaletteState().

Parameters:
state - an int the state of the flyout palette

setPaletteWidth

public void setPaletteWidth(int width)
This method is invoked when the flyout palette is resized. The provided width should be persisted and returned in getPaletteWidth().

Parameters:
width - the new size of the flyout palette

Eclipse GEF
3.0.1

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