org.eclipse.gef.internal.ui.palette.editparts
Class DrawerEditPart

java.lang.Object
  extended byorg.eclipse.gef.editparts.AbstractEditPart
      extended byorg.eclipse.gef.editparts.AbstractGraphicalEditPart
          extended byorg.eclipse.gef.internal.ui.palette.editparts.PaletteEditPart
              extended byorg.eclipse.gef.internal.ui.palette.editparts.DrawerEditPart
All Implemented Interfaces:
EditPart, java.util.EventListener, GraphicalEditPart, org.eclipse.core.runtime.IAdaptable, java.beans.PropertyChangeListener, RequestConstants

public class DrawerEditPart
extends PaletteEditPart

EditPart for a PaletteDrawer


Nested Class Summary
 
Nested classes inherited from class org.eclipse.gef.internal.ui.palette.editparts.PaletteEditPart
PaletteEditPart.ImageCache
 
Nested classes inherited from class org.eclipse.gef.editparts.AbstractGraphicalEditPart
AbstractGraphicalEditPart.AccessibleGraphicalEditPart, AbstractGraphicalEditPart.DefaultAccessibleAnchorProvider
 
Nested classes inherited from class org.eclipse.gef.editparts.AbstractEditPart
AbstractEditPart.EditPolicyIterator
 
Field Summary
 
Fields inherited from class org.eclipse.gef.internal.ui.palette.editparts.PaletteEditPart
XML_NAME
 
Fields inherited from class org.eclipse.gef.editparts.AbstractGraphicalEditPart
figure, sourceConnections, targetConnections
 
Fields inherited from class org.eclipse.gef.editparts.AbstractEditPart
children, FLAG_ACTIVE, FLAG_FOCUS, MAX_FLAG
 
Fields inherited from interface org.eclipse.gef.EditPart
SELECTED, SELECTED_NONE, SELECTED_PRIMARY
 
Fields inherited from interface org.eclipse.gef.RequestConstants
REQ_ADD, REQ_ALIGN, REQ_ALIGN_CHILDREN, REQ_CLONE, REQ_CONNECTION_END, REQ_CONNECTION_START, REQ_CREATE, REQ_CREATE_BENDPOINT, REQ_DELETE, REQ_DELETE_DEPENDANT, REQ_DIRECT_EDIT, REQ_MOVE, REQ_MOVE_BENDPOINT, REQ_MOVE_CHILDREN, REQ_OPEN, REQ_ORPHAN, REQ_ORPHAN_CHILDREN, REQ_RECONNECT_SOURCE, REQ_RECONNECT_TARGET, REQ_RESIZE, REQ_RESIZE_CHILDREN, REQ_SELECTION, REQ_SELECTION_HOVER
 
Constructor Summary
DrawerEditPart(PaletteDrawer drawer)
          Constructor
 
Method Summary
 boolean canBePinned()
           
protected  AccessibleEditPart createAccessible()
          returns the AccessibleEditPart for this EditPart.
 org.eclipse.draw2d.IFigure createFigure()
          Creates the Figure to be used as this part's visuals.
 java.lang.Object getAdapter(java.lang.Class key)
          Extends AbstractEditPart#getAdapter(Class) to handle additional adapter types.
 org.eclipse.draw2d.IFigure getContentPane()
          If the children's Figures should be
 PaletteDrawer getDrawer()
          Convenience method that provides access to the PaletteDrawer that is the model.
 DrawerFigure getDrawerFigure()
          Convenience method to get the DrawerFigure for the model drawer.
 boolean isExpanded()
          Returns the expansion state of the drawer
 boolean isPinnedOpen()
          Returns true if the drawer is pinned open.
protected  boolean nameNeededInToolTip()
           
protected  void refreshVisuals()
          Refreshes this EditPart's visuals.
protected  void register()
          Registers itself in the viewer's various registries.
 void restoreState(org.eclipse.ui.IMemento memento)
           
 void saveState(org.eclipse.ui.IMemento memento)
           
 void setExpanded(boolean expanded)
          Sets the expansion state of the DrawerFigure
protected  void setImageInFigure(org.eclipse.swt.graphics.Image image)
           
 void setPinnedOpen(boolean pinned)
          Sets the drawer's pinned state to the specified value.
 void setSelected(int value)
           Sets the selected state property to reflect the selection in the EditPartViewer.
protected  void unregister()
          Undoes any registration performed by register().
 
Methods inherited from class org.eclipse.gef.internal.ui.palette.editparts.PaletteEditPart
activate, createEditPolicies, createToolTip, deactivate, getAccessibleEditPart, getDragTracker, getImageCache, getModelChildren, getPaletteEntry, getPreferenceSource, getToolTipFigure, getToolTipText, propertyChange, setImageDescriptor
 
Methods inherited from class org.eclipse.gef.editparts.AbstractGraphicalEditPart
addChildVisual, addNodeListener, addNotify, addSourceConnection, addTargetConnection, createConnection, createOrFindConnection, fireRemovingSourceConnection, fireRemovingTargetConnection, fireSourceConnectionAdded, fireTargetConnectionAdded, getFigure, getLayer, getModelSourceConnections, getModelTargetConnections, getSourceConnections, getTargetConnections, primAddSourceConnection, primAddTargetConnection, primRemoveSourceConnection, primRemoveTargetConnection, refresh, refreshSourceConnections, refreshTargetConnections, registerVisuals, removeChildVisual, removeNodeListener, removeNotify, removeSourceConnection, removeTargetConnection, reorderChild, reorderSourceConnection, reorderTargetConnection, setFigure, setLayoutConstraint, unregisterVisuals
 
Methods inherited from class org.eclipse.gef.editparts.AbstractEditPart
activateEditPolicies, addChild, addEditPartListener, createChild, deactivateEditPolicies, debug, debugFeedback, eraseSourceFeedback, eraseTargetFeedback, fireActivated, fireChildAdded, fireDeactivated, fireRemovingChild, fireSelectionChanged, getChildren, getCommand, getEditPolicy, getEditPolicyIterator, getEventListeners, getFlag, getModel, getParent, getRoot, getSelected, getTargetEditPart, getViewer, hasFocus, installEditPolicy, isActive, isSelectable, performRequest, refreshChildren, registerAccessibility, registerModel, removeChild, removeEditPartListener, removeEditPolicy, setFlag, setFocus, setModel, setParent, showSourceFeedback, showTargetFeedback, toString, understandsRequest, unregisterAccessibility, unregisterModel
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.eclipse.gef.EditPart
addEditPartListener, eraseSourceFeedback, eraseTargetFeedback, getChildren, getCommand, getEditPolicy, getModel, getParent, getRoot, getSelected, getTargetEditPart, getViewer, hasFocus, installEditPolicy, isActive, isSelectable, performRequest, removeEditPartListener, removeEditPolicy, setFocus, setModel, setParent, showSourceFeedback, showTargetFeedback, understandsRequest
 

Constructor Detail

DrawerEditPart

public DrawerEditPart(PaletteDrawer drawer)
Constructor

Parameters:
drawer - The PaletteDrawer that this EditPart is representing
Method Detail

createFigure

public org.eclipse.draw2d.IFigure createFigure()
Description copied from class: AbstractGraphicalEditPart
Creates the Figure to be used as this part's visuals. This is called from AbstractGraphicalEditPart.getFigure() if the figure has not been created.

Specified by:
createFigure in class AbstractGraphicalEditPart
Returns:
a Figure
See Also:
AbstractGraphicalEditPart.createFigure()

getAdapter

public java.lang.Object getAdapter(java.lang.Class key)
Description copied from class: AbstractGraphicalEditPart
Extends AbstractEditPart.getAdapter(Class) to handle additional adapter types. Currently, these types include AccessibleHandleProvider and AccessibleAnchorProvider. Subclasses should extend this method to support additional adapter types, or to replace the default provided adapaters.

Specified by:
getAdapter in interface org.eclipse.core.runtime.IAdaptable
Overrides:
getAdapter in class AbstractGraphicalEditPart
See Also:
IAdaptable.getAdapter(Class)

getDrawer

public PaletteDrawer getDrawer()
Convenience method that provides access to the PaletteDrawer that is the model.

Returns:
The model PaletteDrawer

getDrawerFigure

public DrawerFigure getDrawerFigure()
Convenience method to get the DrawerFigure for the model drawer.

Returns:
The DrawerFigure created in createFigure()

getContentPane

public org.eclipse.draw2d.IFigure getContentPane()
Description copied from class: AbstractGraphicalEditPart
If the children's Figures should be

Specified by:
getContentPane in interface GraphicalEditPart
Overrides:
getContentPane in class AbstractGraphicalEditPart
See Also:
GraphicalEditPart.getContentPane()

isExpanded

public boolean isExpanded()
Returns the expansion state of the drawer

Returns:
true if the drawer is expanded; false otherwise

isPinnedOpen

public boolean isPinnedOpen()
Returns true if the drawer is pinned open.

Returns:
boolean

nameNeededInToolTip

protected boolean nameNeededInToolTip()
Overrides:
nameNeededInToolTip in class PaletteEditPart
See Also:
PaletteEditPart.nameNeededInToolTip()

canBePinned

public boolean canBePinned()
Returns:
true if the DrawerFigure can be pinned open. This is only true when the drawer is expanded and the auto-collapse strategy is PaletteViewerPreferences.COLLAPSE_AS_NEEDED.

createAccessible

protected AccessibleEditPart createAccessible()
Description copied from class: PaletteEditPart
returns the AccessibleEditPart for this EditPart. This method is called lazily from PaletteEditPart.getAccessibleEditPart().

Overrides:
createAccessible in class PaletteEditPart
See Also:
org.eclipse.gef.ui.palette.PaletteEditPart#createAccessible()

refreshVisuals

protected void refreshVisuals()
Description copied from class: AbstractEditPart
Refreshes this EditPart's visuals. This method is called by AbstractEditPart.refresh(), and may also be called in response to notifications from the model. This method does nothing by default. Subclasses may override.

Overrides:
refreshVisuals in class AbstractEditPart
See Also:
AbstractEditPart.refreshVisuals()

register

protected void register()
Description copied from class: AbstractEditPart
Registers itself in the viewer's various registries. If your EditPart has a 1-to-1 relationship with a visual object and a 1-to-1 relationship with a model object, the default implementation should be sufficent.

Overrides:
register in class AbstractEditPart
See Also:
AbstractEditPart.register()

restoreState

public void restoreState(org.eclipse.ui.IMemento memento)
Overrides:
restoreState in class PaletteEditPart

saveState

public void saveState(org.eclipse.ui.IMemento memento)
Overrides:
saveState in class PaletteEditPart

setExpanded

public void setExpanded(boolean expanded)
Sets the expansion state of the DrawerFigure

Parameters:
expanded - true if the drawer is expanded; false otherwise.

setImageInFigure

protected void setImageInFigure(org.eclipse.swt.graphics.Image image)
Overrides:
setImageInFigure in class PaletteEditPart
See Also:
PaletteEditPart.setImageInFigure( Image)

setPinnedOpen

public void setPinnedOpen(boolean pinned)
Sets the drawer's pinned state to the specified value.

Parameters:
pinned - true if the drawer should be pinned when opened

setSelected

public void setSelected(int value)
Description copied from interface: EditPart
Sets the selected state property to reflect the selection in the EditPartViewer. Fires selectedStateChanged(EditPart) to any EditPartListeners. Selection is maintained by the EditPartViewer.

IMPORTANT: This method should only be called by the EditPartViewer.

Specified by:
setSelected in interface EditPart
Overrides:
setSelected in class AbstractEditPart
Parameters:
value - the selected value
See Also:
EditPart.setSelected(int)

unregister

protected void unregister()
Description copied from class: AbstractEditPart
Undoes any registration performed by AbstractEditPart.register(). The provided base classes will correctly unregister their visuals.

Overrides:
unregister in class AbstractEditPart
See Also:
AbstractEditPart.unregister()