ImageTransformDto.ImageTransformDtoBuilder (Imageserver Client Module 6.1.0.RELEASE API)

java.lang.Object
- com.foreach.imageserver.dto.ImageTransformDto.ImageTransformDtoBuilder

Enclosing class:: ImageTransformDto

public static class ImageTransformDto.ImageTransformDtoBuilder
extends Object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ImageTransformDto.ImageTransformDtoBuilder`	`alphaColor(ColorDto alphaColor)` Color specification of a color that should be made transparent.
`ImageTransformDto.ImageTransformDtoBuilder`	`aspectRatio(AspectRatio aspectRatio)` The aspect ratio that the resulting image should have.
`ImageTransformDto.ImageTransformDtoBuilder`	`backgroundColor(ColorDto backgroundColor)` Color specification for the background of the image.
`ImageTransformDto`	`build()`
`ImageTransformDto.ImageTransformDtoBuilder`	`colorSpace(ColorSpaceDto colorSpace)` Color space for the resulting image, can for example be used to convert to grayscale.
`ImageTransformDto.ImageTransformDtoBuilder`	`crop(CropDto crop)` Contains the settings for the crop that should be taken from the original image.
`ImageTransformDto.ImageTransformDtoBuilder`	`dpi(Integer dpi)` DPI that should be used for processing the image (and in the resulting output image).
`ImageTransformDto.ImageTransformDtoBuilder`	`height(Integer height)` The height in pixels of the resulting image.
`ImageTransformDto.ImageTransformDtoBuilder`	`maxHeight(Integer maxHeight)` Maximum height of the resulting image.
`ImageTransformDto.ImageTransformDtoBuilder`	`maxWidth(Integer maxWidth)` Maximum width of the resulting image.
`ImageTransformDto.ImageTransformDtoBuilder`	`outputType(ImageTypeDto outputType)` The output type for this transform.
`ImageTransformDto.ImageTransformDtoBuilder`	`quality(Integer quality)` Quality for the created image, relevant for lossy image formats like JPEG.
`ImageTransformDto.ImageTransformDtoBuilder`	`scene(Integer scene)` The specific scene of the source image that should be transformed.
`String`	`toString()`
`ImageTransformDto.ImageTransformDtoBuilder`	`width(Integer width)` The width in pixels of the resulting image.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - scene
```
public ImageTransformDto.ImageTransformDtoBuilder scene(Integer scene)
```
    The specific scene of the source image that should be transformed. Only relevant for multi-scene formats like PDF where a scene corresponds to a page in the PDF. If not specified, the output type will determine if either the entire original image or a specific scene will be used. 0-based.
    
    Returns:
    
    this.
  - width
```
public ImageTransformDto.ImageTransformDtoBuilder width(Integer width)
```
    The width in pixels of the resulting image. If both width and height are not specified, the original image width will be assumed. If height is specified but width is not, a width will be calculated according to the aspect ratio of the original image. Any value smaller than 1 will behave as if width is not specified.
    
    Returns:
    
    this.
  - height
```
public ImageTransformDto.ImageTransformDtoBuilder height(Integer height)
```
    The height in pixels of the resulting image. If both width and height are not specified, the original image height will be assumed. If width is specified but height is not, a height will be calculated according to the aspect ratio of the original image. Any value smaller than 1 will behave as if height is not specified.
    
    Returns:
    
    this.
  - maxWidth
```
public ImageTransformDto.ImageTransformDtoBuilder maxWidth(Integer maxWidth)
```
    Maximum width of the resulting image. Regardless of width, the resulting image will be downscaled to fit in the boundaries box defined by maximum width and height (when specified). Can be used to scale an image to fit inside this box without having to specify width or height.
    
    Returns:
    
    this.
  - maxHeight
```
public ImageTransformDto.ImageTransformDtoBuilder maxHeight(Integer maxHeight)
```
    Maximum height of the resulting image. Regardless of height, the resulting image will be downscaled to fit in the boundaries box defined by maximum width and height (when specified). Can be used to scale an image to fit inside this box without having to specify width or height.
    
    Returns:
    
    this.
  - aspectRatio
```
public ImageTransformDto.ImageTransformDtoBuilder aspectRatio(AspectRatio aspectRatio)
```
    The aspect ratio that the resulting image should have. If both width and height are specified, this parameter will be ignored. If either width or height is specified, the aspect ratio will be used to calculate the other dimension accordingly. If neither width and height is specified, the actual width and height will be calculated by looking at the original image dimensions and using them to get the largest possible values matching the requested aspect ratio.
    
    Returns:
    
    this.
  - dpi
```
public ImageTransformDto.ImageTransformDtoBuilder dpi(Integer dpi)
```
    DPI that should be used for processing the image (and in the resulting output image). A higher DPI will result in larger output files but with much more detail. Equivalent of ImageModificationDto.getDensity() which will most likely be deprecated in the future.
    
    Returns:
    
    this.
  - crop
```
public ImageTransformDto.ImageTransformDtoBuilder crop(CropDto crop)
```
    Contains the settings for the crop that should be taken from the original image. If not specified, no cropping will be applied and the entire original image will be used as the base.
    
    Returns:
    
    this.
  - quality
```
public ImageTransformDto.ImageTransformDtoBuilder quality(Integer quality)
```
    Quality for the created image, relevant for lossy image formats like JPEG. Should be percentage represented as a value between 1 and 100. If not specified, the default quality configured on the application will be used.
    
    Returns:
    
    this.
  - backgroundColor
```
public ImageTransformDto.ImageTransformDtoBuilder backgroundColor(ColorDto backgroundColor)
```
    Color specification for the background of the image. Any alpha channel will be changed to this color. If you want to replace an existing color instead, you can combine with ImageTransformDto.setAlphaColor(ColorDto).
    
    Returns:
    
    this.
  - alphaColor
```
public ImageTransformDto.ImageTransformDtoBuilder alphaColor(ColorDto alphaColor)
```
    Color specification of a color that should be made transparent. Only hex value without the leading # is supported.
    
    Returns:
    
    this.
  - colorSpace
```
public ImageTransformDto.ImageTransformDtoBuilder colorSpace(ColorSpaceDto colorSpace)
```
    Color space for the resulting image, can for example be used to convert to grayscale.
    
    Returns:
    
    this.
  - outputType
```
public ImageTransformDto.ImageTransformDtoBuilder outputType(ImageTypeDto outputType)
```
    The output type for this transform.
    
    Returns:
    
    this.
  - build
```
public ImageTransformDto build()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ImageTransformDto.ImageTransformDtoBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

scene

width

height

maxWidth

maxHeight

aspectRatio

dpi

crop

quality

backgroundColor

alphaColor

colorSpace

outputType

build

toString