Package de.gurkenlabs.litiengine

Enum Align

java.lang.Object
java.lang.Enum<Align>
de.gurkenlabs.litiengine.Align
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Align>, java.lang.constant.Constable
public enum Align
extends java.lang.Enum<Align>
The enum Align defines a range of horizontal alignments.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

  • Enum Constant Summary

    Enum Constants 
    Enum ConstantDescription
    CENTER 
    CENTER_LEFT 
    CENTER_RIGHT 
    LEFT 
    RIGHT 

  • Method Summary

    Modifier and TypeMethodDescription
    static Alignget​(java.lang.String alignString)
    Gets the align enumeration value for the specified string.
    doublegetLocation​(double width, double objectWidth)
    Gets the location for the specified object height to be horizontally aligned within the bounds of the specified width.
    doublegetValue​(double width)
    Gets the proportional value of this instance.
    floatgetValue​(float width)
    Gets the proportional value of this instance.
    intgetValue​(int width)
    Gets the proportional value of this instance.
    static AlignvalueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static Align[]values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

  • Method Details

    • values

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

    • valueOf

      public static Align valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null

    • get

      public static Align get​(java.lang.String alignString)
      Gets the align enumeration value for the specified string.
      Parameters:
      alignString - The string representing the enum value.
      Returns:
      The enum value represented by the specified string or CENTER if the specified string is invalid.

    • getValue

      public float getValue​(float width)
      Gets the proportional value of this instance.
      Parameters:
      width - The width to calculate the relative value from.
      Returns:
      The proportional value for the specified height.

    • getValue

      public double getValue​(double width)
      Gets the proportional value of this instance.
      Parameters:
      width - The width to calculate the relative value from.
      Returns:
      The proportional value for the specified height.

    • getValue

      public int getValue​(int width)
      Gets the proportional value of this instance.
      Parameters:
      width - The width to calculate the relative value from.
      Returns:
      The proportional value for the specified height.

    • getLocation

      public double getLocation​(double width, double objectWidth)
      Gets the location for the specified object height to be horizontally aligned within the bounds of the specified width.
      Parameters:
      width - The width, limiting the horizontal alignment.
      objectWidth - The width of the object for which to calculate the horizontally aligned location.
      Returns:
      The x-coordinate for the location of the object with the specified width.