Package org.eclipse.gef.mvc.fx.behaviors
Class AbstractBehavior
java.lang.Object
org.eclipse.gef.mvc.fx.behaviors.AbstractBehavior
- All Implemented Interfaces:
IActivatable,IAdaptable.Bound<IVisualPart<? extends Node>>,IBehavior
- Direct Known Subclasses:
ConnectionClickableAreaBehavior,ContentBehavior,FocusBehavior,GridBehavior,HoverBehavior,HoverIntentBehavior,RevealPrimarySelectionBehavior,SelectionBehavior,SnappingBehavior
The
AbstractBehavior can be used as a base class for
IBehavior implementations. It implements activation and deactivation
of its adapters, and provides methods for the addition and removal of
feedback and handles, as well as a method that can be used to update the
handles for a given target part.-
Property Summary
PropertiesTypePropertyDescriptionfinal ReadOnlyBooleanPropertyReadOnlyObjectProperty<IVisualPart<? extends Node>> -
Nested Class Summary
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.common.activate.IActivatable
ACTIVE_PROPERTY -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal voidactivate()final ReadOnlyBooleanPropertyReadOnlyObjectProperty<IVisualPart<? extends Node>>protected voidaddAnchoreds(Collection<? extends IVisualPart<? extends Node>> targets, List<? extends IVisualPart<? extends Node>> anchoreds) Adds the given anchoreds as children to the root part and anchors them to the given target parts.protected voidaddAnchoreds(Collection<? extends IVisualPart<? extends Node>> targets, List<? extends IVisualPart<? extends Node>> anchoreds, int insertionIndex) Adds the given anchoreds as children to the root part and anchors them to the given target parts.protected voidaddFeedback(List<? extends IVisualPart<? extends Node>> targets) Adds feedback for the given target parts.protected voidaddFeedback(IVisualPart<? extends Node> target) Adds feedback for the given target part.protected voidaddHandles(List<? extends IVisualPart<? extends Node>> targets) Adds handles for the given target parts.protected voidaddHandles(IVisualPart<? extends Node> target) Adds handles for the given target part.protected voidRemoves all feedback.protected voidRemoves all handles.final voidprotected voidPostactivate()hook that may be overwritten to e.g. register listeners.protected voidPredeactivate()hook that may be overwritten to e.g. unregister listeners.IVisualPart<? extends Node>Gets the value of the property adaptable.protected List<IFeedbackPart<? extends Node>>getFeedback(Collection<? extends IVisualPart<? extends Node>> targets) Returns a list that contains allIHandleParts that were generated for the given target parts by thisIBehavior.protected List<IFeedbackPart<? extends Node>>getFeedback(IVisualPart<? extends Node> target) Returns a list that contains allIHandleParts that were generated for the given target part by thisIBehavior.protected IFeedbackPartFactorygetFeedbackPartFactory(IViewer viewer) Returns theIFeedbackPartFactorythat should be used for feedback creation.protected IFeedbackPartFactorygetFeedbackPartFactory(IViewer viewer, String role) Returns theIFeedbackPartFactorythat is registered as an adapter at the givenIViewerunder the given role.protected Map<Set<IVisualPart<? extends Node>>,List<IFeedbackPart<? extends Node>>> Returns the map that stores the feedback parts per target part set.protected IHandlePartFactorygetHandlePartFactory(IViewer viewer) Returns theIHandlePartFactorythat should be used for handle creation.protected IHandlePartFactorygetHandlePartFactory(IViewer viewer, String role) Returns theIHandlePartFactorythat is registered as an adapter at the givenIViewerunder the given role.protected List<IHandlePart<? extends Node>>getHandles(Collection<? extends IVisualPart<? extends Node>> targets) Returns a list that contains allIHandleParts that were generated for the given target parts by thisIBehavior.protected List<IHandlePart<? extends Node>>getHandles(IVisualPart<? extends Node> target) Returns a list that contains allIHandleParts that were generated for the given target part by thisIBehavior.protected Map<Set<IVisualPart<? extends Node>>,List<IHandlePart<? extends Node>>> Returns the map that stores the handle parts per target part set.IVisualPart<? extends Node>getHost()Returns the hostIVisualPartof thisIBehavior, i.e. the part where this behavior is registered as an adapter.protected booleanhasFeedback(Collection<? extends IVisualPart<? extends Node>> targets) Returnstrueif feedback was added for the given set of target parts, even if no feedback parts were generated for the given set of target parts.protected booleanhasFeedback(IVisualPart<? extends Node> target) Returnstrueif feedback was added for the given target part, even if no feedback parts were generated for the given target part.protected booleanhasHandles(Collection<? extends IVisualPart<? extends Node>> targets) Returnstrueif handles were added for the given set of target parts, even if no handle parts were generated for the given set of target parts.protected booleanhasHandles(IVisualPart<? extends Node> target) Returnstrueif handles were added for the given target part, even if no handle parts were generated for the given target part.final booleanisActive()Gets the value of the property active.protected voidremoveAnchoreds(Collection<? extends IVisualPart<? extends Node>> targets, List<? extends IVisualPart<? extends Node>> anchoreds) Removes the given anchoreds as children from the root part and as anchoreds from the given target parts.protected voidremoveFeedback(Collection<? extends IVisualPart<? extends Node>> targets) Removes feedback for the given targets.protected voidremoveFeedback(Set<? extends IVisualPart<? extends Node>> targetSet) Removes feedback for the given target parts.protected voidremoveFeedback(IVisualPart<? extends Node> target) Removes feedback for the given target.protected voidremoveHandles(Collection<? extends IVisualPart<? extends Node>> targets) Removes handles for the given target parts.protected voidremoveHandles(Set<? extends IVisualPart<? extends Node>> targetSet) Removes handles for the given target parts.protected voidremoveHandles(IVisualPart<? extends Node> target) Removes handles for the given target.voidsetAdaptable(IVisualPart<? extends Node> adaptable) Sets the value of the property adaptable.IHandlePart<? extends Node>updateHandles(List<? extends IVisualPart<? extends Node>> targets, Comparator<IHandlePart<? extends Node>> interactedWithComparator, IHandlePart<? extends Node> interactedWith) Updates the handles of the given targets.IHandlePart<? extends Node>updateHandles(IVisualPart<? extends Node> target, Comparator<IHandlePart<? extends Node>> interactedWithComparator, IHandlePart<? extends Node> interactedWith) Updates the handles of the given target part.
-
Property Details
-
active
- Specified by:
activePropertyin interfaceIActivatable- See Also:
-
adaptable
- Specified by:
adaptablePropertyin interfaceIAdaptable.Bound<IVisualPart<? extends Node>>- See Also:
-
-
Constructor Details
-
AbstractBehavior
public AbstractBehavior()
-
-
Method Details
-
activate
public final void activate()- Specified by:
activatein interfaceIActivatable
-
activeProperty
- Specified by:
activePropertyin interfaceIActivatable- See Also:
-
adaptableProperty
- Specified by:
adaptablePropertyin interfaceIAdaptable.Bound<IVisualPart<? extends Node>>- See Also:
-
addAnchoreds
protected void addAnchoreds(Collection<? extends IVisualPart<? extends Node>> targets, List<? extends IVisualPart<? extends Node>> anchoreds) Adds the given anchoreds as children to the root part and anchors them to the given target parts.- Parameters:
targets- The anchorages for the anchoreds.anchoreds- The anchored (feedback or handle) parts.
-
addAnchoreds
protected void addAnchoreds(Collection<? extends IVisualPart<? extends Node>> targets, List<? extends IVisualPart<? extends Node>> anchoreds, int insertionIndex) Adds the given anchoreds as children to the root part and anchors them to the given target parts. The given index determines the position where the anchoreds are inserted into the children list of the root part. The index can be used to control the z-order.- Parameters:
targets- The target parts.anchoreds- The anchored (feedback or handle) parts.insertionIndex- The insertion index (controlling the z-order).
-
addFeedback
Adds feedback for the given target part.- Parameters:
target- The target part for which to add feedback.
-
addFeedback
Adds feedback for the given target parts.- Parameters:
targets- The target parts for which to add feedback.
-
addHandles
Adds handles for the given target part.- Parameters:
target- The target part for which to add feedback.
-
addHandles
Adds handles for the given target parts.- Parameters:
targets- The target parts for which to add handles.
-
clearFeedback
protected void clearFeedback()Removes all feedback. -
clearHandles
protected void clearHandles()Removes all handles. -
deactivate
public final void deactivate()- Specified by:
deactivatein interfaceIActivatable
-
doActivate
protected void doActivate()Postactivate()hook that may be overwritten to e.g. register listeners. -
doDeactivate
protected void doDeactivate()Predeactivate()hook that may be overwritten to e.g. unregister listeners. -
getAdaptable
Gets the value of the property adaptable.- Specified by:
getAdaptablein interfaceIAdaptable.Bound<IVisualPart<? extends Node>>- Property description:
-
getFeedback
protected List<IFeedbackPart<? extends Node>> getFeedback(Collection<? extends IVisualPart<? extends Node>> targets) Returns a list that contains allIHandleParts that were generated for the given target parts by thisIBehavior. If no handle parts were generated for the given target parts, an empty list is returned.- Parameters:
targets- A collection of target parts.- Returns:
- A list that contains all handle parts that were generated for the given target parts.
-
getFeedback
Returns a list that contains allIHandleParts that were generated for the given target part by thisIBehavior. If no handle parts were generated for the given target part, an empty list is returned.- Parameters:
target- The target part.- Returns:
- A list that contains all handle parts that were generated for the given target part.
-
getFeedbackPartFactory
Returns theIFeedbackPartFactorythat should be used for feedback creation.- Parameters:
viewer- TheIViewerfor which to determine theIFeedbackPartFactoryfor thisIBehavior.- Returns:
- The
IFeedbackPartFactorythat should be used for feedback creation.
-
getFeedbackPartFactory
Returns theIFeedbackPartFactorythat is registered as an adapter at the givenIViewerunder the given role.- Parameters:
viewer- TheIViewerwhere theIFeedbackPartFactoryis registered.role- The role under which theIFeedbackPartFactoryis registered.- Returns:
- The
IFeedbackPartFactorythat is registered as an adapter at the givenIViewerunder the given role.
-
getFeedbackPerTargetSet
protected Map<Set<IVisualPart<? extends Node>>,List<IFeedbackPart<? extends Node>>> getFeedbackPerTargetSet()Returns the map that stores the feedback parts per target part set.- Returns:
- The map that stores the feedback parts per target part set.
-
getHandlePartFactory
Returns theIHandlePartFactorythat should be used for handle creation.- Parameters:
viewer- TheIViewerfor which to determine theIHandlePartFactoryfor thisIBehavior.- Returns:
- The
IHandlePartFactorythat should be used for feedback creation.
-
getHandlePartFactory
Returns theIHandlePartFactorythat is registered as an adapter at the givenIViewerunder the given role.- Parameters:
viewer- TheIViewerwhere theIHandlePartFactoryis registered.role- The role under which theIHandlePartFactoryis registered.- Returns:
- The
IHandlePartFactorythat is registered as an adapter at the givenIViewerunder the given role.
-
getHandles
protected List<IHandlePart<? extends Node>> getHandles(Collection<? extends IVisualPart<? extends Node>> targets) Returns a list that contains allIHandleParts that were generated for the given target parts by thisIBehavior. If no handle parts were generated for the given target parts, an empty list is returned.- Parameters:
targets- A collection of target parts.- Returns:
- A list that contains all handle parts that were generated for the given target parts.
-
getHandles
Returns a list that contains allIHandleParts that were generated for the given target part by thisIBehavior. If no handle parts were generated for the given target part, an empty list is returned.- Parameters:
target- The target part.- Returns:
- A list that contains all handle parts that were generated for the given target part.
-
getHandlesPerTargetSet
protected Map<Set<IVisualPart<? extends Node>>,List<IHandlePart<? extends Node>>> getHandlesPerTargetSet()Returns the map that stores the handle parts per target part set.- Returns:
- The map that stores the handle parts per target part set.
-
getHost
Description copied from interface:IBehaviorReturns the hostIVisualPartof thisIBehavior, i.e. the part where this behavior is registered as an adapter.- Specified by:
getHostin interfaceIBehavior- Returns:
- The host
IVisualPartof thisIBehavior.
-
hasFeedback
Returnstrueif feedback was added for the given set of target parts, even if no feedback parts were generated for the given set of target parts. Otherwise returnsfalse.- Parameters:
targets- The set of target parts.- Returns:
trueif feedback was added for the given set of target parts, even if no feedback parts were generated, otherwisefalse.
-
hasFeedback
Returnstrueif feedback was added for the given target part, even if no feedback parts were generated for the given target part. Otherwise returnsfalse.- Parameters:
target- The target part.- Returns:
trueif feedback was added for the given target part, even if no feedback parts were generated, otherwisefalse.
-
hasHandles
Returnstrueif handles were added for the given set of target parts, even if no handle parts were generated for the given set of target parts. Otherwise returnsfalse.- Parameters:
targets- The set of target parts.- Returns:
trueif handles were added for the given set of target parts, even if no handle parts were generated, otherwisefalse.
-
hasHandles
Returnstrueif handles were added for the given target part, even if no handle parts were generated for the given target part. Otherwise returnsfalse.- Parameters:
target- The target part.- Returns:
trueif handles were added for the given target part, even if no handles parts were generated, otherwisefalse.
-
isActive
public final boolean isActive()Gets the value of the property active.- Specified by:
isActivein interfaceIActivatable- Property description:
-
removeAnchoreds
protected void removeAnchoreds(Collection<? extends IVisualPart<? extends Node>> targets, List<? extends IVisualPart<? extends Node>> anchoreds) Removes the given anchoreds as children from the root part and as anchoreds from the given target parts.- Parameters:
targets- The anchorages of the anchoreds.anchoreds- The anchoreds (feedback or handles) that are to be removed.
-
removeFeedback
Removes feedback for the given targets.- Parameters:
targets- The list of target parts.
-
removeFeedback
Removes feedback for the given target.- Parameters:
target- The target for which to remove feedback.
-
removeFeedback
Removes feedback for the given target parts.- Parameters:
targetSet- The target parts.
-
removeHandles
Removes handles for the given target parts.- Parameters:
targets- The target parts.
-
removeHandles
Removes handles for the given target.- Parameters:
target- The target for which to remove handles.
-
removeHandles
Removes handles for the given target parts.- Parameters:
targetSet- The target parts.
-
setAdaptable
Sets the value of the property adaptable.- Specified by:
setAdaptablein interfaceIAdaptable.Bound<IVisualPart<? extends Node>>- Property description:
-
updateHandles
public IHandlePart<? extends Node> updateHandles(IVisualPart<? extends Node> target, Comparator<IHandlePart<? extends Node>> interactedWithComparator, IHandlePart<? extends Node> interactedWith) Updates the handles of the given target part. Returns a newIHandlePartthat would be replacing the given interactedWith handle part if that part was not preserved (which it is). The user can then apply the information of the replacement part to the preserved interactedWith part.- Parameters:
target- The target part for the handles.interactedWithComparator- AComparatorthat can be used to identify a new handle at the same position as the handle that is currently interacted with. Can benullif no handle should be preserved.interactedWith- TheIHandlePartthat is interacted with and therefore, should be preserved, ornull.- Returns:
- The new
IHandlePartfor the position of the handle part that is interacted with so that its information can be applied to the preserved handle part.
-
updateHandles
public IHandlePart<? extends Node> updateHandles(List<? extends IVisualPart<? extends Node>> targets, Comparator<IHandlePart<? extends Node>> interactedWithComparator, IHandlePart<? extends Node> interactedWith) Updates the handles of the given targets. Returns a newIHandlePartthat would be replacing the given interactedWith handle part if that part was not preserved (which it is). The user can then apply the information of the replacement part to the preserved interactedWith part.- Parameters:
targets- The target parts for the handles.interactedWithComparator- AComparatorthat can be used to identify a new handle at the same position as the handle that is currently interacted with. Can benullif no handle should be preserved.interactedWith- TheIHandlePartthat is interacted with and therefore, should be preserved, ornull.- Returns:
- The new
IHandlePartfor the position of the handle part that is interacted with so that its information can be applied to the preserved handle part.
-