public class JRFillContext
extends java.lang.Object
The context is created by the master filler and inherited by the subfillers.
JRBaseFiller
Constructor and Description |
---|
JRFillContext()
Constructs a fill context.
|
Modifier and Type | Method and Description |
---|---|
boolean |
cancelRunningQuery()
Cancels the running query.
|
void |
clearRunningQueryExecuter()
Clears the running query executer.
|
<T extends Deduplicable> |
deduplicate(T object)
Search for a duplicate of a given object in the fill context, and add the object
to the context if no duplicate found.
|
void |
ensureMasterPageAvailable()
Ensures that the master page is available when virtualization is used.
|
protected int |
generatedFillerId() |
int |
generateFillElementId()
Generates a fresh fill element Id.
|
JRPrintImage |
getLoadedImage(java.lang.Object source)
Gets a cached image.
|
JasperReport |
getLoadedSubreport(java.lang.Object source)
Gets a cached subreport.
|
JRTemplate |
getLoadedTemplate(java.lang.Object source)
Gets a cached template.
|
FormatFactory |
getMasterFormatFactory() |
java.util.Locale |
getMasterLocale() |
java.util.TimeZone |
getMasterTimeZone() |
JRPrintPage |
getPrintPage()
Returns the current master print page.
|
JRVirtualizationContext |
getVirtualizationContext()
Returns the virtualization context.
|
boolean |
hasLoadedImage(java.lang.Object source)
Checks whether an image given by source has already been loaded and cached.
|
boolean |
hasLoadedSubreport(java.lang.Object source)
Checks whether a subreport given by source has already been loaded and cached.
|
boolean |
hasLoadedTemplate(java.lang.Object source)
Checks whether a template given by source has already been loaded and cached.
|
boolean |
isIgnorePagination()
Decides whether the filling should ignore pagination.
|
boolean |
isUsingVirtualizer()
Decides whether virtualization is used by the filling process.
|
void |
registerLoadedImage(java.lang.Object source,
JRPrintImage image)
Registers an image loaded from a source.
|
void |
registerLoadedSubreport(java.lang.Object source,
JasperReport subreport)
Registers a subreport loaded from a source.
|
void |
registerLoadedTemplate(java.lang.Object source,
JRTemplate template)
Registers a template loaded from a source.
|
void |
setIgnorePagination(boolean ignorePagination)
Sets the flag that decides whether pagination should be ignored during filling.
|
void |
setMasterFormatFactory(FormatFactory masterFormatFactory) |
void |
setMasterLocale(java.util.Locale masterLocale) |
void |
setMasterTimeZone(java.util.TimeZone masterTimeZone) |
void |
setPrintPage(JRPrintPage page)
Sets the current master print page.
|
void |
setRunningQueryExecuter(JRQueryExecuter queryExecuter)
Sets the running query executer.
|
void |
setUsingVirtualizer(boolean usingVirtualizer)
Sets the flag indicating whether a virtualizer is used by the filling process.
|
public boolean hasLoadedImage(java.lang.Object source)
source
- the source of the imagegetLoadedImage(Object)
,
registerLoadedImage(Object, JRPrintImage)
public JRPrintImage getLoadedImage(java.lang.Object source)
source
- the source of the imageregisterLoadedImage(Object, JRPrintImage)
public void registerLoadedImage(java.lang.Object source, JRPrintImage image)
The image is cached for further use.
source
- the source that was used to load the imageimage
- the loaded imagegetLoadedImage(Object)
public boolean hasLoadedSubreport(java.lang.Object source)
source
- the source of the subreportgetLoadedSubreport(Object)
,
registerLoadedSubreport(Object, JasperReport)
public JasperReport getLoadedSubreport(java.lang.Object source)
source
- the source of the subreportregisterLoadedSubreport(Object, JasperReport)
public void registerLoadedSubreport(java.lang.Object source, JasperReport subreport)
The subreport is cached for further use.
source
- the source that was used to load the subreportsubreport
- the loaded subreportgetLoadedSubreport(Object)
public void setUsingVirtualizer(boolean usingVirtualizer)
usingVirtualizer
- whether virtualization is usedisUsingVirtualizer()
public boolean isUsingVirtualizer()
true
if and only if a virtualizer is usedsetUsingVirtualizer(boolean)
,
JRParameter.REPORT_VIRTUALIZER
public void setPrintPage(JRPrintPage page)
page
- the master print pagegetPrintPage()
public JRPrintPage getPrintPage()
setPrintPage(JRPrintPage)
public void setIgnorePagination(boolean ignorePagination)
ignorePagination
- isIgnorePagination()
public boolean isIgnorePagination()
setIgnorePagination(boolean)
,
JRParameter.IS_IGNORE_PAGINATION
public void setRunningQueryExecuter(JRQueryExecuter queryExecuter)
This method is called before firing the query.
queryExecuter
- the running query executerpublic void clearRunningQueryExecuter()
This method is called after the query has ended.
public boolean cancelRunningQuery() throws JRException
true
if and only if there is a running query and it has been canceled.JRException
public void ensureMasterPageAvailable()
public JRVirtualizationContext getVirtualizationContext()
public FormatFactory getMasterFormatFactory()
public void setMasterFormatFactory(FormatFactory masterFormatFactory)
public java.util.Locale getMasterLocale()
public void setMasterLocale(java.util.Locale masterLocale)
public java.util.TimeZone getMasterTimeZone()
public void setMasterTimeZone(java.util.TimeZone masterTimeZone)
public boolean hasLoadedTemplate(java.lang.Object source)
source
- the source of the templategetLoadedTemplate(Object)
,
registerLoadedTemplate(Object, JRTemplate)
public JRTemplate getLoadedTemplate(java.lang.Object source)
source
- the source of the templageregisterLoadedTemplate(Object, JRTemplate)
public void registerLoadedTemplate(java.lang.Object source, JRTemplate template)
The template is cached for further use.
source
- the source that was used to load the templatetemplate
- the loaded templagegetLoadedTemplate(Object)
public <T extends Deduplicable> T deduplicate(T object)
object
- the object to be searched or addedpublic int generateFillElementId()
JRPrintElement.getSourceElementId()
protected int generatedFillerId()
© 2001-2010 Jaspersoft Corporation www.jaspersoft.com