Enum SoImageBackground.Styles

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CENTER
      Image is rendered actual size, centered in the window
      (image aspect ratio is preserved but image may be cropped and background may be visible).
      CROP
      Image is centered and stretched to exactly fill the longer dimension of the viewport (width or height)
      (image aspect ratio is preserved but portions of image will be cropped if the aspect ratio of the image and viewport are different).
      FIT
      Image is centered and stretched to exactly fill the shorter dimension of the viewport (width or height)
      (image aspect ratio is preserved but background color will be visible on sides or top and bottom of the image if the aspect ratio of the image and viewport are different).
      LOWER_LEFT
      Image is rendered actual size in lower left corner
      (image aspect ratio is preserved but image may be cropped and background may be visible).
      LOWER_RIGHT
      Image is rendered actual size in lower right corner
      (image aspect ratio is preserved but image may be cropped and background may be visible).
      NONE
      No image is rendered.
      STRETCH
      Image is stretched to exactly fill the viewport in both directions
      (image aspect ratio is not preserved).
      TILE
      Image is tiled to fill window starting from lower left corner
      (image aspect ratio is preserved).
      UPPER_LEFT
      Image is rendered actual size in upper left corner
      (image aspect ratio is preserved but image may be cropped and background may be visible).
      UPPER_RIGHT
      Image is rendered actual size in upper right corner
      (image aspect ratio is preserved but image may be cropped and background may be visible).
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getValue()
      Returns the integer value of the enum constant.
      static SoImageBackground.Styles valueOf​(int val)
      Returns the enum constant of this type with the specified integer value
      static SoImageBackground.Styles valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static SoImageBackground.Styles[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • CENTER

        public static final SoImageBackground.Styles CENTER
        Image is rendered actual size, centered in the window
        (image aspect ratio is preserved but image may be cropped and background may be visible).
      • LOWER_LEFT

        public static final SoImageBackground.Styles LOWER_LEFT
        Image is rendered actual size in lower left corner
        (image aspect ratio is preserved but image may be cropped and background may be visible).
      • UPPER_LEFT

        public static final SoImageBackground.Styles UPPER_LEFT
        Image is rendered actual size in upper left corner
        (image aspect ratio is preserved but image may be cropped and background may be visible).
      • UPPER_RIGHT

        public static final SoImageBackground.Styles UPPER_RIGHT
        Image is rendered actual size in upper right corner
        (image aspect ratio is preserved but image may be cropped and background may be visible).
      • LOWER_RIGHT

        public static final SoImageBackground.Styles LOWER_RIGHT
        Image is rendered actual size in lower right corner
        (image aspect ratio is preserved but image may be cropped and background may be visible).
      • STRETCH

        public static final SoImageBackground.Styles STRETCH
        Image is stretched to exactly fill the viewport in both directions
        (image aspect ratio is not preserved).
      • TILE

        public static final SoImageBackground.Styles TILE
        Image is tiled to fill window starting from lower left corner
        (image aspect ratio is preserved).
      • CROP

        public static final SoImageBackground.Styles CROP
        Image is centered and stretched to exactly fill the longer dimension of the viewport (width or height)
        (image aspect ratio is preserved but portions of image will be cropped if the aspect ratio of the image and viewport are different).
      • FIT

        public static final SoImageBackground.Styles FIT
        Image is centered and stretched to exactly fill the shorter dimension of the viewport (width or height)
        (image aspect ratio is preserved but background color will be visible on sides or top and bottom of the image if the aspect ratio of the image and viewport are different).
    • Method Detail

      • values

        public static SoImageBackground.Styles[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (SoImageBackground.Styles c : SoImageBackground.Styles.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static SoImageBackground.Styles 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
      • valueOf

        public static SoImageBackground.Styles valueOf​(int val)
        Returns the enum constant of this type with the specified integer value
        Returns:
        the enum constant of this type with the specified integer value.
      • getValue

        public int getValue()
        Description copied from interface: IntegerValuedEnum
        Returns the integer value of the enum constant.
        Specified by:
        getValue in interface IntegerValuedEnum
        Returns:
        the integer value of the enum constant.