IPreviewOptions
All Implemented Interfaces: com.groupdocs.merger.domain.options.interfaces.IPageOptions
public interface IPreviewOptions extends IPageOptions
Interface for the preview options.
Methods
| Method | Description |
|---|---|
| getWidth() | Preview width. |
| setWidth(int value) | Preview width. |
| getHeight() | Preview height. |
| setHeight(int value) | Preview height. |
| getResolution() | Image resolution. |
| setResolution(int value) | Image resolution. |
| getMode() | Gets the mode for preview. |
| validate(FileType fileType) | Validates the split options. |
| getPathByPageNumber(int pageNumber, String extension) | Gets the full file path of previewed document by page number with defined extension. |
| getPageStreamFactory() | Delegate that defines method to create output page preview stream. |
getWidth()
public abstract int getWidth()
Preview width.
Returns: int
setWidth(int value)
public abstract void setWidth(int value)
Preview width.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
getHeight()
public abstract int getHeight()
Preview height.
Returns: int
setHeight(int value)
public abstract void setHeight(int value)
Preview height.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
getResolution()
public abstract int getResolution()
Image resolution.
Returns: int
setResolution(int value)
public abstract void setResolution(int value)
Image resolution.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
getMode()
public abstract int getMode()
Gets the mode for preview.
Returns: int
validate(FileType fileType)
public abstract void validate(FileType fileType)
Validates the split options.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| fileType | FileType | The file type of FileType class. |
getPathByPageNumber(int pageNumber, String extension)
public abstract String getPathByPageNumber(int pageNumber, String extension)
Gets the full file path of previewed document by page number with defined extension.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| pageNumber | int | Page number of preview. |
| extension | java.lang.String | Extension of file. |
Returns: java.lang.String - The full file path.
getPageStreamFactory()
public abstract PageStreamFactory getPageStreamFactory()
Delegate that defines method to create output page preview stream.
Returns: PageStreamFactory