Class FloatProperty

All Implemented Interfaces:
Property

public class FloatProperty extends ValueHandlerProperty
A float property.
  • Constructor Details

    • FloatProperty

      public FloatProperty(PropertyGroup group, String name, String description, PropertyValueHandler valueHandler)
      Constructor. Creates an unbounded float property.
      Parameters:
      group - the property group
      name - the property name
      description - the property description
      valueHandler - handles values for this property
    • FloatProperty

      public FloatProperty(PropertyGroup group, String name, String description, PropertyValueHandler valueHandler, float minValue, float maxValue)
      Constructor.
      Parameters:
      group - the property group
      name - the property name
      description - the property description
      valueHandler - handles values for this property
      minValue - the smallest value that this property can have
      maxValue - the largest value that this property can have
    • FloatProperty

      public FloatProperty(PropertyGroup group, String name, String description, PropertyValueHandler valueHandler, float minValue, float maxValue, int preferredDigitCount, float preferredDelta)
      Constructor.
      Parameters:
      group - the property group
      name - the property name
      description - the property description
      valueHandler - handles values for this property
      minValue - the smallest value that this property can have
      maxValue - the largest value that this property can have
      preferredDigitCount - the preferred number of digits to allocate space for in an editor for a property value
      preferredDelta - the preferred amount to increase and decrease a property value by
  • Method Details

    • getPreferredDelta

      public float getPreferredDelta()
      Returns the preferred amount to increase and decrease a property value by.
      Returns:
      the preferred amount to increase and decrease a property value by
    • getMinValue

      public float getMinValue()
      Returns the smallest value that this property can have.
      Returns:
      the smallest value that this property can have
    • getMaxValue

      public float getMaxValue()
      Returns the largest value that this property can have.
      Returns:
      the largest value that this property can have
    • getPreferredDigitCount

      public int getPreferredDigitCount()
      Returns the preferred number of digits to allocate space for in an editor for a property value.
      Returns:
      the preferred number of digits to allocate space for in an editor for a property value
    • get

      public float get(Object valueContainer)
      Returns the float value of this property in a value container.
      Parameters:
      valueContainer - the value container
      Returns:
      the float value of this property
    • set

      public void set(Object valueContainer, float value)
      Sets the float value of this property in a value container.
      Parameters:
      valueContainer - the value container
      value - the float value
    • canBeAssiged

      public boolean canBeAssiged(Object value)
      Description copied from interface: Property
      Returns true if the value can be assigned to this property.
      Specified by:
      canBeAssiged in interface Property
      Overrides:
      canBeAssiged in class AbstractProperty
      Parameters:
      value - the value to assign
      Returns:
      true if the value can be assigned to this property