com.groupdocs.conversion.converter.options
Class ImageSaveOptions

java.lang.Object
  extended by com.groupdocs.conversion.converter.options.ImageSaveOptions
All Implemented Interfaces:
com.groupdocs.conversion.converter.options.etc.SaveOptions

public class ImageSaveOptions
extends Object
implements com.groupdocs.conversion.converter.options.etc.SaveOptions

Author:
Alex Bobkov

Field Summary
static FileType BMP
           
static FileType GIF
           
static FileType JPEG
           
static FileType JPG
           
static FileType PNG
           
static FileType TIF
           
static FileType TIFF
           
 
Constructor Summary
ImageSaveOptions()
           
 
Method Summary
 Integer getHeight()
          Get custom height if was set before
 Integer getPage()
           
 FileType getSaveFileType()
          Get output file type for document conversion if was set before.
 String getSaveName()
          Get custom name if was set before
Default value is null, original document name will be used in this case
 String getSavePath()
          Get custom save directory path for document conversion if was set before.
 Integer getWidth()
          Set custom width if was set before
 boolean isSaveToStream()
           
 void setHeight(Integer height)
          Optional
Set custom height
By default will be converted using image ratio
 void setPage(Integer page)
           
 void setSaveFileType(FileType saveFileType)
          Optional
Set output file type for document conversion
Note: each SaveOption instance contains static values of supported files
 void setSaveName(String saveName)
          Optional
Set custom name for output converted files
 void setSavePath(String savePath)
          Optional
Set custom save directory path for document conversion if was set before.
 void setSaveToStream(boolean saveToStream)
           
 void setWidth(Integer width)
          Optional
Set custom width
By default will be converted using image ratio
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

BMP

public static final FileType BMP

GIF

public static final FileType GIF

JPEG

public static final FileType JPEG

JPG

public static final FileType JPG

PNG

public static final FileType PNG

TIF

public static final FileType TIF

TIFF

public static final FileType TIFF
Constructor Detail

ImageSaveOptions

public ImageSaveOptions()
Method Detail

getSaveFileType

public FileType getSaveFileType()
Description copied from interface: com.groupdocs.conversion.converter.options.etc.SaveOptions
Get output file type for document conversion if was set before.
Default value is null

Specified by:
getSaveFileType in interface com.groupdocs.conversion.converter.options.etc.SaveOptions
Returns:
file type

setSaveFileType

public void setSaveFileType(FileType saveFileType)
Description copied from interface: com.groupdocs.conversion.converter.options.etc.SaveOptions
Optional
Set output file type for document conversion
Note: each SaveOption instance contains static values of supported files

Specified by:
setSaveFileType in interface com.groupdocs.conversion.converter.options.etc.SaveOptions
Parameters:
saveFileType - file type

getSavePath

public String getSavePath()
Description copied from interface: com.groupdocs.conversion.converter.options.etc.SaveOptions
Get custom save directory path for document conversion if was set before.
Default value is null, default save directory from config will be used in this case

Specified by:
getSavePath in interface com.groupdocs.conversion.converter.options.etc.SaveOptions
Returns:
custom path

setSavePath

public void setSavePath(String savePath)
Description copied from interface: com.groupdocs.conversion.converter.options.etc.SaveOptions
Optional
Set custom save directory path for document conversion if was set before.

Specified by:
setSavePath in interface com.groupdocs.conversion.converter.options.etc.SaveOptions
Parameters:
savePath - custom path

getSaveName

public String getSaveName()
Description copied from interface: com.groupdocs.conversion.converter.options.etc.SaveOptions
Get custom name if was set before
Default value is null, original document name will be used in this case

Specified by:
getSaveName in interface com.groupdocs.conversion.converter.options.etc.SaveOptions
Returns:
custom name

setSaveName

public void setSaveName(String saveName)
Description copied from interface: com.groupdocs.conversion.converter.options.etc.SaveOptions
Optional
Set custom name for output converted files

Specified by:
setSaveName in interface com.groupdocs.conversion.converter.options.etc.SaveOptions
Parameters:
saveName - custom name

getPage

public Integer getPage()
Specified by:
getPage in interface com.groupdocs.conversion.converter.options.etc.SaveOptions

setPage

public void setPage(Integer page)
Specified by:
setPage in interface com.groupdocs.conversion.converter.options.etc.SaveOptions

isSaveToStream

public boolean isSaveToStream()
Specified by:
isSaveToStream in interface com.groupdocs.conversion.converter.options.etc.SaveOptions

setSaveToStream

public void setSaveToStream(boolean saveToStream)
Specified by:
setSaveToStream in interface com.groupdocs.conversion.converter.options.etc.SaveOptions

getWidth

public Integer getWidth()
Set custom width if was set before

Returns:
width or null

setWidth

public void setWidth(Integer width)
Optional
Set custom width
By default will be converted using image ratio

Parameters:
width - width

getHeight

public Integer getHeight()
Get custom height if was set before

Returns:
custom height

setHeight

public void setHeight(Integer height)
Optional
Set custom height
By default will be converted using image ratio

Parameters:
height - height or null


Copyright © 2014. All rights reserved.