public class ReadOnlyPartJasperPrint extends JasperPrint
EXCEPTION_MESSAGE_KEY_DUPLICATE_STYLE, PROPERTIES_PRINT_TRANSFER_PREFIX, PROPERTY_COLLAPSE_MISSING_BOOKMARK_LEVELS, PROPERTY_CREATE_BOOKMARKS| Constructor and Description |
|---|
ReadOnlyPartJasperPrint(JasperPrint jasperPrint,
PrintPart part,
int startPageIndex,
int endPageIndex) |
| Modifier and Type | Method and Description |
|---|---|
void |
addBookmark(PrintBookmark bookmark)
Adds a new page to the document.
|
void |
addOrigin(JROrigin origin)
Adds a new style to the report origins.
|
void |
addPage(int index,
JRPrintPage page)
Adds a new page to the document, placing it at the specified index.
|
void |
addPage(JRPrintPage page)
Adds a new page to the document.
|
void |
addPart(int pageIndex,
PrintPart part)
Adds a new part to the document.
|
void |
addStyle(JRStyle style)
Adds a new style to the report styles.
|
void |
addStyle(JRStyle style,
boolean isIgnoreDuplicate)
Adds a new style to the report styles.
|
Map<String,JRPrintAnchorIndex> |
getAnchorIndexes() |
List<PrintBookmark> |
getBookmarks() |
Integer |
getBottomMargin() |
JRStyle |
getDefaultStyle()
Returns the default report style.
|
JRDefaultStyleProvider |
getDefaultStyleProvider()
When we want to virtualize pages, we want a style provider that
is not the print object itself.
|
String |
getFormatFactoryClass()
Returns the name of the class implementing the
FormatFactory
interface to use with this document. |
Integer |
getLeftMargin() |
String |
getLocaleCode()
Returns the code of the default
java.util.Locale to be used for the
elements of this print object. |
String |
getName() |
OrientationEnum |
getOrientationValue()
Returns the page orientation.
|
JROrigin[] |
getOrigins()
Gets an array of report origins.
|
List<JROrigin> |
getOriginsList()
Gets a list of report origins.
|
Map<JROrigin,Integer> |
getOriginsMap()
Gets a map of report origins.
|
int |
getPageHeight() |
List<JRPrintPage> |
getPages()
Returns a list of all pages in the filled report.
|
int |
getPageWidth() |
JRPropertiesHolder |
getParentProperties()
Returns the parent properties holder, whose properties are used as defaults
for this object.
|
PrintParts |
getParts()
Returns a list of all parts in the filled report.
|
JRPropertiesMap |
getPropertiesMap()
Returns this object's properties map.
|
String |
getProperty(String propName) |
String[] |
getPropertyNames() |
Integer |
getRightMargin() |
JRStyle[] |
getStyles()
Gets an array of report styles.
|
List<JRStyle> |
getStylesList()
Gets a list of report styles.
|
Map<String,JRStyle> |
getStylesMap()
Gets a map of report styles.
|
String |
getTimeZoneId()
Returns the
ID of the default java.util.TimeZone
to be used for the elements of this print object. |
Integer |
getTopMargin() |
boolean |
hasProperties()
Checks whether the object has any properties.
|
JROrigin |
removeOrigin(JROrigin origin) |
JRPrintPage |
removePage(int index)
Removes a page from the document.
|
PrintPart |
removePart(int pageIndex)
Removes a part from the document.
|
void |
removeProperty(String propName) |
JRStyle |
removeStyle(JRStyle style) |
JRStyle |
removeStyle(String styleName) |
void |
setBookmarks(List<PrintBookmark> bookmarks) |
void |
setBottomMargin(Integer bottomMargin)
Sets the bottom page margin.
|
void |
setDefaultStyle(JRStyle style)
Sets the default report style.
|
void |
setFormatFactoryClass(String formatFactoryClass)
Sets the name of the class implementing the
FormatFactory
interface to use with this document. |
void |
setLeftMargin(Integer leftMargin)
Sets the left page margin.
|
void |
setLocaleCode(String localeCode)
Sets the the code of the default
java.util.Locale to be used for this object. |
void |
setName(String name)
Sets the name of the document.
|
void |
setOrientation(OrientationEnum orientationValue)
Sets the page orientation.
|
void |
setPageHeight(int pageHeight)
Sets the page height.
|
void |
setPageWidth(int pageWidth)
Sets the page width.
|
void |
setProperty(String propName,
String value) |
void |
setRightMargin(Integer rightMargin)
Sets the right page margin.
|
void |
setTimeZoneId(String timeZoneId)
Sets the the
ID of the default java.util.TimeZone
to be used for this object. |
void |
setTopMargin(Integer topMargin)
Sets the top page margin.
|
collectAnchors, getPageFormat, getPageFormat, hasParts, setJasperReportsContextpublic ReadOnlyPartJasperPrint(JasperPrint jasperPrint, PrintPart part, int startPageIndex, int endPageIndex)
public String getName()
getName in class JasperPrintpublic void setName(String name)
JasperPrintsetName in class JasperPrintname - name of the documentpublic int getPageWidth()
getPageWidth in class JasperPrintpublic void setPageWidth(int pageWidth)
JasperPrintsetPageWidth in class JasperPrintpageWidth - page widthpublic int getPageHeight()
getPageHeight in class JasperPrintpublic void setPageHeight(int pageHeight)
JasperPrintsetPageHeight in class JasperPrintpageHeight - page heightpublic Integer getTopMargin()
getTopMargin in class JasperPrintpublic void setTopMargin(Integer topMargin)
JasperPrintsetTopMargin in class JasperPrinttopMargin - top page marginpublic Integer getLeftMargin()
getLeftMargin in class JasperPrintpublic void setLeftMargin(Integer leftMargin)
JasperPrintsetLeftMargin in class JasperPrintleftMargin - left page marginpublic Integer getBottomMargin()
getBottomMargin in class JasperPrintpublic void setBottomMargin(Integer bottomMargin)
JasperPrintsetBottomMargin in class JasperPrintbottomMargin - bottom page marginpublic Integer getRightMargin()
getRightMargin in class JasperPrintpublic void setRightMargin(Integer rightMargin)
JasperPrintsetRightMargin in class JasperPrintrightMargin - right page marginpublic OrientationEnum getOrientationValue()
JasperPrintgetOrientationValue in class JasperPrintPORTRAIT,,
LANDSCAPEpublic void setOrientation(OrientationEnum orientationValue)
JasperPrintsetOrientation in class JasperPrintPORTRAIT,,
LANDSCAPEpublic boolean hasProperties()
JRPropertiesHolderhasProperties in interface JRPropertiesHolderhasProperties in class JasperPrintpublic JRPropertiesMap getPropertiesMap()
JRPropertiesHoldergetPropertiesMap in interface JRPropertiesHoldergetPropertiesMap in class JasperPrintpublic JRPropertiesHolder getParentProperties()
JRPropertiesHoldergetParentProperties in interface JRPropertiesHoldergetParentProperties in class JasperPrintnull if no parentpublic String[] getPropertyNames()
getPropertyNames in class JasperPrintpublic String getProperty(String propName)
getProperty in class JasperPrintpublic void setProperty(String propName, String value)
setProperty in class JasperPrintpublic void removeProperty(String propName)
removeProperty in class JasperPrintpublic JRStyle getDefaultStyle()
JasperPrintgetDefaultStyle in class JasperPrintpublic void setDefaultStyle(JRStyle style)
JasperPrintsetDefaultStyle in class JasperPrintpublic JRDefaultStyleProvider getDefaultStyleProvider()
JasperPrintgetDefaultStyleProvider in class JasperPrintpublic JRStyle[] getStyles()
JasperPrintgetStyles in class JasperPrintpublic List<JRStyle> getStylesList()
JasperPrintgetStylesList in class JasperPrintpublic Map<String,JRStyle> getStylesMap()
JasperPrintgetStylesMap in class JasperPrintpublic void addStyle(JRStyle style) throws JRException
JasperPrintaddStyle in class JasperPrintJRExceptionpublic void addStyle(JRStyle style, boolean isIgnoreDuplicate) throws JRException
JasperPrintaddStyle in class JasperPrintJRExceptionpublic JRStyle removeStyle(String styleName)
removeStyle in class JasperPrintpublic JRStyle removeStyle(JRStyle style)
removeStyle in class JasperPrintpublic JROrigin[] getOrigins()
JasperPrintgetOrigins in class JasperPrintpublic List<JROrigin> getOriginsList()
JasperPrintgetOriginsList in class JasperPrintpublic Map<JROrigin,Integer> getOriginsMap()
JasperPrintgetOriginsMap in class JasperPrintpublic void addOrigin(JROrigin origin)
JasperPrintaddOrigin in class JasperPrintpublic JROrigin removeOrigin(JROrigin origin)
removeOrigin in class JasperPrintpublic PrintParts getParts()
JasperPrintgetParts in class JasperPrintpublic void addPart(int pageIndex,
PrintPart part)
JasperPrintaddPart in class JasperPrintpublic PrintPart removePart(int pageIndex)
JasperPrintremovePart in class JasperPrintpublic List<JRPrintPage> getPages()
JasperPrintgetPages in class JasperPrintpublic void addPage(JRPrintPage page)
JasperPrintaddPage in class JasperPrintpublic void addPage(int index,
JRPrintPage page)
JasperPrintaddPage in class JasperPrintpublic JRPrintPage removePage(int index)
JasperPrintremovePage in class JasperPrintpublic List<PrintBookmark> getBookmarks()
getBookmarks in class JasperPrintpublic void addBookmark(PrintBookmark bookmark)
JasperPrintaddBookmark in class JasperPrintpublic void setBookmarks(List<PrintBookmark> bookmarks)
setBookmarks in class JasperPrintpublic Map<String,JRPrintAnchorIndex> getAnchorIndexes()
getAnchorIndexes in class JasperPrintpublic String getFormatFactoryClass()
JasperPrintFormatFactory
interface to use with this document.getFormatFactoryClass in class JasperPrintpublic void setFormatFactoryClass(String formatFactoryClass)
JasperPrintFormatFactory
interface to use with this document.setFormatFactoryClass in class JasperPrintpublic String getLocaleCode()
JasperPrintjava.util.Locale to be used for the
elements of this print object.
When filling a report, the value of the REPORT_LOCALE parameter
(or the default locale if the parameter has no explicit value)
is saved using this attribute. Some elements (e.g. elements rendered by a subreport)
in the print object can override this default locale.
getLocaleCode in class JasperPrintjava.util.Locale for this objectJRPrintText.getLocaleCode()public void setLocaleCode(String localeCode)
JasperPrintjava.util.Locale to be used for this object.setLocaleCode in class JasperPrintlocaleCode - the locale code, using the java.util.Locale.toString()
convention.JasperPrint.getLocaleCode(),
Locale.toString()public String getTimeZoneId()
JasperPrintID of the default java.util.TimeZone
to be used for the elements of this print object.
When filling a report, the value of the REPORT_TIME_ZONE parameter
(or the default time zine if the parameter has no explicit value)
is saved using this attribute. Some elements (e.g. elements rendered by a subreport)
in the print object can override this default time zone.
getTimeZoneId in class JasperPrintjava.util.TimeZone for this objectJRPrintText.getTimeZoneId()public void setTimeZoneId(String timeZoneId)
JasperPrintID of the default java.util.TimeZone
to be used for this object.setTimeZoneId in class JasperPrinttimeZoneId - the time zone IDJasperPrint.getTimeZoneId(),
TimeZone.getID()Copyright © 2017. All rights reserved.