[]
DEMOS DOCS API PRICING
FREE TRIAL
(Showing Draft Content)

ImageLayout

Enum Class ImageLayout

java.lang.Object
java.lang.Enum<ImageLayout>
com.grapecity.documents.excel.drawing.ImageLayout
All Implemented Interfaces:
Serializable, Comparable<ImageLayout>, Constable
public enum ImageLayout extends Enum<ImageLayout>
Specifies how a background image is positioned, scaled, or tiled within its destination rectangle.

Use this enum with IBackgroundPicture.setBackgroundImageLayout(ImageLayout) to control whether the image keeps its aspect ratio, stretches to fill the bounds, fills with clipping, centers within the destination rectangle, or tiles across it.


 IBackgroundPicture picture = null;
 try {
     String imagePath = java.nio.file.Paths.get("Users", "DefaultApps", "Documents", "logo.png").toString();
     picture = worksheet.getBackgroundPictures().addPicture(imagePath, 10, 10, 120, 80);
     picture.setBackgroundImageLayout(ImageLayout.ZoomToFill);
 } catch (Exception e) {
     throw new IllegalStateException("Unable to add sample background picture from file", e);
 }

  • Nested Class Summary

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

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Center
    Specifies the image is centered within the destination rectangle.
    None
    Specifies the image is left-aligned at the top across the destination rectangle.
    Stretch
    Specifies the image is resized to fill the destination dimensions.
    Tile
    Specifies the image is tiled to fill destination dimensions.
    Zoom
    Specifies the image is resized to fit in the destination dimensions while it preserves its native aspect ratio.
    ZoomToFill
    Specifies the image is resized to fill the destination dimensions while it preserves its native aspect ratio.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ImageLayout
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static ImageLayout[]
    values()
    Returns an array containing the constants of this enum class, 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

    • None

      public static final ImageLayout None
      Specifies the image is left-aligned at the top across the destination rectangle.

    • Center

      public static final ImageLayout Center
      Specifies the image is centered within the destination rectangle.

    • Stretch

      public static final ImageLayout Stretch
      Specifies the image is resized to fill the destination dimensions. The aspect ratio is not preserved.

    • Zoom

      public static final ImageLayout Zoom
      Specifies the image is resized to fit in the destination dimensions while it preserves its native aspect ratio.

    • ZoomToFill

      public static final ImageLayout ZoomToFill
      Specifies the image is resized to fill the destination dimensions while it preserves its native aspect ratio. If the aspect ratio of the destination rectangle differs from the source, the source content is clipped to fit in the destination dimensions.

    • Tile

      public static final ImageLayout Tile
      Specifies the image is tiled to fill destination dimensions.

  • Method Details

    • values

      public static ImageLayout[] 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 ImageLayout 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