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, 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)	Creates and adds an output file element for the specified 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.

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.

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.

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.

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.

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

Creates and adds an output file element for the specified font.

Parameters:

Parameter	Type	Description
path	java.lang.String	The file path where the font output will be saved.
fontData	IFontData	The font data to be written to the output.
fontStyle	int	The style of the font (e.g., Regular, Bold, Italic).

Returns: IOutputFile - An IOutputFile instance for the generated font.

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.

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.

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.