Interface IUICheck2Component

    • Field Detail

      • PN_CHECKED

        static final java.lang.String PN_CHECKED
        Property name: checked.
        See Also:
        Constant Field Values
      • CHECKED_ATOM

        static final Atom CHECKED_ATOM
        The atom name: checked.
      • PN_CHECKED_VALUE

        static final java.lang.String PN_CHECKED_VALUE
        Property name: checked value.
        See Also:
        Constant Field Values
      • PN_UNCHECKED_VALUE

        static final java.lang.String PN_UNCHECKED_VALUE
        Property name: unchecked value.
        See Also:
        Constant Field Values
      • PN_CHECK_NO_MATCH

        static final java.lang.String PN_CHECK_NO_MATCH
        Property name: check state for non-matching values.
        See Also:
        Constant Field Values
    • Method Detail

      • getCheckState

        default int getCheckState()
        Gets the check state.

        Third state is not supported.

        Returns:
        Returns 0=unchecked, 1=checked.
      • isChecked

        default boolean isChecked()
        Verifies if the component is checked.
        Returns:
        true if the component is checked, false if unselected or in third state.
      • isUnselected

        default boolean isUnselected()
        Returns if the selection is not set.
        Specified by:
        isUnselected in interface IUIBooleanSelectionComp
        Returns:
        true if unselected, true if selected.
      • isON

        default boolean isON()
        Returns if the selection is "on".
        Specified by:
        isON in interface IUIBooleanSelectionComp
        Returns:
        true if on, false otherwise.
      • isOFF

        default boolean isOFF()
        Returns if the selection is "off".
        Specified by:
        isOFF in interface IUIBooleanSelectionComp
        Returns:
        true if off, true otherwise.
      • setChecked

        default boolean setChecked​(boolean on)
        Sets the checked state.
        Parameters:
        on - The check state.
        Returns:
        true if state is changed, false for no change.
      • setChecked

        default boolean setChecked​(int state)
        Sets the checked state.
        Parameters:
        state - The check state: 0=unchecked, 1=checked.

        Third state is not supported.

        Returns:
        true if state is changed, false for no change or failure (state has wrong value).
      • setSelection

        default boolean setSelection​(boolean isSelected)
        Sets the selection.
        Specified by:
        setSelection in interface IUIBooleanSelectionComp
        Parameters:
        isSelected - The selected state.
        Returns:
        true if state is changed, false for no change.
      • getSelectionType

        default int getSelectionType()
        Gets the selection type of the component.
        Specified by:
        getSelectionType in interface IUISelectionComp
        Returns:
        A value indicating the selection capability as the SELECTION_TYPE_* values define.
      • getSelection

        default IUISelection getSelection()
        Gets the current selection of the component.
        Specified by:
        getSelection in interface IUISelectionComp
        Returns:
        The current selection of the component.
      • setSelection

        default java.lang.String setSelection​(IUISelection selection)
        Sets the selection.
        Specified by:
        setSelection in interface IUISelectionComp
        Parameters:
        selection - The selection.
        Returns:
        null if selection is set successfully, otherwise the reason why the selection failed to be set, e.g. "Unsupported selection base" if the selection is indexed for a checkbox that only supports tri-state based selections.