Interface Rendition
-
- All Superinterfaces:
java.lang.AutoCloseable
- All Known Implementing Classes:
BaseRendition
,FileSystemRendition
public interface Rendition extends java.lang.AutoCloseable
ARendition
interface, generated by the render engine that represents incoming content stream and outgoing format of the rendered file.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getPage()
Returns the number of the page represented by this rendition.InputStreamDescriptor
getStream()
Returns the content asInputStreamDescriptor
generated by the render engine.TargetFormat
getTarget()
Returns theTargetFormat
of the rendered file.boolean
isComplete()
-
-
-
Method Detail
-
getStream
InputStreamDescriptor getStream() throws java.lang.Exception
Returns the content asInputStreamDescriptor
generated by the render engine.- Returns:
InputStreamDescriptor
generated by the render engine.- Throws:
java.lang.Exception
-
getTarget
TargetFormat getTarget()
Returns theTargetFormat
of the rendered file. It depends on the render engine, if it renders to the passed format or not. Means, it can be, that you specify to render to PDF, but it returns a multipage tiff.- Returns:
TargetFormat
of the rendered file.
-
getPage
int getPage()
Returns the number of the page represented by this rendition.- Returns:
- page number or -1 if the renditions contains multiple (or all) pages
-
isComplete
boolean isComplete()
- Returns:
- true if this rendition represents a complete document.
-
-