org.eclipse.gef4.mvc.fx.parts

Class FXSelectionFeedbackPart

java.lang.Object

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

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

org.eclipse.gef4.mvc.fx.parts.AbstractFXFeedbackPart<FXGeometryNode<IGeometry>>

org.eclipse.gef4.mvc.fx.parts.FXSelectionFeedbackPart

All Implemented Interfaces:

IActivatable, IAdaptable, IDisposable, IPropertyChangeNotifier, IFeedbackPart<javafx.scene.Node,FXGeometryNode<IGeometry>>, IVisualPart<javafx.scene.Node,FXGeometryNode<IGeometry>>

Direct Known Subclasses:

FXSelectionLinkFeedbackPart

public class FXSelectionFeedbackPart
extends AbstractFXFeedbackPart<FXGeometryNode<IGeometry>>

The FXSelectionFeedbackPart is an AbstractFXFeedbackPart that is parameterized by FXGeometryNode<IGeometry>.

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
static java.lang.String	PRIMARY_FOCUSED_EFFECT_PROVIDER The role name for the Provider<Effect> that will be used to decorate a primary, focused selection.
static java.lang.String	PRIMARY_UNFOCUSED_EFFECT_PROVIDER The role name for the Provider<Effect> that will be used to decorate a primary, unfocused selection.
static java.lang.String	SECONDARY_FOCUSED_EFFECT_PROVIDER The role name for the Provider<Effect> that will be used to decorate a secondary, focused selection.
static java.lang.String	SECONDARY_UNFOCUSED_EFFECT_PROVIDER The role name for the Provider<Effect> that will be used to decorate a secondary, unfocused selection.

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
FXSelectionFeedbackPart() Default constructor.

Method Summary

Modifier and Type	Method and Description
protected FXGeometryNode<IGeometry>	createVisual() Creates this part's visual.
protected void	doActivate() Post AbstractVisualPart.activate() hook that activates this part's children.
protected void	doDeactivate() Pre AbstractVisualPart.deactivate() hook that deactivates this part's children.
void	doRefreshVisual(FXGeometryNode<IGeometry> visual) Refreshes this part's visualization based on this part's content.
protected IGeometry	getFeedbackGeometry() Returns the IGeometry that is provided by this part's feedback geometry provider.
protected javafx.scene.effect.Effect	getPrimarySelectionFeedbackEffect(boolean focused) Returns the Effect that is applied to a primary selection.
protected javafx.scene.effect.Effect	getSecondarySelectionFeedbackEffect(boolean focused) Returns the Effect that is applied to a secondary selection.
void	setGeometryProvider(com.google.inject.Provider<? extends IGeometry> geometryProvider) Sets the feedback geometry provider ( Provider<IGeometry>) of this part to the given value.

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

attachToAnchorageVisual, detachFromAnchorageVisual

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

addChildVisual, removeChildVisual

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, getRoot, getViewer, getVisual, isActive, isRefreshVisual, refreshVisual, register, registerAtVisualPartMap, removeAnchorage, removeAnchorage, removeAnchored, removeChild, removeChildren, removePropertyChangeListener, reorderChild, setAdapter, setAdapter, setAdapter, setAdapters, 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.gef4.mvc.parts.IVisualPart

addAnchorage, addAnchorage, addAnchored, addChild, addChild, addChildren, addChildren, getAnchorages, getAnchoreds, getBehaviors, getChildren, getParent, getPolicies, getRoot, 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

PRIMARY_FOCUSED_EFFECT_PROVIDER

public static final java.lang.String PRIMARY_FOCUSED_EFFECT_PROVIDER

The role name for the Provider<Effect> that will be used to decorate a primary, focused selection.

See Also:

Constant Field Values

PRIMARY_UNFOCUSED_EFFECT_PROVIDER

public static final java.lang.String PRIMARY_UNFOCUSED_EFFECT_PROVIDER

The role name for the Provider<Effect> that will be used to decorate a primary, unfocused selection.

See Also:

Constant Field Values

SECONDARY_FOCUSED_EFFECT_PROVIDER

public static final java.lang.String SECONDARY_FOCUSED_EFFECT_PROVIDER

The role name for the Provider<Effect> that will be used to decorate a secondary, focused selection.

See Also:

Constant Field Values

SECONDARY_UNFOCUSED_EFFECT_PROVIDER

public static final java.lang.String SECONDARY_UNFOCUSED_EFFECT_PROVIDER

The role name for the Provider<Effect> that will be used to decorate a secondary, unfocused selection.

See Also:

Constant Field Values

Constructor Detail

FXSelectionFeedbackPart

public FXSelectionFeedbackPart()

Default constructor.

Method Detail

createVisual

protected FXGeometryNode<IGeometry> createVisual()

Description copied from class: AbstractVisualPart

Creates this part's visual.

Specified by:

createVisual in class AbstractVisualPart<javafx.scene.Node,FXGeometryNode<IGeometry>>

Returns:

This part's visual.

doActivate

protected void doActivate()

Description copied from class: AbstractVisualPart

Post AbstractVisualPart.activate() hook that activates this part's children.

Overrides:

doActivate in class AbstractVisualPart<javafx.scene.Node,FXGeometryNode<IGeometry>>

doDeactivate

protected void doDeactivate()

Description copied from class: AbstractVisualPart

Pre AbstractVisualPart.deactivate() hook that deactivates this part's children.

Overrides:

doDeactivate in class AbstractVisualPart<javafx.scene.Node,FXGeometryNode<IGeometry>>

doRefreshVisual

public void doRefreshVisual(FXGeometryNode<IGeometry> 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,FXGeometryNode<IGeometry>>

Parameters:

visual - This part's visual.

getFeedbackGeometry

protected IGeometry getFeedbackGeometry()

Returns the IGeometry that is provided by this part's feedback geometry provider.

Returns:

The IGeometry that is provided by this part's feedback geometry provider .

getPrimarySelectionFeedbackEffect

protected javafx.scene.effect.Effect getPrimarySelectionFeedbackEffect(boolean focused)

Returns the Effect that is applied to a primary selection. When an effect provider (either PRIMARY_FOCUSED_EFFECT_PROVIDER or PRIMARY_UNFOCUSED_EFFECT_PROVIDER) is registered on this part's anchorage, the provided Effect is returned. Otherwise, a DropShadow is used.

Parameters:

focused - true if the selection is focused, otherwise false.

Returns:

The Effect that is applied to a primary selection.

getSecondarySelectionFeedbackEffect

protected javafx.scene.effect.Effect getSecondarySelectionFeedbackEffect(boolean focused)

Returns the Effect that is applied to a secondary selection. When an effect provider (either SECONDARY_FOCUSED_EFFECT_PROVIDER or SECONDARY_UNFOCUSED_EFFECT_PROVIDER) is registered on this part's anchorage, the provided Effect is returned. Otherwise, a DropShadow is used.

Parameters:

focused - true if the selection is focused, otherwise false.

Returns:

The Effect that is applied to a primary selection.

setGeometryProvider

public void setGeometryProvider(com.google.inject.Provider<? extends IGeometry> geometryProvider)

Sets the feedback geometry provider ( Provider<IGeometry>) of this part to the given value.

Parameters:

geometryProvider - The new feedback geometry provider for this part.