ArchiveOptions

Inheritance: java.lang.Object

public class ArchiveOptions

Provides options for rendering archive files.

Constructors

Constructor Description
ArchiveOptions()

Methods

Method Description
getFolder() The folder inside the archive to be rendered.
setFolder(String value) The folder inside the archive to be rendered.
getFileName() The filename to display in the header.
setFileName(FileName mFileName) The filename to display in the header.
getItemsPerPage() Number of records per page (for rendering to HTML only)
setItemsPerPage(int itemsPerPage) Number of records per page (for rendering to HTML only)

ArchiveOptions()

public ArchiveOptions()

getFolder()

public final String getFolder()

The folder inside the archive to be rendered.

Returns: java.lang.String

setFolder(String value)

public final void setFolder(String value)

The folder inside the archive to be rendered.

Parameters:

Parameter Type Description
value java.lang.String

getFileName()

public FileName getFileName()

The filename to display in the header. By default the name of the source file is displayed.

Returns: FileName - The filename

setFileName(FileName mFileName)

public void setFileName(FileName mFileName)

The filename to display in the header. By default the name of the source file is displayed.

Parameters:

Parameter Type Description
mFileName FileName The filename

getItemsPerPage()

public int getItemsPerPage()

Number of records per page (for rendering to HTML only)

Returns: int

setItemsPerPage(int itemsPerPage)

public void setItemsPerPage(int itemsPerPage)

Number of records per page (for rendering to HTML only)

Parameters:

Parameter Type Description
itemsPerPage int