org.eclipse.gef.mvc.fx.parts

Class LayeredRootPart

java.lang.Object

org.eclipse.gef.mvc.fx.parts.AbstractVisualPart<Group>

org.eclipse.gef.mvc.fx.parts.LayeredRootPart

All Implemented Interfaces:

IActivatable, IAdaptable, IAdaptable.Bound<IViewer>, IDisposable, IRootPart<Group>, IVisualPart<Group>

public class LayeredRootPart
extends AbstractVisualPart<Group>
implements IRootPart<Group>

The LayeredRootPart is an IRootPart that 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.

Property Summary

Properties inherited from class org.eclipse.gef.mvc.fx.parts.AbstractVisualPart

active, adaptable, adapters, anchoragesUnmodifiable, anchoredsUnmodifiable, childrenUnmodifiable, parent, refreshVisual

Properties inherited from interface org.eclipse.gef.mvc.fx.parts.IVisualPart

anchoragesUnmodifiable, anchoredsUnmodifiable, childrenUnmodifiable, parent, refreshVisual

Properties inherited from interface org.eclipse.gef.common.adapt.IAdaptable

adapters

Properties inherited from interface org.eclipse.gef.common.adapt.IAdaptable.Bound

adaptable

Properties inherited from interface org.eclipse.gef.common.activate.IActivatable

active

Nested Class Summary

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

IAdaptable.Bound<A extends IAdaptable>

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

IAdaptable.Bound.Impl<T extends IAdaptable>

Field Summary

Fields inherited from interface org.eclipse.gef.mvc.fx.parts.IVisualPart

ANCHORAGES_PROPERTY, ANCHOREDS_PROPERTY, CHILDREN_PROPERTY, PARENT_PROPERTY, REFRESH_VISUAL_PROPERTY

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

ADAPTERS_PROPERTY

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

ACTIVE_PROPERTY

Constructor Summary

Constructors

Constructor and Description
LayeredRootPart() Default constructor.

Method Summary

Modifier and Type	Method and Description
protected void	activateChildren() Activates the children of this AbstractVisualPart.
protected Group	createContentLayer() Creates the content layer visual.
protected Group	createFeedbackLayer() Creates the feedback layer visual.
protected Group	createHandleLayer() Creates the handle layer visual.
protected Group	createLayer(boolean mouseTransparent) Creates a Group and sets its Node.pickOnBoundsProperty() to false.
protected void	deactivateChildren() Deactivates the children of this AbstractVisualPart.
protected IViewer	determineViewer(IVisualPart<? extends Node> parent, com.google.common.collect.Multiset<IVisualPart<? extends Node>> anchoreds) Determines the viewer reference via the given parent or any of the given anchoreds.
protected void	doAddChildVisual(IVisualPart<? extends Node> child, int index) Performs the addition of the child's visual to this IVisualPart's visual.
protected void	doAttachToAnchorageVisual(IVisualPart<? extends Node> anchorage, String role) Attaches this part's visual to the visual of the given anchorage.
protected Group	doCreateVisual() Creates this part's visual.
protected void	doDetachFromAnchorageVisual(IVisualPart<? extends Node> anchorage, String role) Detaches this part's visual from the visual of the given anchorage.
protected void	doRefreshVisual(Group visual) Refreshes this part's visualization based on this part's content.
protected void	doRemoveChildVisual(IVisualPart<? extends Node> child, int index) Removes the child's visual from this IVisualPart's visual.
Group	getContentLayer() Returns the content layer visual.
List<IContentPart<? extends Node>>	getContentPartChildren() Returns all children of type IContentPart contained by this IRootPart.
Group	getFeedbackLayer() Returns the feedback layer visual.
List<IFeedbackPart<? extends Node>>	getFeedbackPartChildren() Returns all children of type IFeedbackPart contained by this IRootPart.
Group	getHandleLayer() Returns the handle layer visual.
List<IHandlePart<? extends Node>>	getHandlePartChildren() Returns all children of type IHandlePart contained by this IRootPart.
IRootPart<? extends Node>	getRoot() Returns the IRootPart.

Methods inherited from class org.eclipse.gef.mvc.fx.parts.AbstractVisualPart

activate, activateAdapters, activeProperty, adaptableProperty, adaptersProperty, addChild, addChild, addChildren, addChildren, anchoragesUnmodifiableProperty, anchoredsUnmodifiableProperty, attachAnchored, attachToAnchorage, attachToAnchorage, childrenUnmodifiableProperty, deactivate, deactivateAdapters, detachAnchored, detachFromAnchorage, detachFromAnchorage, dispose, doActivate, doDeactivate, getAdaptable, getAdapter, getAdapter, getAdapter, getAdapterKey, getAdapters, getAdapters, getAdapters, getAnchoragesUnmodifiable, getAnchoredsUnmodifiable, getBehaviors, getChildrenUnmodifiable, getHandlers, getParent, getPolicies, getVisual, isActive, isRefreshVisual, parentProperty, refreshVisual, refreshVisualProperty, register, registerAtVisualPartMap, removeChild, removeChildren, reorderChild, setAdaptable, setAdapter, setAdapter, setAdapter, setAdapter, setParent, setRefreshVisual, unregister, unregisterFromVisualPartMap, 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.gef.mvc.fx.parts.IVisualPart

addChild, addChild, addChildren, addChildren, anchoragesUnmodifiableProperty, anchoredsUnmodifiableProperty, attachAnchored, attachToAnchorage, attachToAnchorage, childrenUnmodifiableProperty, detachAnchored, detachFromAnchorage, detachFromAnchorage, getAnchoragesUnmodifiable, getAnchoredsUnmodifiable, getBehaviors, getChildrenUnmodifiable, getHandlers, getParent, getPolicies, getViewer, getVisual, isRefreshVisual, parentProperty, refreshVisual, refreshVisualProperty, removeChild, removeChildren, reorderChild, setParent, setRefreshVisual

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

adaptersProperty, getAdapter, getAdapter, getAdapter, getAdapterKey, getAdapters, getAdapters, getAdapters, setAdapter, setAdapter, setAdapter, setAdapter, unsetAdapter

Methods inherited from interface org.eclipse.gef.common.adapt.IAdaptable.Bound

adaptableProperty, getAdaptable, setAdaptable

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

activate, activeProperty, deactivate, isActive

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

dispose

Constructor Detail

LayeredRootPart

public LayeredRootPart()

Default constructor.

Method Detail

activateChildren

protected void activateChildren()

Description copied from class: AbstractVisualPart

Activates the children of this AbstractVisualPart.

Overrides:

activateChildren in class AbstractVisualPart<Group>

createContentLayer

protected Group createContentLayer()

Creates the content layer visual.

Returns:

The content layer visual.

createFeedbackLayer

protected Group createFeedbackLayer()

Creates the feedback layer visual.

Returns:

The feedback layer visual.

createHandleLayer

protected Group createHandleLayer()

Creates the handle layer visual.

Returns:

The handle layer visual.

createLayer

protected 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.

deactivateChildren

protected void deactivateChildren()

Description copied from class: AbstractVisualPart

Deactivates the children of this AbstractVisualPart.

Overrides:

deactivateChildren in class AbstractVisualPart<Group>

determineViewer

protected IViewer determineViewer(IVisualPart<? extends Node> parent,
                                  com.google.common.collect.Multiset<IVisualPart<? extends Node>> anchoreds)

Description copied from class: AbstractVisualPart

Determines the viewer reference via the given parent or any of the given anchoreds.

Overrides:

determineViewer in class AbstractVisualPart<Group>

Parameters:

parent - The parent to obtain the viewer from.

anchoreds - The anchoreds to alternatively obtain the viewer from.

Returns:

The viewer, if it could be determined via the parent or any of the anchoreds.

doAddChildVisual

protected void doAddChildVisual(IVisualPart<? extends Node> child,
                                int index)

Description copied from class: AbstractVisualPart

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

Overrides:

doAddChildVisual in class AbstractVisualPart<Group>

Parameters:

child - The IVisualPart being added

index - The child's position

See Also:

AbstractVisualPart.addChild(IVisualPart, int)

doAttachToAnchorageVisual

protected void doAttachToAnchorageVisual(IVisualPart<? extends Node> anchorage,
                                         String role)

Description copied from class: AbstractVisualPart

Attaches this part's visual to the visual of the given anchorage.

Overrides:

doAttachToAnchorageVisual in class AbstractVisualPart<Group>

Parameters:

anchorage - The anchorage IVisualPart.

role - The anchorage role.

doCreateVisual

protected Group doCreateVisual()

Description copied from class: AbstractVisualPart

Creates this part's visual.

Specified by:

doCreateVisual in class AbstractVisualPart<Group>

Returns:

This part's visual.

doDetachFromAnchorageVisual

protected void doDetachFromAnchorageVisual(IVisualPart<? extends Node> anchorage,
                                           String role)

Description copied from class: AbstractVisualPart

Detaches this part's visual from the visual of the given anchorage.

Overrides:

doDetachFromAnchorageVisual in class AbstractVisualPart<Group>

Parameters:

anchorage - The anchorage IVisualPart.

role - The anchorage role.

doRefreshVisual

protected void doRefreshVisual(Group visual)

Description copied from class: AbstractVisualPart

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

Specified by:

doRefreshVisual in class AbstractVisualPart<Group>

Parameters:

visual - This part's visual.

doRemoveChildVisual

protected void doRemoveChildVisual(IVisualPart<? extends Node> child,
                                   int index)

Description copied from class: AbstractVisualPart

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

Overrides:

doRemoveChildVisual in class AbstractVisualPart<Group>

Parameters:

child - The child IVisualPart.

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

getContentLayer

public 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()

getContentPartChildren

public List<IContentPart<? extends Node>> getContentPartChildren()

Description copied from interface: IRootPart

Returns all children of type IContentPart contained by this IRootPart.

Specified by:

getContentPartChildren in interface IRootPart<Group>

Returns:

A list containing all IContentPart children.

getFeedbackLayer

public 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()

getFeedbackPartChildren

public List<IFeedbackPart<? extends Node>> getFeedbackPartChildren()

Description copied from interface: IRootPart

Returns all children of type IFeedbackPart contained by this IRootPart.

Specified by:

getFeedbackPartChildren in interface IRootPart<Group>

Returns:

A list containing all IFeedbackPart children.

getHandleLayer

public 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()

getHandlePartChildren

public List<IHandlePart<? extends Node>> getHandlePartChildren()

Description copied from interface: IRootPart

Returns all children of type IHandlePart contained by this IRootPart.

Specified by:

getHandlePartChildren in interface IRootPart<Group>

Returns:

A list containing all IHandlePart children.

getRoot

public IRootPart<? extends Node> getRoot()

Description copied from interface: IVisualPart

Returns the IRootPart. This method should only be called internally or by helpers such as edit policies. The root can be used to get the viewer.

Specified by:

getRoot in interface IVisualPart<Group>

Overrides:

getRoot in class AbstractVisualPart<Group>

Returns:

null or the IRootPart