Output

Inheritance: java.lang.Object

public final class Output

Represents a collection of output elements for IWebDocument.

Methods

MethodDescription
add(String path, String templateKey, TContextObject contextObject)Adds an output element for the context object.
add(String path, IPPImage image)Adds an output element for the image.
add(String path, BufferedImage image)Adds an output element for the image.
add(String path, IImage image)Adds an output element for the image.
add(String path, IVideo video)Adds an output element for the video.
add(String path, IFontData fontData, int fontStyle)Adds an output element for the font.
add(String path, String textContent)Adds an output element for the text content.
bindResource(IOutputFile outputFile, Object obj)Binds resource to output file.
getResourcePath(Object obj)Returns the path for a given resource.

add(String path, String templateKey, TContextObject contextObject)

public final IOutputFile <TContextObject>add(String path, String templateKey, TContextObject contextObject)

Adds an output element for the context object.

Parameters:

ParameterTypeDescription
pathjava.lang.StringOutput path.
templateKeyjava.lang.StringThe key of the template used for context object transformation before output.
contextObjectTContextObjectContext object.

Returns: IOutputFile - IOutputFile object for the context object.

add(String path, IPPImage image)

public final IOutputFile add(String path, IPPImage image)

Adds an output element for the image.

Parameters:

ParameterTypeDescription
pathjava.lang.StringOutput path.
imageIPPImageImage to output.

Returns: IOutputFile - IOutputFile object for the image.

add(String path, BufferedImage image)

public final IOutputFile add(String path, BufferedImage image)

Adds an output element for the image.

Parameters:

ParameterTypeDescription
pathjava.lang.StringOutput path.
imagejava.awt.image.BufferedImageImage to output.

Returns: IOutputFile - IOutputFile object for the image.

add(String path, IImage image)

public final IOutputFile add(String path, IImage image)

Adds an output element for the image.

Parameters:

ParameterTypeDescription
pathjava.lang.StringOutput path.
imageIImageImage to output.

Returns: IOutputFile - IOutputFile object for the image.

add(String path, IVideo video)

public final IOutputFile add(String path, IVideo video)

Adds an output element for the video.

Parameters:

ParameterTypeDescription
pathjava.lang.StringOutput path.
videoIVideoVideo to output.

Returns: IOutputFile - IOutputFile object for the video.

add(String path, IFontData fontData, int fontStyle)

public final IOutputFile add(String path, IFontData fontData, int fontStyle)

Adds an output element for the font.

Parameters:

ParameterTypeDescription
pathjava.lang.StringOutput path.
fontDataIFontDataFont to output.
fontStyleintFont style.

Returns: IOutputFile - IOutputFile object for the font.

add(String path, String textContent)

public final IOutputFile add(String path, String textContent)

Adds an output element for the text content.

Parameters:

ParameterTypeDescription
pathjava.lang.StringOutput path.
textContentjava.lang.StringContent to output.

Returns: IOutputFile - IOutputFile object for the text content.

bindResource(IOutputFile outputFile, Object obj)

public final void bindResource(IOutputFile outputFile, Object obj)

Binds resource to output file.

Parameters:

ParameterTypeDescription
outputFileIOutputFileOutput file.
objjava.lang.ObjectResource object.

getResourcePath(Object obj)

public final String getResourcePath(Object obj)

Returns the path for a given resource.

Parameters:

ParameterTypeDescription
objjava.lang.ObjectResource object.

Returns: java.lang.String - Resource path.