Package swingtree

Enum Class UI.Span

java.lang.Object
java.lang.Enum<UI.Span>
swingtree.UI.Span
All Implemented Interfaces:
Serializable, Comparable<UI.Span>, Constable, UIEnum<UI.Span>
Enclosing class:
UI
@Immutable public static enum UI.Span extends Enum<UI.Span> implements UIEnum<UI.Span>
Use these enum instances to specify the gradient alignment for various sub styles, like for example the gradient style API exposed by ComponentStyleDelegate.gradient(Configurator) or ComponentStyleDelegate.gradient(Configurator) methods (see UIForAnySwing.withStyle(Styler)).

GradientConf.span(Span) method exposed by methods like ComponentStyleDelegate.gradient(String, Configurator) or ComponentStyleDelegate.gradient(Layer, String, Configurator).

  • Enum Constant Details

    • TOP_LEFT_TO_BOTTOM_RIGHT

      public static final UI.Span TOP_LEFT_TO_BOTTOM_RIGHT

    • BOTTOM_LEFT_TO_TOP_RIGHT

      public static final UI.Span BOTTOM_LEFT_TO_TOP_RIGHT

    • TOP_RIGHT_TO_BOTTOM_LEFT

      public static final UI.Span TOP_RIGHT_TO_BOTTOM_LEFT

    • BOTTOM_RIGHT_TO_TOP_LEFT

      public static final UI.Span BOTTOM_RIGHT_TO_TOP_LEFT

    • TOP_TO_BOTTOM

      public static final UI.Span TOP_TO_BOTTOM

    • LEFT_TO_RIGHT

      public static final UI.Span LEFT_TO_RIGHT

    • BOTTOM_TO_TOP

      public static final UI.Span BOTTOM_TO_TOP

    • RIGHT_TO_LEFT

      public static final UI.Span RIGHT_TO_LEFT

  • Method Details

    • values

      public static UI.Span[] 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 UI.Span 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

    • isDiagonal

      public boolean isDiagonal()
      Use this to check if the alignment is diagonal and not horizontal or vertical.
      Returns:
      true if this alignment is diagonal, false otherwise.