Package qupath.lib.plugins.parameters

Class BooleanParameter

java.lang.Object
qupath.lib.plugins.parameters.BooleanParameter
All Implemented Interfaces:
Serializable, Parameter<Boolean>
public class BooleanParameter extends Object
Parameter that can take on true of false value - or null.

May be displayed as a checkbox.

Author:
Pete Bankhead
See Also:

  • Field Details

    • lastValue

      protected Boolean lastValue

  • Method Details

    • setStringLastValue

      public boolean setStringLastValue(Locale locale, String value)
      Description copied from interface: Parameter
      Set last value using a string; implementing classes may need to parse this
      Parameters:
      locale -
      value -
      Returns:

    • isValidInput

      public boolean isValidInput(Boolean value)
      Description copied from interface: Parameter
      Query if a specified value would be valid for this parameter.
      Parameters:
      value -
      Returns:
      true if the value would be valid, false otherwise

    • duplicate

      public Parameter<Boolean> duplicate()
      Description copied from interface: Parameter
      Create a new Parameter with the same text and value.
      Returns:

    • setHidden

      public void setHidden(boolean hidden)
      Description copied from interface: Parameter
      Mark that a parameter should not be displayed to a user. This is useful, for example, if a parameter list changes the parameters to be displayed depending upon the image available or current settings, e.g. using different parameters when the pixel size is known in microns.
      Specified by:
      setHidden in interface Parameter<S>
      Parameters:
      hidden -

    • isHidden

      public boolean isHidden()
      Description copied from interface: Parameter
      Test is the 'hidden' flag is set for the parameter.
      Specified by:
      isHidden in interface Parameter<S>
      Returns:

    • getDefaultValue

      public Boolean getDefaultValue()
      Description copied from interface: Parameter
      Get a default value to use if the Parameter has not been otherwise set.
      Specified by:
      getDefaultValue in interface Parameter<S>
      Returns:

    • getValue

      public Boolean getValue()
      Description copied from interface: Parameter
      Get the current set value (may be null).
      Specified by:
      getValue in interface Parameter<S>
      Returns:
      See Also:

    • resetValue

      public void resetValue()
      Description copied from interface: Parameter
      Set last value to null (so default can be used).
      Specified by:
      resetValue in interface Parameter<S>

    • getValueOrDefault

      public Boolean getValueOrDefault()
      Description copied from interface: Parameter
      Get the current set value, or any default if no value has been set.
      Specified by:
      getValueOrDefault in interface Parameter<S>
      Returns:
      See Also:

    • getPrompt

      public String getPrompt()
      Description copied from interface: Parameter
      Get some prompt text that may be displayed to a user.
      Specified by:
      getPrompt in interface Parameter<S>
      Returns:

    • setValue

      public boolean setValue(Boolean value)
      Description copied from interface: Parameter
      Set the Parameter to have a specified value.
      Specified by:
      setValue in interface Parameter<S>
      Parameters:
      value -
      Returns:

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • hasHelpText

      public boolean hasHelpText()
      Description copied from interface: Parameter
      Query whether getHelpText() returns a meaningful String (as opposed to null).
      Specified by:
      hasHelpText in interface Parameter<S>
      Returns:

    • getHelpText

      public String getHelpText()
      Description copied from interface: Parameter
      Get a description of the meaning of the Parameter; may be displayed e.g. as a tooltip.
      Specified by:
      getHelpText in interface Parameter<S>
      Returns: