Module MaterialFX

Enum Class DepthLevel

java.lang.Object
java.lang.Enum<DepthLevel>
io.github.palexdev.materialfx.effects.DepthLevel
All Implemented Interfaces:
Serializable, Comparable<DepthLevel>, java.lang.constant.Constable

public enum DepthLevel extends Enum<DepthLevel>
Enumerator which defines 6 levels of DropShadow effects from LEVEL0 to LEVEL5.
  • Enum Constant Details

  • Method Details

    • values

      public static DepthLevel[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static DepthLevel valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • getColor

      public Color getColor()
    • getRadius

      public double getRadius()
    • getSpread

      public double getSpread()
    • getOffsetX

      public double getOffsetX()
    • getOffsetY

      public double getOffsetY()
    • next

      public DepthLevel next()
      Retrieves the next DepthLevel associated with this enumerator.
      Returns:
      The next DepthLevel
    • from

      public static DepthLevel from(DropShadow shadow)
      Attempts to get the corresponding DepthLevel of the given DropShadow effect. If the given effect is not recognized as being generated by this class the null is returned.

      Uses levelEqualsShadow(DepthLevel, DropShadow) to check for equality.

    • levelEqualsShadow

      public static boolean levelEqualsShadow(DepthLevel level, DropShadow shadow)
      Checks if the given DropShadow effect is equal to the given DepthLevel.