Package net.webpdf.wsclient.openapi

Class OperationToolboxImageImage

java.lang.Object

net.webpdf.wsclient.openapi.OperationToolboxImageImage

public class OperationToolboxImageImage
extends Object

The image operation element can be used to export a document as an image.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_BMP
static String	JSON_PROPERTY_FILE_NAME_TEMPLATE
static String	JSON_PROPERTY_GIF
static String	JSON_PROPERTY_JPEG
static String	JSON_PROPERTY_PAGES
static String	JSON_PROPERTY_PNG
static String	JSON_PROPERTY_SVG
static String	JSON_PROPERTY_TIFF

Constructor Summary

Constructors

Constructor	Description
OperationToolboxImageImage()

Method Summary

Modifier and Type	Method	Description
OperationToolboxImageImage	bmp(OperationBmp bmp)
boolean	equals(Object o)
OperationToolboxImageImage	fileNameTemplate(String fileNameTemplate)
@Nullable OperationBmp	getBmp()	Get bmp
@Nullable String	getFileNameTemplate()	When exporting multiple pages, this parameter is used to define the file name that will be used for the generated image files in the ZIP file.
@Nullable OperationGif	getGif()	Get gif
@Nullable OperationJpeg	getJpeg()	Get jpeg
@Nullable String	getPages()	Used to define the page number or page range (e.g., \"1,5-6,9\") that should be converted to an image file format.
@Nullable OperationPng	getPng()	Get png
@Nullable OperationSvg	getSvg()	Get svg
@Nullable OperationTiff	getTiff()	Get tiff
OperationToolboxImageImage	gif(OperationGif gif)
int	hashCode()
OperationToolboxImageImage	jpeg(OperationJpeg jpeg)
OperationToolboxImageImage	pages(String pages)
OperationToolboxImageImage	png(OperationPng png)
void	setBmp(OperationBmp bmp)
void	setFileNameTemplate(String fileNameTemplate)
void	setGif(OperationGif gif)
void	setJpeg(OperationJpeg jpeg)
void	setPages(String pages)
void	setPng(OperationPng png)
void	setSvg(OperationSvg svg)
void	setTiff(OperationTiff tiff)
OperationToolboxImageImage	svg(OperationSvg svg)
OperationToolboxImageImage	tiff(OperationTiff tiff)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

JSON_PROPERTY_BMP

public static final String JSON_PROPERTY_BMP

See Also:

Constant Field Values

JSON_PROPERTY_FILE_NAME_TEMPLATE

public static final String JSON_PROPERTY_FILE_NAME_TEMPLATE

See Also:

Constant Field Values

JSON_PROPERTY_GIF

public static final String JSON_PROPERTY_GIF

See Also:

Constant Field Values

JSON_PROPERTY_JPEG

public static final String JSON_PROPERTY_JPEG

See Also:

Constant Field Values

JSON_PROPERTY_PAGES

public static final String JSON_PROPERTY_PAGES

See Also:

Constant Field Values

JSON_PROPERTY_PNG

public static final String JSON_PROPERTY_PNG

See Also:

Constant Field Values

JSON_PROPERTY_SVG

public static final String JSON_PROPERTY_SVG

See Also:

Constant Field Values

JSON_PROPERTY_TIFF

public static final String JSON_PROPERTY_TIFF

See Also:

Constant Field Values

Constructor Detail

OperationToolboxImageImage

public OperationToolboxImageImage()

Method Detail

bmp

public OperationToolboxImageImage bmp(OperationBmp bmp)

getBmp

@Nullable
public @Nullable OperationBmp getBmp()

Get bmp

Returns:

bmp

setBmp

public void setBmp(OperationBmp bmp)

fileNameTemplate

public OperationToolboxImageImage fileNameTemplate(String fileNameTemplate)

getFileNameTemplate

@Nullable
public @Nullable String getFileNameTemplate()

When exporting multiple pages, this parameter is used to define the file name that will be used for the generated image files in the ZIP file. The file name must include the string \"%d\". This string will be replaced with a consecutive number in the file name.

Returns:

fileNameTemplate

setFileNameTemplate

public void setFileNameTemplate(String fileNameTemplate)

gif

public OperationToolboxImageImage gif(OperationGif gif)

getGif

@Nullable
public @Nullable OperationGif getGif()

Get gif

Returns:

gif

setGif

public void setGif(OperationGif gif)

jpeg

public OperationToolboxImageImage jpeg(OperationJpeg jpeg)

getJpeg

@Nullable
public @Nullable OperationJpeg getJpeg()

Get jpeg

Returns:

jpeg

setJpeg

public void setJpeg(OperationJpeg jpeg)

pages

public OperationToolboxImageImage pages(String pages)

getPages

@Nullable
public @Nullable String getPages()

Used to define the page number or page range (e.g., \"1,5-6,9\") that should be converted to an image file format. If only a single page is defined, the image file will be returned directly. If a range of pages is declared, then the call will return a ZIP file containing all the exported pages. The name of the individual image file (when multiple pages are exported) is defined with the \"fileNameTemplate\" attribute. The \"tif\" format is an exception when exporting multiple pages. When using this format, the \"multipage\" attribute can be used to define whether a multipage TIFF will be generated or whether the individual pages will be exported to a ZIP file (as with the other image file formats).

Returns:

pages

setPages

public void setPages(String pages)

png

public OperationToolboxImageImage png(OperationPng png)

getPng

@Nullable
public @Nullable OperationPng getPng()

Get png

Returns:

png

setPng

public void setPng(OperationPng png)

svg

public OperationToolboxImageImage svg(OperationSvg svg)

getSvg

@Nullable
public @Nullable OperationSvg getSvg()

Get svg

Returns:

svg

setSvg

public void setSvg(OperationSvg svg)

tiff

public OperationToolboxImageImage tiff(OperationTiff tiff)

getTiff

@Nullable
public @Nullable OperationTiff getTiff()

Get tiff

Returns:

tiff

setTiff

public void setTiff(OperationTiff tiff)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object