Interface IUIDoubleRangeValueComponent

All Superinterfaces:
IComponent, ICustomDataProvider, IGProp<GProp<?>[]>, IMessageBox, IPropCnr, IUIComp, IUIDoubleValueComponent, IUIValueComponent, IVSComponentListener, IVSComponentState, IVSFieldListener
All Known Implementing Classes:
EUIProgress, EUISlider, UIProgress, UISlider

public interface IUIDoubleRangeValueComponent extends IUIDoubleValueComponent
Interface implemented by value supporting components with a double value and a range.
Author:
Christopher Mindus
  • Method Details

    • setRange

      default boolean setRange(double minValue, double maxValue) throws IllegalArgumentException
      Sets the value range without affecting the value. The current value may therefore be outside the range due to this call.
      Parameters:
      minValue - The minimum value.
      maxValue - The minimum value.
      Returns:
      true if any of the values changed, false for no changes.
      Throws:
      IllegalArgumentException - If the minimum is larger than maximum or the value range is outside.
    • setValueAndRange

      default boolean setValueAndRange(double value, double minValue, double maxValue) throws IllegalArgumentException
      Sets the value and range at once.
      Parameters:
      value - The value.
      minValue - The minimum value.
      maxValue - The minimum value.
      Returns:
      true if any of the values changed, false for no changes.
      Throws:
      IllegalArgumentException - If the minimum is larger than maximum or the value range is outside.
    • setMinimum

      default boolean setMinimum(double minValue) throws IllegalArgumentException
      Sets the minimum value without changing the current value. The current value may therefore be outside the range due to this call.
      Parameters:
      minValue - The minimum value.
      Returns:
      true if the value was changed, false for no change.
      Throws:
      IllegalArgumentException - If the minimum is larger than maximum.
    • setMaximum

      default boolean setMaximum(double maxValue) throws IllegalArgumentException
      Sets the maximum value without changing the current value. The current value may therefore be outside the range due to this call.
      Parameters:
      maxValue - The maximum value.
      Returns:
      true if the value was changed, false for no change.
      Throws:
      IllegalArgumentException - If the maximum is smaller than minimum.
    • getMinimum

      default double getMinimum()
      Gets the minimum value.
      Returns:
      The minimum value or the default minimum if the minimum value property is undefined.
    • getMaximum

      default double getMaximum()
      Gets the maximum value.
      Returns:
      The maximum value or the default maximum if the maximum value property is undefined.
    • getMinimumDefault

      double getMinimumDefault()
      Gets the default minimum value.
      Returns:
      The default minimum value.
    • getMaximumDefault

      double getMaximumDefault()
      Gets the default maximum value.
      Returns:
      The default maximum value.
    • setValue

      default boolean setValue(double value) throws IllegalArgumentException
      Sets the value of the component as a double.
      Specified by:
      setValue in interface IUIDoubleValueComponent
      Parameters:
      value - The double value.
      Returns:
      true for value changed, false for no change.
      Throws:
      IllegalArgumentException - If the value is out of range (e.g. for a spinner with value range).