Package io.guise.framework.component

Interface SelectActionControl

    • Field Detail

      • AUTO_SELECT_PROPERTY

        static final java.lang.String AUTO_SELECT_PROPERTY
        The auto-select bound property.

      • SELECTED_GLYPH_URI_PROPERTY

        static final java.lang.String SELECTED_GLYPH_URI_PROPERTY
        The selected icon bound property.

      • TOGGLE_PROPERTY

        static final java.lang.String TOGGLE_PROPERTY
        The toggle bound property.

      • UNSELECTED_GLYPH_URI_PROPERTY

        static final java.lang.String UNSELECTED_GLYPH_URI_PROPERTY
        The unselected icon bound property.

    • Method Detail

      • isAutoSelect

        boolean isAutoSelect()
        Returns:
        Whether this control automatically sets or toggles the selection state when the action occurs.

      • setAutoSelect

        void setAutoSelect​(boolean newAutoSelect)
        Sets whether this control automatically sets or toggles the selection state when the action occurs. This is a bound property of type Boolean.
        Parameters:
        newAutoSelect - true if the control should automatically set or toggle the selection state when an action occurs.
        See Also:
        AUTO_SELECT_PROPERTY

      • getSelectedGlyphURI

        java.net.URI getSelectedGlyphURI()
        Returns:
        The selected icon URI, which may be a resource URI, or null if there is no selected icon URI.

      • setSelectedGlyphURI

        void setSelectedGlyphURI​(java.net.URI newSelectedIcon)
        Sets the URI of the selected icon. This is a bound property of type URI.
        Parameters:
        newSelectedIcon - The new URI of the selected icon, which may be a resource URI.
        See Also:
        SELECTED_GLYPH_URI_PROPERTY

      • isToggle

        boolean isToggle()
        Returns:
        Whether this control acts as a toggle, switching its value between true and false, or whether the action always sets the value to true.

      • setToggle

        void setToggle​(boolean newToggle)
        Sets whether this control acts as a toggle, switching its value between true and false, or whether the action always sets the value to true. This is a bound property of type Boolean.
        Parameters:
        newToggle - true if the component should act as a toggle, else false if the action should unconditionally set the value to true.
        See Also:
        TOGGLE_PROPERTY

      • getUnselectedGlyphURI

        java.net.URI getUnselectedGlyphURI()
        Returns:
        The unselected icon URI, which may be a resource URI, or null if there is no unselected icon URI.

      • setUnselectedGlyphURI

        void setUnselectedGlyphURI​(java.net.URI newUnselectedIcon)
        Sets the URI of the unselected icon. This is a bound property of type URI.
        Parameters:
        newUnselectedIcon - The new URI of the unselected icon, which may be a resource URI.
        See Also:
        UNSELECTED_GLYPH_URI_PROPERTY