Class HoverModel

    • Field Detail

      • HOVER_PROPERTY

        public static final java.lang.String HOVER_PROPERTY
        This is the name of the property that stores the currently hovered IVisualPart.
        See Also:
        Constant Field Values
      • HOVER_INTENT_PROPERTY

        public static final java.lang.String HOVER_INTENT_PROPERTY
        This property stores the intended hovered
        See Also:
        Constant Field Values
    • Constructor Detail

      • HoverModel

        public HoverModel()
    • Method Detail

      • clearHover

        public void clearHover()
        Sets the hovered part to null.
      • clearHoverIntent

        public void clearHoverIntent()
        Sets the intentionally hovered part to null.
      • dispose

        public void dispose()
        Specified by:
        dispose in interface IDisposable
        Since:
        1.1
      • getHover

        public IVisualPart<? extends javafx.scene.Node> getHover()
        Returns the currently hovered IVisualPart or null if no visual part is hovered.
        Returns:
        the currently hovered IVisualPart or null
      • getHoverIntent

        public IContentPart<? extends javafx.scene.Node> getHoverIntent()
        Returns the current hover intent IContentPart or null if no content part is intentionally hovered.
        Returns:
        The current hover intent IContentPart or null
      • hoverIntentProperty

        public javafx.beans.property.ObjectProperty<IContentPart<? extends javafx.scene.Node>> hoverIntentProperty()
        Returns an object property representing the hover intent part.
        Returns:
        A property named HOVER_INTENT_PROPERTY.
      • hoverProperty

        public javafx.beans.property.ObjectProperty<IVisualPart<? extends javafx.scene.Node>> hoverProperty()
        Returns an object property representing the current hover part.
        Returns:
        A property named HOVER_PROPERTY.
      • setHover

        public void setHover​(IVisualPart<? extends javafx.scene.Node> cp)
        Sets the hovered IVisualPart to the given value. The given part may be null in order to unhover.
        Parameters:
        cp - hovered IVisualPart or null
      • setHoverIntent

        public void setHoverIntent​(IContentPart<? extends javafx.scene.Node> cp)
        Sets the hover intent IContentPart to the given value. The given part may be null to indicate unhovering.
        Parameters:
        cp - The hover intent IContentPart or null.