org.kuali.kra.printing.print

Class AbstractPrint

java.lang.Object

org.kuali.kra.printing.print.AbstractPrint

All Implemented Interfaces:

Serializable, Printable

Direct Known Subclasses:

AwardBudgetHierarchyPrint, AwardBudgetHistoryTransactionPrint, AwardDeltaPrint, AwardNoticePrint, AwardTemplatePrint, BudgetCostShareSummaryPrint, BudgetCumulativePrint, BudgetSalaryPrint, BudgetSummaryPrint, BudgetSummaryTotalPrint, BudgetTotalPrint, CoiCertificationPrint, CommitteeFutureScheduledMeetingsPrint, CurrentProposalPrint, IacucCommitteeFutureScheduledMeetingsPrint, IndustrialBudgetPrint, IndustrialCumulativeBudgetPrint, InstitutionalProposalPrint, MoneyAndEndDatesHistoryPrint, NegotiationActivityprint, PendingProposalPrint, PrintCertificationPrint, ProposalLogPrint, ProposalSponsorFormsPrint, ProtocolActionsCorrespondenceBase, ProtocolReportPrint, ProtocolReportPrintBase, QuestionnairePrint, S2SFormPrint, SubAwardSF294Print, SubAwardSF295Print, TemplatePrint, TemplatePrint, TemplatePrintBase

public abstract class AbstractPrint
extends Object
implements Printable

This class provides all the objects required for printing reports. It provides methods for fetching XML generator XmlStream,ResearchDocumentBase, Map of parameters required for printing.

Author:

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractPrint()

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,byte[]>	getAttachments() This method will return the PDF attachments specific to the printable.
protected byte[]	getBytes(org.apache.xmlbeans.XmlObject xmlObject)
KraPersistableBusinessObjectBase	getPrintableBusinessObject() Fetches the ResearchDocumentBase
Map<String,Object>	getReportParameters()
Watermarkable	getWatermarkable() This method for getting the watermark object with respect to the appropriate document.
XmlStream	getXmlStream()
List<Source>	getXSLTemplates() This method provides a way to get the XSL Transform(s) for the KC generated XML.
Map<String,Source>	getXSLTemplateWithBookmarks() This method should be overridden if any printable artifacts wants to send Templates with separate bookmarks.
boolean	isWatermarkEnabled() This method for checking watermark is enable or disable
Map<String,byte[]>	renderXML() This method generates the XML that conforms to Delta Report XSD returns it as InputStream
void	setAttachments(Map<String,byte[]> attachments)
void	setPrintableBusinessObject(KraPersistableBusinessObjectBase printableBusinessObject)
void	setReportParameters(Map<String,Object> reportParameters)
void	setXmlStream(XmlStream xmlStream)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPrint

public AbstractPrint()

Method Detail

getXmlStream

public XmlStream getXmlStream()

Returns:

the xmlStream

setXmlStream

public void setXmlStream(XmlStream xmlStream)

Parameters:

xmlStream - the xmlStream to set

getPrintableBusinessObject

public KraPersistableBusinessObjectBase getPrintableBusinessObject()

Fetches the ResearchDocumentBase

Specified by:

getPrintableBusinessObject in interface Printable

Returns:

ResearchDocumentBase document

setPrintableBusinessObject

public void setPrintableBusinessObject(KraPersistableBusinessObjectBase printableBusinessObject)

Parameters:

printableBusinessObject - the document to set

getReportParameters

public Map<String,Object> getReportParameters()

Returns:

the reportParameters

setReportParameters

public void setReportParameters(Map<String,Object> reportParameters)

Parameters:

reportParameters - the reportParameters to set

getAttachments

public Map<String,byte[]> getAttachments()

Description copied from interface: Printable

This method will return the PDF attachments specific to the printable. During printing the attachments will be added as bookmarks to the output. The Key in the map is used as the name of the bookmark.

Specified by:

getAttachments in interface Printable

Returns:

Map of Attachment pdf bytes with bookmark names.

setAttachments

public void setAttachments(Map<String,byte[]> attachments)

getBytes

protected byte[] getBytes(org.apache.xmlbeans.XmlObject xmlObject)

renderXML

public Map<String,byte[]> renderXML()
                             throws PrintingException

This method generates the XML that conforms to Delta Report XSD returns it as InputStream

Specified by:

renderXML in interface Printable

Returns:

InputStream of generated XML

Throws:

PrintingException - in case of any errors occur during XML generation

getXSLTemplateWithBookmarks

public Map<String,Source> getXSLTemplateWithBookmarks()

This method should be overridden if any printable artifacts wants to send Templates with separate bookmarks.

Specified by:

getXSLTemplateWithBookmarks in interface Printable

getXSLTemplates

public List<Source> getXSLTemplates()

Description copied from interface: Printable

This method provides a way to get the XSL Transform(s) for the KC generated XML. This XSLT will create a transformed XML-FO stream that will be converted to PDF. Note that multiple transforms are possible on this data.

Specified by:

getXSLTemplates in interface Printable

isWatermarkEnabled

public boolean isWatermarkEnabled()

This method for checking watermark is enable or disable

Specified by:

isWatermarkEnabled in interface Printable

Returns:

boolean Value

See Also:

Printable.isWatermarkEnabled()

getWatermarkable

public Watermarkable getWatermarkable()

This method for getting the watermark object with respect to the appropriate document.

Specified by:

getWatermarkable in interface Printable

Returns:

Watermarkable