org.eclipse.gef4.mvc.fx.parts

Class FXRootPart

java.lang.Object

org.eclipse.gef4.mvc.parts.AbstractVisualPart<VR,V>

org.eclipse.gef4.mvc.parts.AbstractRootPart<javafx.scene.Node,N>

org.eclipse.gef4.mvc.fx.parts.AbstractFXRootPart<javafx.scene.Group>

org.eclipse.gef4.mvc.fx.parts.FXRootPart

All Implemented Interfaces:

IActivatable, IAdaptable, IAdaptable.Bound<IViewer<javafx.scene.Node>>, IDisposable, IPropertyChangeNotifier, IRootPart<javafx.scene.Node,javafx.scene.Group>, IVisualPart<javafx.scene.Node,javafx.scene.Group>

public class FXRootPart
extends AbstractFXRootPart<javafx.scene.Group>

The FXRootPart is an AbstractFXRootPart that is parameterized by Group. It manages a number of layers for the visualization, namely, the content layer, feedback layer, and handle layer. The visuals of the different IVisualParts are inserted into these layers depending on their type, i.e. IContentPart visuals are inserted into the content layer, IFeedbackPart visuals are inserted into the feedback layer, and IHandlePart visuals are inserted into the handle layer.

The layers are stacked on top of each other with the content layer at the bottom and the handle layer at the top. The feedback layer in the middle is mouse transparent, i.e. you cannot interact with the visuals in this layer.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.gef4.common.adapt.IAdaptable

IAdaptable.Bound<A extends IAdaptable>

Field Summary

Fields

Modifier and Type	Field and Description
javafx.scene.Group	contentLayer The content layer visual.
javafx.scene.Group	feedbackLayer The feedback layer visual.
javafx.scene.Group	handleLayer The handle layer visual.

Fields inherited from class org.eclipse.gef4.mvc.parts.AbstractVisualPart

pcs

Fields inherited from interface org.eclipse.gef4.mvc.parts.IVisualPart

ANCHORAGES_PROPERTY, ANCHOREDS_PROPERTY, CHILDREN_PROPERTY, PARENT_PROPERTY

Fields inherited from interface org.eclipse.gef4.common.adapt.IAdaptable

ADAPTERS_PROPERTY

Fields inherited from interface org.eclipse.gef4.common.activate.IActivatable

ACTIVE_PROPERTY

Constructor Summary

Constructors

Constructor and Description
FXRootPart() Default constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addChildVisual(IVisualPart<javafx.scene.Node,? extends javafx.scene.Node> child, int index) Performs the addition of the child's visual to this IVisualPart's visual.
protected javafx.scene.Group	createContentLayer() Creates the content layer visual.
protected javafx.scene.Group	createFeedbackLayer() Creates the feedback layer visual.
protected javafx.scene.Group	createHandleLayer() Creates the handle layer visual.
protected javafx.scene.Group	createLayer(boolean mouseTransparent) Creates a Group and sets its Node.pickOnBoundsProperty() to false.
protected javafx.scene.Group	createScrollPaneContent(javafx.scene.Node... layers) Creates a Group which contains the given Nodes.
protected javafx.scene.Group	createVisual() Creates this part's visual.
void	doRefreshVisual(javafx.scene.Group visual) Refreshes this part's visualization based on this part's content.
protected javafx.scene.Group	getContentLayer() Returns the content layer visual.
protected javafx.scene.Group	getFeedbackLayer() Returns the feedback layer visual.
protected javafx.scene.Group	getHandleLayer() Returns the handle layer visual.
protected void	registerAtVisualPartMap(IViewer<javafx.scene.Node> viewer, javafx.scene.Group visual) Registers this part for the given visual in the visual-part-map of the given IViewer.
protected void	removeChildVisual(IVisualPart<javafx.scene.Node,? extends javafx.scene.Node> child, int index) Removes the child's visual from this IVisualPart's visual.
protected void	unregisterFromVisualPartMap(IViewer<javafx.scene.Node> viewer, javafx.scene.Group visual) Removes the given visual from the visual-part-map of the given viewer.

Methods inherited from class org.eclipse.gef4.mvc.fx.parts.AbstractFXRootPart

getViewer, setAdaptable

Methods inherited from class org.eclipse.gef4.mvc.parts.AbstractRootPart

attachToAnchorageVisual, detachFromAnchorageVisual, doActivate, doDeactivate, getAdaptable, getContentPartChildren, getFeedbackPartChildren, getHandlePartChildren, getRoot

Methods inherited from class org.eclipse.gef4.mvc.parts.AbstractVisualPart

activate, addAnchorage, addAnchorage, addAnchored, addChild, addChild, addChildren, addChildren, addPropertyChangeListener, deactivate, dispose, getAdapter, getAdapter, getAdapter, getAdapters, getAdapters, getAnchorages, getAnchoreds, getBehaviors, getChildren, getParent, getPolicies, getVisual, isActive, isRefreshVisual, refreshVisual, register, removeAnchorage, removeAnchorage, removeAnchored, removeChild, removeChildren, removePropertyChangeListener, reorderChild, setAdapter, setAdapter, setAdapter, setAdapters, setParent, setRefreshVisual, unregister, unsetAdapter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.gef4.mvc.parts.IVisualPart

addAnchorage, addAnchorage, addAnchored, addChild, addChild, addChildren, addChildren, getAnchorages, getAnchoreds, getBehaviors, getChildren, getParent, getPolicies, getVisual, isRefreshVisual, refreshVisual, removeAnchorage, removeAnchorage, removeAnchored, removeChild, removeChildren, reorderChild, setParent, setRefreshVisual

Methods inherited from interface org.eclipse.gef4.common.adapt.IAdaptable

getAdapter, getAdapter, getAdapter, getAdapters, getAdapters, setAdapter, setAdapter, setAdapter, unsetAdapter

Methods inherited from interface org.eclipse.gef4.common.activate.IActivatable

activate, deactivate, isActive

Methods inherited from interface org.eclipse.gef4.common.properties.IPropertyChangeNotifier

addPropertyChangeListener, removePropertyChangeListener

Methods inherited from interface org.eclipse.gef4.common.dispose.IDisposable

dispose

Field Detail

contentLayer

public javafx.scene.Group contentLayer

The content layer visual.

handleLayer

public javafx.scene.Group handleLayer

The handle layer visual.

feedbackLayer

public javafx.scene.Group feedbackLayer

The feedback layer visual.

Constructor Detail

FXRootPart

public FXRootPart()

Default constructor.

Method Detail

addChildVisual

protected void addChildVisual(IVisualPart<javafx.scene.Node,? extends javafx.scene.Node> child,
                              int index)

Description copied from class: AbstractVisualPart

Performs the addition of the child's visual to this IVisualPart's visual.

Overrides:

addChildVisual in class AbstractVisualPart<javafx.scene.Node,javafx.scene.Group>

Parameters:

child - The IVisualPart being added

index - The child's position

See Also:

AbstractVisualPart.addChild(IVisualPart, int)

createContentLayer

protected javafx.scene.Group createContentLayer()

Creates the content layer visual.

Returns:

The content layer visual.

createFeedbackLayer

protected javafx.scene.Group createFeedbackLayer()

Creates the feedback layer visual.

Returns:

The feedback layer visual.

createHandleLayer

protected javafx.scene.Group createHandleLayer()

Creates the handle layer visual.

Returns:

The handle layer visual.

createLayer

protected javafx.scene.Group createLayer(boolean mouseTransparent)

Creates a Group and sets its Node.pickOnBoundsProperty() to false. Does also set its Node.mouseTransparentProperty() to the given value.

Parameters:

mouseTransparent - The value for the layer's Node.mouseTransparentProperty().

Returns:

The created layer.

createScrollPaneContent

protected javafx.scene.Group createScrollPaneContent(javafx.scene.Node... layers)

Creates a Group which contains the given Nodes.

Parameters:

layers - The Nodes which are put into the new Group.

Returns:

The created Group.

createVisual

protected javafx.scene.Group createVisual()

Description copied from class: AbstractVisualPart

Creates this part's visual.

Specified by:

createVisual in class AbstractVisualPart<javafx.scene.Node,javafx.scene.Group>

Returns:

This part's visual.

doRefreshVisual

public void doRefreshVisual(javafx.scene.Group visual)

Description copied from class: AbstractVisualPart

Refreshes this part's visualization based on this part's content.

Specified by:

doRefreshVisual in class AbstractVisualPart<javafx.scene.Node,javafx.scene.Group>

Parameters:

visual - This part's visual.

getContentLayer

protected javafx.scene.Group getContentLayer()

Returns the content layer visual. The content layer visual is created in case it was not created before.

Returns:

The content layer visual.

See Also:

createContentLayer()

getFeedbackLayer

protected javafx.scene.Group getFeedbackLayer()

Returns the feedback layer visual. The feedback layer visual is created in case it was not created before.

Returns:

The feedback layer visual.

See Also:

createFeedbackLayer()

getHandleLayer

protected javafx.scene.Group getHandleLayer()

Returns the handle layer visual. The handle layer visual is created in case it was not created before.

Returns:

The handle layer visual.

See Also:

createHandleLayer()

registerAtVisualPartMap

protected void registerAtVisualPartMap(IViewer<javafx.scene.Node> viewer,
                                       javafx.scene.Group visual)

Description copied from class: AbstractVisualPart

Registers this part for the given visual in the visual-part-map of the given IViewer.

Overrides:

registerAtVisualPartMap in class AbstractVisualPart<javafx.scene.Node,javafx.scene.Group>

Parameters:

viewer - The IViewer of which the visual-part-map is extended.

visual - The visual for which this part is registered in the viewer's visual-part-map.

removeChildVisual

protected void removeChildVisual(IVisualPart<javafx.scene.Node,? extends javafx.scene.Node> child,
                                 int index)

Description copied from class: AbstractVisualPart

Removes the child's visual from this IVisualPart's visual.

Overrides:

removeChildVisual in class AbstractVisualPart<javafx.scene.Node,javafx.scene.Group>

Parameters:

child - The child IVisualPart.

index - The index of the child whose visual is to be removed.

unregisterFromVisualPartMap

protected void unregisterFromVisualPartMap(IViewer<javafx.scene.Node> viewer,
                                           javafx.scene.Group visual)

Description copied from class: AbstractVisualPart

Removes the given visual from the visual-part-map of the given viewer.

Overrides:

unregisterFromVisualPartMap in class AbstractVisualPart<javafx.scene.Node,javafx.scene.Group>

Parameters:

viewer - The IViewer of which the visual-part-map is changed.

visual - The visual which is removed from the visual-part-map.