|
Eclipse GEF 3.8.0.201206112118 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.gef.editparts.AbstractEditPart
org.eclipse.gef.editparts.AbstractGraphicalEditPart
org.eclipse.gef.editparts.SimpleRootEditPart
org.eclipse.gef.editparts.FreeformGraphicalRootEditPart
public class FreeformGraphicalRootEditPart
A graphical root that uses FreeformFigures
as the layers in the diagram. The
contents
editpart must provide a
FreeformFigure as its figure. Freeform figures are special because they can
expand in any direction. This allows the user to drag objects or bendpoints
into the negative X and Y coordinates of a diagram. If this feature is not
being used, clients should use the FreeformGraphicalRootEditPart
as
their viewer's root editpart.
IMPORTANT: The contents editpart that is added to a freeform root
should have a FreeformFigure
(such as FreeformLayer) as its
Figure. The primary layer is not using a draw2d LayoutManager, and
will not size the contents' figure properly unless it is a freeform figure.
IMPORTANT:The freeform root uses a FreeformViewport
as
its primary figure. This class must be used with the
ScrollingGraphicalViewer
. The viewport gets
installed into that viewer's FigureCanvas
, which
provides native scrollbars for scrolling the viewport.
This root serves as the diagram's
LayerManager
, providing the following layer
structure, in top-to-bottom order:
Root Freeform Layered Pane | |
├ | Feedback Layer |
├ | Handle Layer |
└ | Printable Layers |
├ Connection Layer | |
└ Primary Layer |
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.eclipse.gef.editparts.AbstractGraphicalEditPart |
---|
AbstractGraphicalEditPart.AccessibleGraphicalEditPart, AbstractGraphicalEditPart.DefaultAccessibleAnchorProvider |
Nested classes/interfaces inherited from class org.eclipse.gef.editparts.AbstractEditPart |
---|
AbstractEditPart.EditPolicyIterator |
Nested classes/interfaces inherited from interface org.eclipse.gef.editparts.LayerManager |
---|
LayerManager.Helper |
Field Summary |
---|
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.LayerConstants |
---|
CONNECTION_LAYER, FEEDBACK_LAYER, GRID_LAYER, GUIDE_LAYER, HANDLE_LAYER, PRIMARY_LAYER, PRINTABLE_LAYERS, SCALABLE_LAYERS, SCALED_FEEDBACK_LAYER |
Fields inherited from interface org.eclipse.gef.editparts.LayerManager |
---|
ID |
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 | |
---|---|
FreeformGraphicalRootEditPart()
|
Method Summary | |
---|---|
protected IFigure |
createFigure()
The default root figure is a figure with a stack layout. |
protected GridLayer |
createGridLayer()
Creates a grid . |
protected void |
createLayers(LayeredPane layeredPane)
Creates the top-most set of layers on the given layered pane. |
protected LayeredPane |
createPrintableLayers()
Creates a layered pane and the layers that should be printed. |
Object |
getAdapter(Class adapter)
Extends AbstractEditPart.getAdapter(Class) to handle additional
adapter types. |
IFigure |
getContentPane()
The contents' Figure will be added to the PRIMARY_LAYER. |
DragTracker |
getDragTracker(Request req)
Should not be called, but returns a MarqeeDragTracker for good measure. |
IFigure |
getLayer(Object key)
Returns the layer indicated by the key. |
Object |
getModel()
The root editpart does not have a real model. |
protected LayeredPane |
getPrintableLayers()
Returns the LayeredPane that should be used during printing. |
protected void |
refreshGridLayer()
Updates the grid based on properties set on the
graphical viewer :
SnapToGrid.PROPERTY_GRID_VISIBLE ,
SnapToGrid.PROPERTY_GRID_SPACING , and
SnapToGrid.PROPERTY_GRID_ORIGIN . |
protected void |
register()
Registers itself in the viewer's various registries. |
protected void |
unregister()
Undoes any registration performed by AbstractEditPart.register() . |
Methods inherited from class org.eclipse.gef.editparts.SimpleRootEditPart |
---|
createEditPolicies, getCommand, getContents, getRoot, getViewer, refreshChildren, setContents, setViewer |
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 |
---|
activate, addEditPartListener, addNotify, deactivate, eraseSourceFeedback, eraseTargetFeedback, getChildren, getEditPolicy, getParent, getSelected, getTargetEditPart, hasFocus, installEditPolicy, isActive, isSelectable, performRequest, refresh, removeEditPartListener, removeEditPolicy, removeNotify, setFocus, setModel, setParent, setSelected, showSourceFeedback, showTargetFeedback, understandsRequest |
Constructor Detail |
---|
public FreeformGraphicalRootEditPart()
Method Detail |
---|
protected IFigure createFigure()
SimpleRootEditPart
createFigure
in class SimpleRootEditPart
AbstractGraphicalEditPart.createFigure()
protected GridLayer createGridLayer()
grid
. Sub-classes can override this method to
customize the appearance of the grid. The grid layer should be the first
layer (i.e., beneath the primary layer) if it is not to cover up parts on
the primary layer. In that case, the primary layer should be transparent
so that the grid is visible.
protected void createLayers(LayeredPane layeredPane)
layeredPane
- the parent for the created layersprotected LayeredPane createPrintableLayers()
PrintGraphicalViewerOperation
public Object getAdapter(Class adapter)
AbstractGraphicalEditPart
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.
getAdapter
in interface IAdaptable
getAdapter
in class AbstractGraphicalEditPart
IAdaptable.getAdapter(java.lang.Class)
public IFigure getContentPane()
getContentPane
in interface GraphicalEditPart
getContentPane
in class AbstractGraphicalEditPart
GraphicalEditPart.getContentPane()
public DragTracker getDragTracker(Request req)
getDragTracker
in interface EditPart
getDragTracker
in class AbstractGraphicalEditPart
req
- a Request
indicating the context of the drag
null
or a DragTrackerEditPart.getDragTracker(org.eclipse.gef.Request)
public IFigure getLayer(Object key)
getLayer
in interface LayerManager
getLayer
in class AbstractGraphicalEditPart
key
- ID of the Layer
null
if it doesn't existLayerManager.getLayer(Object)
public Object getModel()
getModel
in interface EditPart
getModel
in class AbstractEditPart
null
or the primary model objectEditPart.getModel()
protected LayeredPane getPrintableLayers()
LayerConstants.PRINTABLE_LAYERS
.
protected void refreshGridLayer()
grid
based on properties set on the
graphical viewer
:
SnapToGrid.PROPERTY_GRID_VISIBLE
,
SnapToGrid.PROPERTY_GRID_SPACING
, and
SnapToGrid.PROPERTY_GRID_ORIGIN
.
This method is invoked initially when the GridLayer is created, and when any of the above-mentioned properties are changed on the viewer.
protected void register()
AbstractEditPart
register
in class AbstractEditPart
AbstractEditPart.register()
protected void unregister()
AbstractEditPart
AbstractEditPart.register()
. The provided
base classes will correctly unregister their visuals.
unregister
in class AbstractEditPart
AbstractEditPart.unregister()
|
Eclipse GEF 3.8.0.201206112118 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |