Class AbstractBehavior

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void activate()  
      javafx.beans.property.ReadOnlyBooleanProperty activeProperty()  
      javafx.beans.property.ReadOnlyObjectProperty<IVisualPart<? extends javafx.scene.Node>> adaptableProperty()  
      protected void addAnchoreds​(java.util.Collection<? extends IVisualPart<? extends javafx.scene.Node>> targets, java.util.List<? extends IVisualPart<? extends javafx.scene.Node>> anchoreds)
      Adds the given anchoreds as children to the root part and anchors them to the given target parts.
      protected void addAnchoreds​(java.util.Collection<? extends IVisualPart<? extends javafx.scene.Node>> targets, java.util.List<? extends IVisualPart<? extends javafx.scene.Node>> anchoreds, int insertionIndex)
      Adds the given anchoreds as children to the root part and anchors them to the given target parts.
      protected void addFeedback​(java.util.List<? extends IVisualPart<? extends javafx.scene.Node>> targets)
      Adds feedback for the given target parts.
      protected void addFeedback​(IVisualPart<? extends javafx.scene.Node> target)
      Adds feedback for the given target part.
      protected void addHandles​(java.util.List<? extends IVisualPart<? extends javafx.scene.Node>> targets)
      Adds handles for the given target parts.
      protected void addHandles​(IVisualPart<? extends javafx.scene.Node> target)
      Adds handles for the given target part.
      protected void clearFeedback()
      Removes all feedback.
      protected void clearHandles()
      Removes all handles.
      void deactivate()  
      protected void doActivate()
      Post activate() hook that may be overwritten to e.g. register listeners.
      protected void doDeactivate()
      Pre deactivate() hook that may be overwritten to e.g. unregister listeners.
      IVisualPart<? extends javafx.scene.Node> getAdaptable()  
      protected java.util.List<IFeedbackPart<? extends javafx.scene.Node>> getFeedback​(java.util.Collection<? extends IVisualPart<? extends javafx.scene.Node>> targets)
      Returns a list that contains all IHandleParts that were generated for the given target parts by this IBehavior.
      protected java.util.List<IFeedbackPart<? extends javafx.scene.Node>> getFeedback​(IVisualPart<? extends javafx.scene.Node> target)
      Returns a list that contains all IHandleParts that were generated for the given target part by this IBehavior.
      protected IFeedbackPartFactory getFeedbackPartFactory​(IViewer viewer)
      Returns the IFeedbackPartFactory that should be used for feedback creation.
      protected IFeedbackPartFactory getFeedbackPartFactory​(IViewer viewer, java.lang.String role)
      Returns the IFeedbackPartFactory that is registered as an adapter at the given IViewer under the given role.
      protected java.util.Map<java.util.Set<IVisualPart<? extends javafx.scene.Node>>,​java.util.List<IFeedbackPart<? extends javafx.scene.Node>>> getFeedbackPerTargetSet()
      Returns the map that stores the feedback parts per target part set.
      protected IHandlePartFactory getHandlePartFactory​(IViewer viewer)
      Returns the IHandlePartFactory that should be used for handle creation.
      protected IHandlePartFactory getHandlePartFactory​(IViewer viewer, java.lang.String role)
      Returns the IHandlePartFactory that is registered as an adapter at the given IViewer under the given role.
      protected java.util.List<IHandlePart<? extends javafx.scene.Node>> getHandles​(java.util.Collection<? extends IVisualPart<? extends javafx.scene.Node>> targets)
      Returns a list that contains all IHandleParts that were generated for the given target parts by this IBehavior.
      protected java.util.List<IHandlePart<? extends javafx.scene.Node>> getHandles​(IVisualPart<? extends javafx.scene.Node> target)
      Returns a list that contains all IHandleParts that were generated for the given target part by this IBehavior.
      protected java.util.Map<java.util.Set<IVisualPart<? extends javafx.scene.Node>>,​java.util.List<IHandlePart<? extends javafx.scene.Node>>> getHandlesPerTargetSet()
      Returns the map that stores the handle parts per target part set.
      IVisualPart<? extends javafx.scene.Node> getHost()
      Returns the host IVisualPart of this IBehavior, i.e. the part where this behavior is registered as an adapter.
      protected boolean hasFeedback​(java.util.Collection<? extends IVisualPart<? extends javafx.scene.Node>> targets)
      Returns true if 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 boolean hasFeedback​(IVisualPart<? extends javafx.scene.Node> target)
      Returns true if feedback was added for the given target part, even if no feedback parts were generated for the given target part.
      protected boolean hasHandles​(java.util.Collection<? extends IVisualPart<? extends javafx.scene.Node>> targets)
      Returns true if 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 boolean hasHandles​(IVisualPart<? extends javafx.scene.Node> target)
      Returns true if handles were added for the given target part, even if no handle parts were generated for the given target part.
      boolean isActive()  
      protected void removeAnchoreds​(java.util.Collection<? extends IVisualPart<? extends javafx.scene.Node>> targets, java.util.List<? extends IVisualPart<? extends javafx.scene.Node>> anchoreds)
      Removes the given anchoreds as children from the root part and as anchoreds from the given target parts.
      protected void removeFeedback​(java.util.Collection<? extends IVisualPart<? extends javafx.scene.Node>> targets)
      Removes feedback for the given targets.
      protected void removeFeedback​(java.util.Set<? extends IVisualPart<? extends javafx.scene.Node>> targetSet)
      Removes feedback for the given target parts.
      protected void removeFeedback​(IVisualPart<? extends javafx.scene.Node> target)
      Removes feedback for the given target.
      protected void removeHandles​(java.util.Collection<? extends IVisualPart<? extends javafx.scene.Node>> targets)
      Removes handles for the given target parts.
      protected void removeHandles​(java.util.Set<? extends IVisualPart<? extends javafx.scene.Node>> targetSet)
      Removes handles for the given target parts.
      protected void removeHandles​(IVisualPart<? extends javafx.scene.Node> target)
      Removes handles for the given target.
      void setAdaptable​(IVisualPart<? extends javafx.scene.Node> adaptable)  
      IHandlePart<? extends javafx.scene.Node> updateHandles​(java.util.List<? extends IVisualPart<? extends javafx.scene.Node>> targets, java.util.Comparator<IHandlePart<? extends javafx.scene.Node>> interactedWithComparator, IHandlePart<? extends javafx.scene.Node> interactedWith)
      Updates the handles of the given targets.
      IHandlePart<? extends javafx.scene.Node> updateHandles​(IVisualPart<? extends javafx.scene.Node> target, java.util.Comparator<IHandlePart<? extends javafx.scene.Node>> interactedWithComparator, IHandlePart<? extends javafx.scene.Node> interactedWith)
      Updates the handles of the given target part.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • AbstractBehavior

        public AbstractBehavior()
    • Method Detail

      • activeProperty

        public final javafx.beans.property.ReadOnlyBooleanProperty activeProperty()
        Specified by:
        activeProperty in interface IActivatable
      • addAnchoreds

        protected void addAnchoreds​(java.util.Collection<? extends IVisualPart<? extends javafx.scene.Node>> targets,
                                    java.util.List<? extends IVisualPart<? extends javafx.scene.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​(java.util.Collection<? extends IVisualPart<? extends javafx.scene.Node>> targets,
                                    java.util.List<? extends IVisualPart<? extends javafx.scene.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

        protected void addFeedback​(IVisualPart<? extends javafx.scene.Node> target)
        Adds feedback for the given target part.
        Parameters:
        target - The target part for which to add feedback.
      • addFeedback

        protected void addFeedback​(java.util.List<? extends IVisualPart<? extends javafx.scene.Node>> targets)
        Adds feedback for the given target parts.
        Parameters:
        targets - The target parts for which to add feedback.
      • addHandles

        protected void addHandles​(IVisualPart<? extends javafx.scene.Node> target)
        Adds handles for the given target part.
        Parameters:
        target - The target part for which to add feedback.
      • addHandles

        protected void addHandles​(java.util.List<? extends IVisualPart<? extends javafx.scene.Node>> targets)
        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.
      • doActivate

        protected void doActivate()
        Post activate() hook that may be overwritten to e.g. register listeners.
      • doDeactivate

        protected void doDeactivate()
        Pre deactivate() hook that may be overwritten to e.g. unregister listeners.
      • getFeedback

        protected java.util.List<IFeedbackPart<? extends javafx.scene.Node>> getFeedback​(java.util.Collection<? extends IVisualPart<? extends javafx.scene.Node>> targets)
        Returns a list that contains all IHandleParts that were generated for the given target parts by this IBehavior. 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

        protected java.util.List<IFeedbackPart<? extends javafx.scene.Node>> getFeedback​(IVisualPart<? extends javafx.scene.Node> target)
        Returns a list that contains all IHandleParts that were generated for the given target part by this IBehavior. 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.
      • getFeedbackPerTargetSet

        protected java.util.Map<java.util.Set<IVisualPart<? extends javafx.scene.Node>>,​java.util.List<IFeedbackPart<? extends javafx.scene.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.
      • getHandles

        protected java.util.List<IHandlePart<? extends javafx.scene.Node>> getHandles​(java.util.Collection<? extends IVisualPart<? extends javafx.scene.Node>> targets)
        Returns a list that contains all IHandleParts that were generated for the given target parts by this IBehavior. 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

        protected java.util.List<IHandlePart<? extends javafx.scene.Node>> getHandles​(IVisualPart<? extends javafx.scene.Node> target)
        Returns a list that contains all IHandleParts that were generated for the given target part by this IBehavior. 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 java.util.Map<java.util.Set<IVisualPart<? extends javafx.scene.Node>>,​java.util.List<IHandlePart<? extends javafx.scene.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.
      • hasFeedback

        protected boolean hasFeedback​(java.util.Collection<? extends IVisualPart<? extends javafx.scene.Node>> targets)
        Returns true if 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 returns false.
        Parameters:
        targets - The set of target parts.
        Returns:
        true if feedback was added for the given set of target parts, even if no feedback parts were generated, otherwise false.
      • hasFeedback

        protected boolean hasFeedback​(IVisualPart<? extends javafx.scene.Node> target)
        Returns true if feedback was added for the given target part, even if no feedback parts were generated for the given target part. Otherwise returns false.
        Parameters:
        target - The target part.
        Returns:
        true if feedback was added for the given target part, even if no feedback parts were generated, otherwise false.
      • hasHandles

        protected boolean hasHandles​(java.util.Collection<? extends IVisualPart<? extends javafx.scene.Node>> targets)
        Returns true if 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 returns false.
        Parameters:
        targets - The set of target parts.
        Returns:
        true if handles were added for the given set of target parts, even if no handle parts were generated, otherwise false.
      • hasHandles

        protected boolean hasHandles​(IVisualPart<? extends javafx.scene.Node> target)
        Returns true if handles were added for the given target part, even if no handle parts were generated for the given target part. Otherwise returns false.
        Parameters:
        target - The target part.
        Returns:
        true if handles were added for the given target part, even if no handles parts were generated, otherwise false.
      • removeAnchoreds

        protected void removeAnchoreds​(java.util.Collection<? extends IVisualPart<? extends javafx.scene.Node>> targets,
                                       java.util.List<? extends IVisualPart<? extends javafx.scene.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

        protected void removeFeedback​(java.util.Collection<? extends IVisualPart<? extends javafx.scene.Node>> targets)
        Removes feedback for the given targets.
        Parameters:
        targets - The list of target parts.
      • removeFeedback

        protected void removeFeedback​(IVisualPart<? extends javafx.scene.Node> target)
        Removes feedback for the given target.
        Parameters:
        target - The target for which to remove feedback.
      • removeFeedback

        protected void removeFeedback​(java.util.Set<? extends IVisualPart<? extends javafx.scene.Node>> targetSet)
        Removes feedback for the given target parts.
        Parameters:
        targetSet - The target parts.
      • removeHandles

        protected void removeHandles​(java.util.Collection<? extends IVisualPart<? extends javafx.scene.Node>> targets)
        Removes handles for the given target parts.
        Parameters:
        targets - The target parts.
      • removeHandles

        protected void removeHandles​(IVisualPart<? extends javafx.scene.Node> target)
        Removes handles for the given target.
        Parameters:
        target - The target for which to remove handles.
      • removeHandles

        protected void removeHandles​(java.util.Set<? extends IVisualPart<? extends javafx.scene.Node>> targetSet)
        Removes handles for the given target parts.
        Parameters:
        targetSet - The target parts.
      • updateHandles

        public IHandlePart<? extends javafx.scene.Node> updateHandles​(IVisualPart<? extends javafx.scene.Node> target,
                                                                      java.util.Comparator<IHandlePart<? extends javafx.scene.Node>> interactedWithComparator,
                                                                      IHandlePart<? extends javafx.scene.Node> interactedWith)
        Updates the handles of the given target part. Returns a new IHandlePart that 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 - A Comparator that can be used to identify a new handle at the same position as the handle that is currently interacted with. Can be null if no handle should be preserved.
        interactedWith - The IHandlePart that is interacted with and therefore, should be preserved, or null.
        Returns:
        The new IHandlePart for 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 javafx.scene.Node> updateHandles​(java.util.List<? extends IVisualPart<? extends javafx.scene.Node>> targets,
                                                                      java.util.Comparator<IHandlePart<? extends javafx.scene.Node>> interactedWithComparator,
                                                                      IHandlePart<? extends javafx.scene.Node> interactedWith)
        Updates the handles of the given targets. Returns a new IHandlePart that 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 - A Comparator that can be used to identify a new handle at the same position as the handle that is currently interacted with. Can be null if no handle should be preserved.
        interactedWith - The IHandlePart that is interacted with and therefore, should be preserved, or null.
        Returns:
        The new IHandlePart for the position of the handle part that is interacted with so that its information can be applied to the preserved handle part.