Interface IVisualPart<V extends javafx.scene.Node>

    • Field Detail

      • PARENT_PROPERTY

        static final java.lang.String PARENT_PROPERTY
        Name of the property storing this part's parent.
        See Also:
        Constant Field Values
      • CHILDREN_PROPERTY

        static final java.lang.String CHILDREN_PROPERTY
        Name of the property storing this part's children.
        See Also:
        Constant Field Values
      • ANCHORAGES_PROPERTY

        static final java.lang.String ANCHORAGES_PROPERTY
        Name of the property storing this part's anchorages.
        See Also:
        Constant Field Values
      • ANCHOREDS_PROPERTY

        static final java.lang.String ANCHOREDS_PROPERTY
        Name of the property storing this part's anchoreds.
        See Also:
        Constant Field Values
      • REFRESH_VISUAL_PROPERTY

        static final java.lang.String REFRESH_VISUAL_PROPERTY
        Name of the property storing the refresh visual boolean property.
        See Also:
        Constant Field Values
    • Method Detail

      • addChild

        void addChild​(IVisualPart<? extends javafx.scene.Node> child)
        Adds the given child to the list of this part's children.
        Parameters:
        child - The IVisualPart which is added to the list of this part's children.
      • addChild

        void addChild​(IVisualPart<? extends javafx.scene.Node> child,
                      int index)
        Adds the given child to the list of this part's children at the specified index.
        Parameters:
        child - The IVisualPart which is added to the list of this part's children.
        index - The index at which the given IVisualPart is inserted into this part's children list.
      • addChildren

        void addChildren​(java.util.List<? extends IVisualPart<? extends javafx.scene.Node>> children)
        Adds the given children to the list of this part's children.
        Parameters:
        children - The IVisualParts which are added to the list of this part's children.
      • addChildren

        void addChildren​(java.util.List<? extends IVisualPart<? extends javafx.scene.Node>> children,
                         int index)
        Adds the given children to the list of this part's children at the specified index.
        Parameters:
        children - The IVisualParts which are added to the list of this part's children.
        index - The index at which the given IVisualParts are inserted into this part's children list.
      • anchoragesUnmodifiableProperty

        ReadOnlySetMultimapProperty<IVisualPart<? extends javafx.scene.Node>,​java.lang.String> anchoragesUnmodifiableProperty()
        Returns a read-only set-multimap property containing this part's anchorages and their corresponding roles.
        Returns:
        A read-only set-multimap property named ANCHORAGES_PROPERTY.
      • attachToAnchorage

        void attachToAnchorage​(IVisualPart<? extends javafx.scene.Node> anchorage)
        Attaches the given IVisualPart to the given anchorage under the "default" role.
        Parameters:
        anchorage - The anchorage IVisualPart to attach this part to.
      • attachToAnchorage

        void attachToAnchorage​(IVisualPart<? extends javafx.scene.Node> anchorage,
                               java.lang.String role)
        Attaches the given IVisualPart to the given anchorage under the given role.
        Parameters:
        anchorage - The anchorage IVisualPart to attach this part to.
        role - The role under which this IVisualPart is attached to the given anchorage. null.
      • detachFromAnchorage

        void detachFromAnchorage​(IVisualPart<? extends javafx.scene.Node> anchorage)
        Detaches this IVisualPart from the given anchorage IVisualPart under the 'default' role.
        Parameters:
        anchorage - The anchorage IVisualPart to detach this part from.
      • detachFromAnchorage

        void detachFromAnchorage​(IVisualPart<? extends javafx.scene.Node> anchorage,
                                 java.lang.String role)
        Detaches this IVisualPart from the given anchorage IVisualPart under the given role.
        Parameters:
        anchorage - The anchorage IVisualPart to detach this part from.
        role - The role under which the IVisualPart can be found in this part's anchorages.
      • getBehaviors

        java.util.Map<AdapterKey<? extends IBehavior>,​IBehavior> getBehaviors()
        Returns a Map of this part's behaviors and their corresponding AdapterKeys.
        Returns:
        A Map of this part's behaviors and their corresponding AdapterKeys.
      • getChildrenUnmodifiable

        javafx.collections.ObservableList<IVisualPart<? extends javafx.scene.Node>> getChildrenUnmodifiable()
        Returns an unmodifiable ObservableList of this part's children.
        Returns:
        A ObservableList of this part's children.
      • getHandlers

        java.util.Map<AdapterKey<? extends org.eclipse.gef.mvc.fx.handlers.IHandler>,​org.eclipse.gef.mvc.fx.handlers.IHandler> getHandlers()
        Returns a Map of this part's handlers and their corresponding AdapterKeys.
        Returns:
        A Map of this part's handlers and their corresponding AdapterKeys.
      • getParent

        IVisualPart<? extends javafx.scene.Node> getParent()
        Returns the parent of this part.
        Returns:
        The parent of this part.
      • getPolicies

        java.util.Map<AdapterKey<? extends IPolicy>,​IPolicy> getPolicies()
        Returns a Map of this part's policies and their corresponding AdapterKeys.
        Returns:
        A Map of this part's policies and their corresponding AdapterKeys.
      • getRoot

        IRootPart<? extends javafx.scene.Node> getRoot()
        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.
        Returns:
        null or the IRootPart
      • getVisual

        V getVisual()
        Returns this part's visual.
        Returns:
        This part's visual.
      • isRefreshVisual

        boolean isRefreshVisual()
        Returns true if this part is allowed to refresh its visualization based on its content. Otherwise returns false.
        Returns:
        true if this part is allowed to refresh its visualization based on its content, otherwise false.
      • refreshVisual

        void refreshVisual()
        Refreshes this part's visualization based on this part's content.
      • removeChild

        void removeChild​(IVisualPart<? extends javafx.scene.Node> child)
        Removes the given IVisualPart from the list of this part's children.
        Parameters:
        child - The IVisualPart which is removed from the list of this part's children.
      • removeChildren

        void removeChildren​(java.util.List<? extends IVisualPart<? extends javafx.scene.Node>> children)
        Removes the given IVisualParts from the list of this part's children.
        Parameters:
        children - The IVisualParts which are removed from the list of this part's children.
      • reorderChild

        void reorderChild​(IVisualPart<? extends javafx.scene.Node> child,
                          int index)
        Swaps the given IVisualPart with the part at the given index position within this part's list of children.
        Parameters:
        child - The IVisualPart which is reordered.
        index - The index to which the part is reordered.
      • setRefreshVisual

        void setRefreshVisual​(boolean refreshVisual)
        Allows to temporarily turn refreshVisual() into a no-op operation. This may for instance be used to disable visual updates that are initiated by the model (in case of IContentParts) while interacting with the IVisualPart.
        Parameters:
        refreshVisual - Whether refreshVisual() should perform updates of the visual (true) or behave like a no-op operation ( false).