Output

Inheritance: java.lang.Object

public final class Output

Represents a collection of output elements for IWebDocument.

Methods

Method	Description
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:

Parameter	Type	Description
path	java.lang.String	Output path.
templateKey	java.lang.String	The key of the template used for context object transformation before output.
contextObject	TContextObject	Context 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:

Parameter	Type	Description
path	java.lang.String	Output path.
image	IPPImage	Image 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:

Parameter	Type	Description
path	java.lang.String	Output path.
image	java.awt.image.BufferedImage	Image 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:

Parameter	Type	Description
path	java.lang.String	Output path.
image	IImage	Image 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:

Parameter	Type	Description
path	java.lang.String	Output path.
video	IVideo	Video 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:

Parameter	Type	Description
path	java.lang.String	Output path.
fontData	IFontData	Font to output.
fontStyle	int	Font 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:

Parameter	Type	Description
path	java.lang.String	Output path.
textContent	java.lang.String	Content 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:

Parameter	Type	Description
outputFile	IOutputFile	Output file.
obj	java.lang.Object	Resource object.

getResourcePath(Object obj)

public final String getResourcePath(Object obj)

Returns the path for a given resource.

Parameters:

Parameter	Type	Description
obj	java.lang.Object	Resource object.

Returns: java.lang.String - Resource path.