Note to non-wiki readers: This documentation is generated from the Eclipse wiki - if you have corrections or additions it would be awesome if you added them in the original wiki page.
The GEF4 MVC component provides support for building up graphical editors and views based on a model-view-controller architecture and is the intended replacement for GEF (MVC) 3.x. It is internally composed out of four modules, which provide toolkit-independent base abstractions and implementations (MVC), JavaFX-specific specializations (MVC.FX), and Eclipse UI-integration for both (MVC.UI, MVC.FX.UI). In addition there is a deployed MVC Logo Example.
- feature: org.eclipse.gef4.mvc
- bundle: org.eclipse.gef4.mvc
The MVC module of GEF4 MVC offers those core concepts that are independent of any concrete rendering toolkit as well as of the Eclipse UI. As indicated by its name, the module provides a model-view-controller architecture that can be used to build up graphical editors and views. In good tradition with GEF (MVC) 3.x, 'controllers' are referred to as 'parts' (while the term 'visual part' instead of 'edit part' is used here, to depict that the MVC framework is not limited to editors alone).
A graphical application is thus composed of one or more viewers, where each viewer (IViewer) is populated by a set of visual parts (IVisualPart), which control the visuals that are rendered inside the viewer's controls. Those visual parts that are responsible of controlling to be visualized contents, are referred to as content parts (IContentPart). They are accompanied by feedback parts (IFeedbackPart) and handle parts (IHandlePart), which do not control visualized contents but feedback or handle visuals that are needed for user interaction. All visual parts are arranged in a hierarchy (which resembles the hierarchy of visuals) that is rooted by a 'root part' (IRootPart).
Besides the parent-child relationship that establishes the hierarchy, visual parts may also be related to each other by means of an anchorage-anchor relationship. That is, a visual part that is placed at an arbitrary location within the hierarchy may be anchored on another anchorage part. As the visual part hierarchy has to correspond to the visual hierarchy, this mechanism is very useful when parts that control visuals that are placed in arbitrary places within the visual hierarchy have to be related to each other. In a graphical application that usually organizes visuals into layers, it can for instance be used to update feedback or handles. By explicitly anchoring a feedback part on an underlying (anchorage) target content part, the feedback part inter alia obtains the necessary hooks to listen for changes of the content part visual (e.g. position changes) and to update its own feedback visual accordingly.
Tools (ITool) are used to interact with the parts inside a viewer. Each tool should be responsible of handling a certain interaction gesture (e.g. mouse click/drag or touch-based pinch/spread), by locating respective target parts (e.g. via hit-testing on the visual) and forwarding the interaction to them. While a tool should not have own interaction logic, it is responsible of handling the interaction, to which several parts may contribute e.g. by updating their visuals and contents, as a whole. That is, the tool has to ensure that all modifying operations that result from a certain interaction, are executed in a single (undoable) transaction. As an interaction may span several viewers (e.g. a drag/drop operation), tools are bound to a domain (IDomain), to which also all viewers that make up a graphical application are bound. The domain maintains a global operation history and facilities to initialize and commit transactions.
The handling of an interaction is not performed directly by the target visual parts themselves, but by respective policies (IPolicy) that are bound to them. A policy is a (passive) strategy that encapsulates a certain undoable logic. The active tool that handles an interaction takes this into account, as it locates target parts also by evaluating their supported policies, and interacts with these (interaction) policies instead of the visual part itself. Each (interaction) policy is related to one or more gestures (e.g. what to do on click/drag) and may thus be accessed by several tools. It may handle the response to an interaction directly, e.g. by manipulating the viewer state (e.g. changing the current selection when the target part gets clicked), or can delegate it to certain (transaction) policies that manipulate the contents as a result of an interaction (and have to do this by means of executing operations within the currently active transaction, the respective interaction tool has opened via the domain).
The viewer state (e.g. the current selection), which might be manipulated as the result of an interaction, is represented by means of dedicated models (e.g. ContentModel or SelectionModel), which are bound to each viewer. As changes to the viewer state, as well as to the visualized contents, may lead to necessary viewer updates as well, behaviors (IBehavior) may be bound to parts similar to policies. In contrast to policies, behaviors are active themselves, that is they will actively listen for changes (e.g. newly added content) and perform a certain. Behaviors are also responsible of creating and disposing respective visual parts as needed (e.g. to update selection feedback as a result of changes to the selection model). In contrast to policies, the reactions performed by behaviors are not executed on the operation history and are thus not undoable.
- package: org.eclipse.gef4.mvc
MvcModule defines methods that register certain default bindings, which can be refined (overridden) by sub-classes. It also defines a couple of (empty) hook methods for bindings that subclasses should define.
- package: org.eclipse.gef4.mvc.behaviors
IBehavior is bound to an IVisualPart, referred to as the host of the behavior. It actively listens to changes (usually of a viewer model like the SelectionModel or ContentModel) that affect its host and encapsulates a (not undoable) reaction to these changes, like showing or hiding feedback or handles. The SelectionBehavior for instance listens to changes of the SelectionModel and generates (or removes) selection feedback and handles in case its host is selected or deselected. To support proper registration of listeners,
IBehavior extends org.eclipse.gef4.common.activate.IActivatable, so it is activated/deactivated by its host whenever the host itself is activated/deactivated. Registering and unregistering listeners can thus be performed during the activation and deactivation respectively.
BehaviorUtils class provides utility methods for establishing/unestablishing anchored-anchorage relations. These methods are used by the AbstractBehavior when adding/removing feedback or handles.
ContentBehavior is listening for ContentModel changes to initiate a content synchronization upon changes. During a content synchronization, the currently active content parts are checked against the current content objects, i.e. content parts are created or removed based on the parent-child and anchored-anchorage relations between the content objects as defined by the content parts.
A content part that is removed is stored in a
ContentPartPool, so that it can be re-used if it is needed later, and does not have to be re-created.
HoverBehavior reacts to HoverModel changes. It can be bound to all content parts that should generate feedback/handles when the mouse hovers the part.
SelectionBehavior reacts to SelectionModel changes. It can be bound to all content parts that should generate feedback/handles when the part is selected.
- package: org.eclipse.gef4.mvc.domain
IDomain represents the collective state of a graphical application, i.e. it is composed of all IViewers and ITools. Additionally, the
IDomain provides an org.eclipse.core.commands.operations.IOperationHistory and org.eclipse.core.commands.operations.IUndoContext, which are used by policies to change the state of the application.
- package: org.eclipse.gef4.mvc.models
The Models package contains all viewer models, i.e. the data constituting a viewer state.
ContentModel stores the viewer's contents, i.e. the data that is processed by your application.
FocusModel stores the IVisualPart with keyboard focus, i.e. the part that will receive all keyboard input.
GridModel stores the viewer's background grid settings:
false, indicates whether the visualization should snap to grid points.
false, indicates whether to show the grid, or not.
false, indicates whether to zoom the grid, or not.
Double, specifies the width of grid cells.
Double, specifies the height of grid cells.
HoverModel stores the currently hovered IVisualPart.
SelectionModel stores all currently selected IContentParts.
- package: org.eclipse.gef4.mvc.operations
ITransactionalOperation is a specialization of org.eclipse.core.commands.operations.IUndoableOperation, which further supports querying for content relevance and effect of the encapsulated operation.
AbstractCompositeOperation is the base class for two concrete org.eclipse.core.commands.operations.ICompositeOperation implementations: ForwardUndoCompositeOperation and ReverseUndoCompositeOperation.
This operation is the counterpart of the RemoveContentChildOperation.
This operation is the counterpart of the DetachFromContentAnchorageOperation.
BendContentOperation allows to bend the content of an BendableContentPart.
ChangeContentsOperation allows to exchange the contents hold by the ContentModel.
ChangeFocusOperation can be used to set the currently focused part by manipulating the FocusModel.
DeselectOperation can be used to clear the currently selected parts by manipulating the SelectionModel.
This operation is the counterpart of the AttachToContentAnchorageOperation.
ForwardUndoCompositeOperation is a specific AbstractCompositeOperation. It will
undo() its operations in the order they were added to the composite operation.
This operation is the counterpart of the AddContentChildOperation.
ResizeContentOperation allows to resize the contents of an ResizableContentPart.
ReverseUndoCompositeOperation is a specific AbstractCompositeOperation. It will
redo() its operations in the order they were added to the composite operation, however it will
undo() its operations in reverse order.
SelectOperation can be used to manipulate the currently selected parts by manipulating the SelectionModel.
SetRefreshVisualOperation can be used to enable/disable the
#refreshVisual() method for a specific IVisualPart.
TransformContentOperation can be used to transform the content of an ITransformableContentPart.
- package: org.eclipse.gef4.mvc.parts
The Parts package contains all abstractions related to controllers (aka parts) in a model-view-controller architecture. For each abstraction, a corresponding (abstract) realization is provided, from which specific controllers can be sub-classed.
IVisualPart interface is the main MVC abstraction for controller objects, and therefore, controls a visual and handles user interaction. Visual parts are organized in a hierarchy, i.e. every part (except the root part) is associated with a parent part, and can control a number of children parts. Additional to the parent-child relations, visual parts can be part of anchored-anchorage relations, which are independent to the hierarchy, i.e. anchoreds and anchorages can be located at arbitrary places within the hierarchy.
Visual parts are adaptable, so that you can adapt policies and behaviors to them (as well as anything else if needed). This is an integral part of user interaction, because the tools will delegate input events to corresponding policies of the visual part which controls the event target (visual). Visual parts are also activatable. During activation/deactivation they will activate/deactivate their adapters.
IVisualPart exposes observable properties for:
"active": This visual part was activated/deactivated.
"adapters": The adapters (policies, behaviors, etc.) of this visual part changed.
"parent": The parent of this visual part changed.
"children": The children of this visual part changed.
"anchorages": The anchorages of this visual part changed.
"anchoreds": The anchoreds of this visual part changed.
IRootPart interface is a specialization of the IVisualPart interface. There is exactly one
IRootPart per IViewer. It contains all IContentParts, IFeedbackParts, and IHandleParts as children and manages the root visuals.
IContentPart interface is a specialization of the IVisualPart interface. Content parts are bound to content model elements, i.e. they provide a link to the model, and allow manipulations of the model via
IFeedbackPart interface is a specialization of the IVisualPart interface. Feedback parts are used to give visual feedback to the user during interactions. They are usually rendered on top of the content parts.
IHandlePart interface is a specialization of the IVisualPart interface. Handle parts are used for visual handles, which can be used for interaction, i.e. to manipulate elements. They are usually rendered on top of the feedback parts.
IContentPartFactory interface is part of a default mechanic in MVC: It is used during the content synchronization within the ContentBehavior to create new content parts. Therefore, if you want to use this default mechanic, you have to supply an
IContentPartFactory suitable to your content model.
ITransformableContentPart interface is to be implemented by IContentParts, which support transformations of their content. This is e.g. used to persist a translate operation.
IResizableContentPart interface is to be implemented by IContentParts, which support resize of their content. This is e.g. used to persist a resize operation.
IBendableContentPart interface is to be implemented by IContentParts, which support bending of their content (i.e. manipulation throw inserting or moving of bend points). This is e.g. used to persist a bend operation.
IFeedbackPartFactory interface is part of a default mechanic in MVC: It is used for creating feedback parts within the default behaviors, i.e. in response to mouse hover or selection changes.
IHandlePartFactory interface is part of a default mechanic in MVC: It is used for creating handle parts within the default behaviors, i.e. in response to mouse hover or selection changes.
PartUtils class is a collection of utility methods when working with visual parts.
- package: org.eclipse.gef4.mvc.policies
The Policies package contains the IPolicy abstraction, a related abstract base implementation (AbstractPolicy), and concrete implementations for the manipulation of the ContentModel, namely ContentPolicy, CreationPolicy, and DeletionPolicy.
IPolicy is bound to an IVisualPart, referred to as the host of the policy. There are basically two kinds of policies, interaction and transaction policies. An interaction policy is called by a ITool to handle part of an interaction (e.g. click, drag). A transaction policy is one that may be used by other (interaction or transaction) policies to actually perform a visual or semantic operation (e.g. create model element). It has to encapsulate the to be performed operation as an ITransactionalOperation.
IPolicy is similar to an IBehavior in that it is bound to an IVisualPart. However, behaviors are active by themselves (they actively listen to changes), while policies are always called from the outside (they are passive). Further, the response of an
IPolicy is meant to be undoable, whereas the response of an IBehavior is not.
AbstractTransactionPolicy is the base class for all policies that perform undoable changes. The offer
rollback(), which enclose an undoable transaction.
AbstractInteractionPolicy is the base class for all policies that response to an interaction gesture. They usually delegate to some transactional policies to perform a visual or content relevant reaction.
ContentPolicy is an AbstractTransactionPolicy to handle content changes, i.e. adding/removing of content children, as well as attaching/detaching to/from content anchorages. Therefore, it can be used to retrieve an operation which performs the desired content changes.
CreationPolicy is an AbstractTransactionPolicy that handles the creation of new content objects using the ContentPolicy. Therefore, it can be used to retrieve an operation which performs the desired creations.
DeletionPolicy is an AbstractTransactionPolicy that handles the deletion of existing content objects using the ContentPolicy. Therefore, it can be used to retrieve an operation which performs the desired deletions.
- package: org.eclipse.gef4.mvc.tools
ITool delegates input events to corresponding (interaction) IPolicies, which are responsible of handling the interaction.
- package: org.eclipse.gef4.mvc.viewer
- feature: org.eclipse.gef4.mvc.fx
- bundle: org.eclipse.gef4.mvc.fx
- package: org.eclipse.gef4.mvc.fx
MvcFxModule extends MvcModule. It defines methods to register bindings for the JavaFX-specific extensions to MVC (FXDomain, FXViewer, etc.), which can be refined (overridden) by sub-classes. Additionally, it registers the following bindings per default:
- AbstractFXContentPart adapter bindings: FXTransformProvider, ContentBehavior, HoverBehavior, SelectionBehavior, FXFocusBehavior, and ContentPolicy.
- AbstractFXHandlePart adapter bindings: FXHoverOnHoverPolicy and HoverBehavior.
- FXDomain adapter bindings: FXHoverTool, FXClickDragTool, FXTypeTool, FXRotateTool, FXPinchSpreadTool, FXScrollTool, and FXFocusTool.
- FXRootPart adapter bindings: FXFocusAndSelectOnClickPolicy, FXMarqueeOnDragPolicy, FXHoverOnHoverPolicy, FXZoomOnScrollPolicy, FXZoomOnPinchSpreadPolicy, FXPanOnScrollPolicy, FXDeleteSelectedOnTypePolicy, FXPanOnTypePolicy, FXRotateSelectedOnRotatePolicy, FXChangeViewportPolicy, ContentBehavior, SelectionBehavior, FXGridBehavior, and FXViewportBehavior.
- FXViewer adapter bindings: IRootPart, FocusModel, HoverModel, and SelectionModel.
- package: org.eclipse.gef4.mvc.fx.behaviors
FXConnectionClickableAreaBehavior controls the size of the connection's curve node visible area dependent on the zoom level.
FXFocusBehavior is listening for FocusModel changes and transfers them over to JavaFX.
FXHoverBehavior is listening for HoverModel changes in order to generate feedback/handles when hovering a part.
- package: org.eclipse.gef4.mvc.fx.domain
FXDomain parameterizes the AbstractDomain with javafx.scene.Node, but does not extend it further. It is basically intended to provide a target for adapter bindings and adapter scoping (see GEF4 Common).
- package: org.eclipse.gef4.mvc.fx.operations
FXBendConnectionOperation can be used to manipulate the points constituting an Connection, i.e. its start point, way points, and end point. When manipulating the start or end point, it does also connect it to the IVisualPart under mouse when applicable.
FXChangeViewportOperation can be used to manipulate the ViewportModel, i.e. the scroll offset and content transformation.
FXResizeOperation can be used to resize a javafx.scene.Node.
- package: org.eclipse.gef4.mvc.fx.parts
AbstractFXContentPart is a specialization of the AbstractContentPart which establishes javafx.scene.Node as the visual root type. It does also register its whole visual hierarchy at the visual-part-map.
AbstractFXFeedbackPart, FXHoverFeedbackPart, FXSelectionFeedbackPart, FXSelectionLinkFeedbackPart
AbstractFXFeedbackPart is a specialization of the AbstractFeedbackPart which establishes javafx.scene.Node as the visual root type. It does also register a org.eclipse.gef4.fx.listeners.VisualChangeListener upon attachment to an anchorage which refreshes the feedback visual upon anchorage visual changes.
FXHoverFeedbackPart displays a feedback geometry in response to HoverModel changes.
FXDefaultFocusFeedbackPartFactory, FXDefaultHoverFeebackPartFactory, FXDefaultSelectionFeedbackPartFactory
FXSelectionLinkFeedbackPart for generating feedback if the associated geometry provider is bound as an adapter on the hovered/selected part.
AbstractFXHandlePart, AbstractFXSegmentHandlePart, FXCircleSegmentHandlePart, FXRectangleSegmentHandlePart
AbstractFXHandlePart is a specialization of the AbstractHandlePart which establishes javafx.scene.Node as the visual root type. It does also register a org.eclipse.gef4.fx.listeners.VisualChangeListener upon attachment to an anchorage which refreshes the handle visual upon anchorage visual changes.
AbstractFXSegmentHandlePart is a specialization of the
AbstractFXHandlePart which is bound to a segment of a poly-bezier handle geometry, represented by an array of BezierCurves. A segment index identifies that segment (0, 1, 2, ...). A segment parameter specifies the position of this handle part on the segment (0 = start, 0.5 = mid, 1 = end).
FXCircleSegmentHandlePart is a specialization of the
AbstractFXSegmentHandlePart which uses a javafx.scene.shape.Circle for the handle visualization.
FXRectangleSegmentHandlePart is a specialization of the
AbstractFXSegmentHandlePart which uses a javafx.scene.shape.Rectangle for the handle visualization.
AbstractFXRootPart is a specialization of the AbstractRootPart which establishes javafx.scene.Node as the visual root type. It does also register the part as soon as a link to the IViewer is obtained.
FXSquareSegmentHandlePart for generating handles if the associated geometry provider is bound as an adapter on the hovered/selected part.
FXRootPart provides a content layer, a feedback layer, and a handle layer in which the visuals of the corresponding parts are displayed. The feedback layer is above the content layer, and the handle layer is above the feedback layer.
- package: org.eclipse.gef4.mvc.fx.policies
The Policies package contains all IPolicy implementations contributed by MVC.FX. These can be divided into transactional policies, which can be used to generate an operation that performs certain changes, and interaction policies, which are associated with certain user interactions (mouse click/drag, touch pinch/spread, etc.).
IFXOnClickPolicy is called upon mouse click events by the FXClickDragTool. You can use it as an adapter on any IVisualPart for which mouse click interaction is desired, and you can also register multiple instances of
AbstractFXOnClickPolicy on the same IVisualPart (with different adapter roles).
IFXOnDragPolicy, FXMarqueeOnDragPolicy, FXRelocateOnDragPolicy, FXBendOnSegmentDragPolicy, FXNormalizeConnectedOnDragPolicy
AbstractFXOnDragPolicy is called during a mouse press-drag-release gesture by the FXClickDragTool. You can use it as an adapter on any IVisualPart for which mouse drag interaction is desired, and you can also register multiple instances of
AbstractFXOnDragPolicy on the same IVisualPart (with different adapter roles).
FXMarqueeOnDragPolicy can be used to span a marquee selection area using mouse drag to select multiple parts at once.
FXRelocateOnDragPolicy relocates its host visual using the host's FXTransformPolicy when the host visual is dragged with the mouse.
FXBendFirstAnchorageOnSegmentHandleDragPolicy, FXResizeTransformSelectedOnHandleDragPolicy, FXRotateSelectedOnHandleDragPolicy, FXResizeTransformFirstAnchorageOnHandleDragPolicy
FXBendOnSegmentHandleDragPolicy is an
AbstractFXOnDragPolicy which can be applied to FXSegmentHandlePart. It uses the FXBendPolicy to manipulate the org.eclipse.gef4.fx.nodes.FXConnection visual of the first anchorage of the host FXSegmentHandlePart.
FXScaleRelocateOnHandleDragPolicy scales and relocates the visual of its host on mouse drag.
AbstractFXOnHoverPolicy is called upon mouse hover by the FXHoverTool. You can use it as an adapter on any IVisualPart for which mouse hover interaction is desired, and you can also register multiple instances of
AbstractFXOnHoverPolicy on the same IVisualPart (with different adapter roles).
FXHoverOnHoverPolicy hovers the host part upon mouse hover.
AbstractFXOnPinchSpreadPolicy is called during a pinch/spread touch gesture by the FXPinchSpreadTool. You can use it as an adapter on any IVisualPart for which pinch/spread touch interaction is desired, and you can also register multiple instances of
AbstractFXOnPinchSpreadPolicy on the same IVisualPart (with different adapter roles).
AbstractFXOnRotatePolicy is called during a rotate touch gesture by the FXRotateTool. You can use it as an adapter on any IVisualPart for which rotate touch interaction is desired, and you can also register multiple instances of
AbstractFXOnRotatePolicy on the same IVisualPart (with different adapter roles).
IFXOnScrollPolicy, FXPanOnScrollPolicy, FXZoomOnScrollPolicy
AbstractFXOnScrollPolicy is called upon mouse wheel scrolling or during a touch scroll gesture by the FXScrollTool. You can use it as an adapter on any IVisualPart for which scroll interaction is desired, and you can also register multiple instances of
AbstractFXOnScrollPolicy on the same IVisualPart (with different adapter roles).
FXPanOnScrollPolicy changes the scroll offset of the ViewportModel upon mouse/touch scroll events. The scroll direction is inverted when holding the <Shift> key.
IFXOnTypePolicy, FXDeleteSelectedOnTypePolicy, FXPanOnTypePolicy, FXSelectFocusedOnTypePolicy, FXTraverseFocusOnTypePolicy
AbstractFXOnTypePolicy is called upon key presses and releases by the FXTypeTool. You can use it as an adapter on any IVisualPart for which keyboard interaction is desired, and you can also register multiple instances of
AbstractFXOnTypePolicy on the same IVisualPart (with different adapter roles).
FXDeleteSelectedOnTypePolicy is an
AbstractFXOnTypePolicy which deletes the selected parts when pressing the <Delete> key.
FXPanOnTypePolicy changes the scroll offset of the ViewportModel upon arrow key presses.
FXSelectFocusedOnTypePolicy selects/deselects the focus element on (select) key type.
FXTraverseFocusOnTypePolicy traverses the focus element on (tab) key type.
FXTransformPolicy, FXResizePolicy, FXBendPolicy, FXRelocateConnectionPolicy
FXTransformPolicy is a transactional policy that can be used to transform the visual of its host.
FXResizePolicy is a transactional policy that can be used to resize the visual of its host.
FXBendPolicy is a transactional policy that can be used to manipulate the points constituting an org.eclipse.gef4.fx.nodes.FXConnection, i.e. its start point, way points, and end point. When moving a point the policy takes care of:
- Removing overlaid neighbor points.
- Re-adding temporarily removed neighbor points.
- Reconnecting points to the IVisualPart under mouse when applicable.
Per default, the
FXBendPolicy can only be applied to those IVisualParts which use org.eclipse.gef4.fx.nodes.FXConnection as their visual. This can be adjusted by sub-classing and overriding the corresponding
FXRelocateConnectionPolicy is a specialization of
FXTransformPolicy that can be applied to IVisualParts which use org.eclipse.gef4.fx.nodes.FXConnection as their visual. Per default, it transforms only those points of a connection that are not bound to an anchorage.
FXResizeRelocatePolicy, FXRotatePolicy, FXScaleRelocatePolicy
- package: org.eclipse.gef4.mvc.fx.providers
- FXBendPolicy uses a
Provider<IFXAnchor>to find an org.eclipse.gef4.fx.anchors.IFXAnchor for an IVisualPart at which a point of an org.eclipse.gef4.fx.nodes.FXConnection can be attached.
- FXTransformPolicy uses a
Provider<Affine>to transform the visual of an IVisualPart.
- FXDefaultFeedbackPartFactory and FXDefaultHandlePartFactory use a
Provider<IGeometry>to determine the position and shape of feedback and handle visuals.
DefaultAnchorProvider provides an anchor for a given (anchorage) IVisualPart.
FXTransformProvider adds an javafx.scene.transform.Affine to the transforms list of the visual of the part at which it is bound as an adapter. It does also allow access to that javafx.scene.transform.Affine, which is used by several (transaction) policies to perform transformations.
GeometricOutlineProvider, GeometricBoundsProvider, ShapeOutlineProvider, ShapeBoundsProvider
GeometricBoundsProvider return the core geometry and related bounds of the visual of the part to which they are bound as an adapter.
ShapeBoundsProvider do likewise for the visual (shape) outline and bounds.
- package: org.eclipse.gef4.mvc.fx.tools
The Tools package contains JavaFX-specific ITool implementations for different interactions (e.g. mouse drag).
FXClickDragTool registers listeners for mouse click and drag interactions. The target IVisualPart is determined by searching the visual part hierarchy, beginning at the part that controls the visual, which was pressed, until a part is found that supports at least one AbstractFXOnClickPolicy or AbstractFXOnDragPolicy, respectively. In addition, the target part for a specific javafx.event.EventTarget can be specified explicitly to bypass the target part search, as follows:
A target override can be specified at any time, and will be maintained for the current interaction (or the next interaction if the mouse is not pressed, currently). All target overrides are cleared when the mouse is released.
FXFocusTool registers listeners for window focus events and changes the viewer-focused flag in the FocusModel accordingly.
FXHoverTool registers listeners for mouse hover interaction, i.e. mouse enter and mouse exit events for visuals. The target IVisualPart is determined by searching the visual part hierarchy, beginning at the part that controls the visual, which was hovered, until a part is found that supports at least one AbstractFXOnHoverPolicy.
FXPinchSpreadTool registers listeners for touch pinch/spread gesture interaction, i.e. moving two fingers apart or bringing them together (the default zoom gesture on many touch displays). The target IVisualPart is determined by searching the visual part hierarchy, beginning at the part that controls the visual, which was touched, until a part is found that supports at least one AbstractFXOnPinchSpreadPolicy.
FXRotateTool registers listeners for touch rotate gesture interaction, i.e. moving two fingers around each other (or moving one finger around another). The target IVisualPart is determined by searching the visual part hierarchy, beginning at the part that controls the visual, which was touched, until a part is found that supports at least one AbstractFXOnRotatePolicy.
FXScrollTool registers listeners for scroll interaction, which may either be mouse wheel scrolling, or touch scrolling, i.e. dragging two fingers up or down. The target IVisualPart is determined by searching the visual part hierarchy, beginning at the part that controls the visual, which was scrolled or touched, until a part is found that supports at least one AbstractFXOnScrollPolicy.
FXTypeTool registers listeners for keyboard interaction. The currently focused (see FocusModel) IVisualPart is used as the target part for keyboard interaction if it supports at least one AbstractFXOnTypePolicy.
- package: org.eclipse.gef4.mvc.fx.viewer
FXViewer is a JavaFX-specific IViewer implementation. It provides a org.eclipse.gef4.fx.nodes.FXGridLayer and a org.eclipse.gef4.fx.nodes.ScrollPaneEx, which are arranged so that the org.eclipse.gef4.fx.nodes.FXGridLayer is displayed behind the contents of the org.eclipse.gef4.fx.nodes.ScrollPaneEx.
- feature: org.eclipse.gef4.mvc.ui
- bundle: org.eclipse.gef4.mvc.ui
The MVC.UI module of GEF4 MVC provides aspects for an integration into the Eclipse UI:
- Binding the operation history from the Eclipse Workbench.
- An UndoablePropertySheetPage for contribution to the Eclipse 'Properties' view.
- package: org.eclipse.gef4.mvc.ui
MvcUiModule contains bindings for the Eclipse integration. Currently, only a binding for the org.eclipse.core.commands.operations.IOperationHistory of the Eclipse workbench is provided, so that operations executed in the context of an IDomain are undoable/redoable from the Eclipse UI.
- package: org.eclipse.gef4.mvc.ui.parts
ContentSelectionProvider is an implementation of the org.eclipse.jface.viewers.ISelectionProvider interface that provides the content elements of the currently selected IContentParts, and can select IContentParts based on their content elements.
- package: org.eclipse.gef4.mvc.ui.properties
IPropertySheetPageFactory interface allows to implement a factory to create an org.eclipse.ui.views.properties.IPropertySheetPage for an org.eclipse.ui.IWorkbenchPart.
UndoablePropertySheetPage is a org.eclipse.ui.views.properties.PropertySheetPage extension that allows to perform undo/redo of property value changes also in case the viewer/editor is not active.
UndoablePropertySheetEntry provides undo support for changes made to org.eclipse.ui.views.properties.IPropertySource by the Eclipse 'Properties' view. Clients can construct a org.eclipse.ui.views.properties.PropertySheetPage and use this class as the root entry. All changes made to property sources displayed on that page will be done using the provided org.eclipse.core.commands.operations.IOperationHistory.
SetPropertyValueOperation can be used to set or reset the value of a property. It is used by the UndoablePropertySheetEntry.
- feature: org.eclipse.gef4.mvc.fx.ui
- bundle: org.eclipse.gef4.mvc.fx.ui
The MVC.FX.UI module of GEF4 MVC provides JavaFX-specific aspects for an integration into the Eclipse UI.
- package: org.eclipse.gef4.mvc.fx.ui
MvcFxUiModule contains bindings for the JavaFX/Eclipse integration:
- Binding an IFXCanvasFactory for the construction of an javafx.embed.swt.FXCanvas.
- Binding the ISelectionProviderFactory which provides a ContentSelectionProvider.
- package: org.eclipse.gef4.mvc.fx.ui.parts
FXEditorActionBarContributor is an org.eclipse.ui.part.EditorActionBarContributor extension, which lets the undo/redo action group of the corresponding org.eclipse.ui.part.IEditorPart contribute to the action bars.
DeleteActionHandler handles deletion based on the selected IContentParts.
- package: org.eclipse.gef4.mvc.fx.ui.properties
The Properties package provides support for integrating JavaFX-related cell editors into the Eclipse 'Properties' view.
FXPaintPropertyDescriptor is a property descriptor that integrates an FXPaintCellEditor.
Migration from GEF (MVC) 3.x to MVC, MVC.FX, MVC.UI, MVC.FX.UI
GEF4 MVC was written completely from scratch. While some proven concepts have been transferred from GEF (MVC) 3.x, central concepts and mechanisms have been reworked. The most notable differences are:
- More modularity, separating out Eclipse Workbench UI dependencies: While GEF (MVC) 3.x provided a single bundle (with Eclipse UI dependencies), GEF4 MVC clearly separates out those dependencies into the MVC.UI and MVC.FX.UI bundles, so that standalone graphical applications can be realized based on MVC and MVC.FX alone. Furthermore, rendering toolkit independent abstractions (provided by MVC) are now clearly separated from rendering toolkit (i.e. JavaFX) specific concretizations (provided by MVC.FX.
- Usage of JavaFX instead of SWT/Draw2d.
- Usage of adapter pattern throughout: While GEF (MVC) 3.x only used the Eclipse Platform provided adaptable pattern for Eclipse Workbench UI integration tasks (e.g. integration with properties view), this mechanism is used intensively within GEF4 MVC to configure the complete graphical application. That is, tools and viewers are adapted to the domain, viewer models and the root part are adapted to the viewer, policies and behaviors are adapted to visual parts.
- Usage of dependency injection
- Own visual parts for feedback and handles (compared to 'lightweight' feedback)
- Separation of policies (passive, invoked by tools) and behaviors (active, listening for changes)
- Separation of interaction policies (directly invoked by tools, related to interaction) and transaction policies (called by interaction policies, realize the content manipulation)
- Pure interaction-gesture-based tools without own transactional logic (compared to monolithic 'selection tool'): In contrast to GEF (MVC) 3.x, where tools were dedicated to certain semantic operations (creation, selection, etc.), tools are now pretty dumb and dedicated to interaction gestures (click/drag, scroll, etc.), and forward all interactions to respective interaction policies. While the tools provides the transactional context (i.e. it opens and closes a respective operation via the domain, so that all operations that are executed as a result of the interaction can be undone together) they do not translate the gesture-based interaction into semantical operations themselves. This responsibility lies with the interaction policies alone. Where a GEF (MVC) 3.x application had thus to specialize one of the default tools to add different semantic behavior, this can now be achieved by registering different interaction policies, which is much more lightweight.