Package com.storedobject.report

Class FileCirculationStatus

java.lang.Object

com.storedobject.pdf.PDF

com.storedobject.pdf.PDFReport

com.storedobject.report.FileCirculationStatus

All Implemented Interfaces:

Executable, ContentProducer, ContentType, JSONParameter, Closeable, AutoCloseable, Runnable

public class FileCirculationStatus
extends PDFReport
implements JSONParameter

Nested Class Summary

Nested classes/interfaces inherited from class com.storedobject.pdf.PDF

PDF.ObjectFormTable<T extends StoredObject>, PDF.ObjectTable<T extends StoredObject>, PDF.PDFContent, PDF.Text

Field Summary

Fields inherited from class com.storedobject.pdf.PDF

ORIENTATION_LANDSCAPE, ORIENTATION_PORTRAIT, pageSizes

Constructor Summary

Constructors

Constructor	Description
FileCirculationStatus(Device device)
FileCirculationStatus(Device device, FileData file)
FileCirculationStatus(Device device, FileFolder folder)
FileCirculationStatus(Device device, FileFolder folder, boolean recursive)
FileCirculationStatus(Device device, String folderName)

Method Summary

Modifier and Type	Method	Description
void	generateContent()	Generate the content by writing stuff to the PDF.
Object	getTitleText()	Get the "title text" part that was set by PDFReport.setTitleText(Object).
void	setParameters(JSON json)	If implemented, this method is typically invoked by the tools before a ContentProducer is asked to produce its output.

Methods inherited from class com.storedobject.pdf.PDFReport

createTitleTable, createTitleTable, createTitleTable, createTitleTable, execute, execute, extractContent, getDevice, getLogo, getLogoName, getLogoPosition, getProductLogo, getProductLogoName, getTitle, getTitleTable, getUser, setTitleText, view

Methods inherited from class com.storedobject.pdf.PDF

aboutToAddExternalContent, add, add, add, add, addBlankRow, addBlankRow, addBlankRow, addCentered, addContent, addContent, addContent, addContent, addContent, addContent, addContent, addContent, addContent, addContent, addGap, addHTML, addHTML, addHTML, addHTML, addHTML, addHTML, addImage, addImage, addImage, addingExternalContent, addTitles, addTitles, addTitles, addTitles, addTitles, addTitles, addToTable, addToTable, addToTable, addToTable, addToTable, addToTable, addToTable, addToTable, addToTableCentered, addToTableCentered, chainTo, close, createCell, createCell, createCell, createCell, createCell, createCell, createCell, createCell, createCenteredCell, createCenteredCell, createGraphics, createGraphics, createImage, createImage, createImage, createImage, createImage, createImage, createImage, createImage, createImage, createImageFromHTML, createImageFromHTML, createImageFromHTML, createImageFromHTML, createImageFromSVG, createImageFromSVG, createTable, createTable, createText, createText, createText, createTitleText, createTitleText, createTitleText, drawTable, drawTable, drawTable, dumpError, getBottomMargin, getContent, getContentType, getEntity, getEntityLocation, getEntityName, getFileExtension, getFileName, getFontSize, getFooter, getHeight, getLeftMargin, getPageNumber, getPageOrientation, getPageSize, getPageSize, getPageSizeIndex, getReportFormat, getReportStage, getRightMargin, getTopMargin, getTransactionManager, getWaterMark, getWidth, getY, getY, log, newPage, newReportStage, newReportStage, open, pageCompleted, pageStarted, printAuditTrail, printLetterHeadOnEveryPage, printLetterHeadOnEveryPage, printPageNumber, printPageNumber, printTotalPageNumber, printTotalPageNumber, produce, readContent, setDefaultCellCustomizer, setEntity, setError, setFontSize, setLanguage, setLanguage, setLogo, setLogo, setPageNumber, setPageSizeIndex, setPassword, setReportFormat, setTransactionManager, setWaterMark, showText, toCharCount

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.storedobject.core.ContentProducer

abort, getError, getStreamData, getStreamDataProvider, getSystemEntity, saveTo, saveTo, saveTo, saveTo

Methods inherited from interface com.storedobject.core.ContentType

getLink, getMimeType, isAudio, isHTML, isImage, isLink, isMedia, isPDF, isText, isVideo

Methods inherited from interface com.storedobject.common.Executable

act, run

Constructor Details

FileCirculationStatus

public FileCirculationStatus(Device device)

FileCirculationStatus

public FileCirculationStatus(Device device,
 FileData file)

FileCirculationStatus

public FileCirculationStatus(Device device,
 String folderName)

FileCirculationStatus

public FileCirculationStatus(Device device,
 FileFolder folder)

FileCirculationStatus

public FileCirculationStatus(Device device,
 FileFolder folder,
 boolean recursive)

Method Details

generateContent

public void generateContent()
                     throws Exception

Description copied from class: PDF

Generate the content by writing stuff to the PDF.

Specified by:

generateContent in class PDF

Throws:

Exception - Any exception.

getTitleText

public Object getTitleText()

Description copied from class: PDFReport

Get the "title text" part that was set by PDFReport.setTitleText(Object). (If nothing was ever set, null will be returned.

Overrides:

getTitleText in class PDFReport

Returns:

"Title text" part of the report. (This is used by PDFReport.getTitleTable() method).

setParameters

public void setParameters(JSON json)

Description copied from interface: JSONParameter

If implemented, this method is typically invoked by the tools before a ContentProducer is asked to produce its output. It can extract its required parameter values from the JSON structure.

Specified by:

setParameters in interface JSONParameter

Parameters:

json - JSON containing parameter values.