|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.crystaldecisions.report.web.ServerControl
com.crystaldecisions.report.web.viewer.ReportServerControl
com.crystaldecisions.report.web.viewer.CrystalReportViewerBase
com.crystaldecisions.report.web.viewer.CrystalReportPartsViewer
public class CrystalReportPartsViewer
This class provides the functionality to view individual report parts, such as chart, text, or field objects. This viewer can also produce output in mobile and PDA format.
Note: Mobile and PDA formats are not supported by the Java Reporting Component. (Java Reporting Component not shipped in Business Objects XI release 3.0)
See the Getting Started > Tutorials section of the Viewer Java SDK Guide for an
example of how to use the CrystalReportPartsViewer
class.
Field Summary |
---|
Fields inherited from class com.crystaldecisions.report.web.viewer.CrystalReportViewerBase |
---|
BACKWARD, FORWARD, NOACTION |
Constructor Summary | |
---|---|
CrystalReportPartsViewer()
|
Method Summary | |
---|---|
void |
addDrillReportPartsEventListener(DrillReportPartsEventListener listener)
Adds a listener for DrillReportPartsEventArgs . |
java.lang.String |
getMobileDevicesCharset()
Deprecated. As of Version 12. Mobile Devices Charset is no longer supported. This method will always return "UTF-8". |
int |
getRecordNumber()
Returns the number of records displayed per page. |
java.lang.Object |
getReportParts()
Returns an Object that defines the report parts to display in the viewer. |
java.lang.String |
getReportTitle()
Returns the title displayed at the top of the viewer. |
int |
getZoomFactor()
Returns the magnification to use when the viewer loads a report. |
boolean |
hasBorder()
Returns whether a border is included when rendering the viewer. |
boolean |
hasPageNavigationLinks()
Returns whether page navigation links are included when rendering the viewer. |
boolean |
isDisplayHeadings()
Returns whether the viewer will display report object names. |
boolean |
isDisplayTitle()
Returns whether the viewer will display the report title. |
boolean |
isEnableDrillDown()
Returns whether the user can drill down on report parts. |
boolean |
isEnableImageForMobileDevices()
Deprecated. As of Version 12. No replacement. |
boolean |
isFirstPage()
Returns whether the current page is the first page. |
boolean |
isLastPage()
Returns whether the current page is the last page. |
boolean |
isPreserveLayout()
Returns whether the page layout is preserved when rendering the report parts. |
boolean |
isRotateSections()
Returns whether the viewer will rotate sections (that is, convert columns to rows or convert rows to columns). |
void |
nextPage()
Displays the next page of the report. |
void |
prevPage()
Displays the previous page of the report. |
void |
removeDrillReportPartsEventListener()
Removes a listener for DrillReportPartsEventArgs . |
void |
setDisplayHeadings(boolean newDisplayHeadings)
Sets whether the viewer will display report object names. |
void |
setDisplayTitle(boolean newDisplayTitle)
Sets whether the viewer will display the report title. |
void |
setEnableDrillDown(boolean enable)
Sets whether the user can drill down on report parts. |
void |
setEnableImageForMobileDevices(boolean value)
Deprecated. As of Version 12. No replacement. |
void |
setHasBorder(boolean border)
Sets whether a border is included when rendering the viewer. |
void |
setHasPageNavigationLinks(boolean newHasPageNavigationButtons)
Sets whether page navigation links are included when rendering the viewer. |
void |
setMobileDevicesCharset(java.lang.String charset)
Deprecated. As of Version 12. Mobile Device Charset is no longer supported. This method has no effect on the viewer. |
void |
setPreserveLayout(boolean preserve)
Sets whether the report page layout is preserved when rendering the report parts. |
void |
setRecordNumber(int recordNumber)
Sets the number of records to display per page. |
void |
setReportParts(java.lang.Object reportParts)
Sets an Object that defines the report parts to display in the viewer. |
void |
setReportTitle(java.lang.String newReportTitle)
Sets the title displayed at the top of the viewer. |
void |
setRotateSections(boolean rotate)
Sets whether the viewer will rotate sections (that is, convert columns to rows or convert rows to columns). |
void |
setZoomFactor(int zoomFactor)
Sets the magnification to use when the viewer loads a report. |
Methods inherited from class com.crystaldecisions.report.web.ServerControl |
---|
getHeight, getHtmlContent, getLeft, getName, getProductLocale, getTop, getURI, getViewState, getWidth, isIgnoreViewStateOnLoad, isOwnForm, isOwnPage, processHttpRequest, setHeight, setIgnoreViewStateOnLoad, setLeft, setName, setOwnForm, setOwnPage, setProductLocale, setTop, setURI, setViewState, setWidth |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CrystalReportPartsViewer()
Method Detail |
---|
public void addDrillReportPartsEventListener(DrillReportPartsEventListener listener) throws java.util.TooManyListenersException
Adds a listener for DrillReportPartsEventArgs
. These events are fired when drilling
down on a report part.
listener
- The DrillReportPartsEventListener
.
java.util.TooManyListenersException
- This is thrown if you attempt to add more than one listener
on a particular listener source concurrently.removeDrillReportPartsEventListener
public int getRecordNumber()
Returns the number of records displayed per page.
Note: The default value is 10.
int
.setRecordNumber
public java.lang.Object getReportParts()
Returns an Object
that defines the report parts to display in the viewer.
Note: Cast the Object
returned as a ReportPartsDefinition
object.
Note: This method is not supported by the Java Reporting Component. (Java Reporting Component not shipped in Business Objects XI release 3.0)
Object
.setReportParts
public java.lang.String getReportTitle()
Returns the title displayed at the top of the viewer.
String
.setReportTitle
public int getZoomFactor()
Returns the magnification to use when the viewer loads a report.
int
.setZoomFactor
public boolean hasBorder()
Returns whether a border is included when rendering the viewer.
true
if a border is included when rendering the viewer and
false
otherwise.setHasBorder
public boolean hasPageNavigationLinks()
Returns whether page navigation links are included when rendering the viewer.
true
if page navigation links are included when rendering the viewer
and false
otherwise.setHasPageNavigationLinks
public boolean isDisplayHeadings()
Returns whether the viewer will display report object names.
true
if the viewer will display report object names and
false
otherwise.setDisplayHeadings
public boolean isDisplayTitle()
Returns whether the viewer will display the report title.
true
if the viewer will display the report title and
false
otherwise.setDisplayTitle
public boolean isEnableDrillDown()
Returns whether the user can drill down on report parts.
true
if the user can drill down on report parts and false
otherwise.setEnableDrillDown
public boolean isEnableImageForMobileDevices()
Returns whether the report part viewer is enabled for mobile devices. If false
the report part viewer will only display text and will not display charts or images for
mobile devices.
true
if images are enabled for mobile devices and false
otherwise.setEnableImageForMobileDevices
public boolean isFirstPage() throws ReportSDKExceptionBase
Returns whether the current page is the first page.
true
the current page is the first page and false
otherwise.
ReportSDKExceptionBase
isLastPage
,
nextPage
,
prevPage
public boolean isLastPage() throws ReportSDKExceptionBase
Returns whether the current page is the last page.
true
the current page is the last page and false
otherwise.
ReportSDKExceptionBase
isFirstPage
,
nextPage
,
prevPage
public boolean isPreserveLayout()
Returns whether the page layout is preserved when rendering the report parts.
true
if the page layout is preserved when rendering the report parts
and false
otherwise.setPreserveLayout
public boolean isRotateSections()
Returns whether the viewer will rotate sections (that is, convert columns to rows or convert rows to columns).
true
if the viewer will rotate sections and false
otherwise.setRotateSections
public void nextPage()
Displays the next page of the report.
Note: If the last page of the report is currently displayed, the viewer remains on this page.
isFirstPage
,
isLastPage
,
prevPage
public void prevPage()
Displays the previous page of the report.
Note: If the first page of the report is currently displayed, the viewer remains on this page.
isFirstPage
,
isLastPage
,
nextPage
public void removeDrillReportPartsEventListener()
Removes a listener for DrillReportPartsEventArgs
. These events are fired when
drilling down on a report part.
addDrillReportPartsEventListener
public void setDisplayHeadings(boolean newDisplayHeadings)
Sets whether the viewer will display report object names.
newDisplayHeadings
- true
to set the viewer to display report object
names.isDisplayHeadings
public void setDisplayTitle(boolean newDisplayTitle)
Sets whether the viewer will display the report title.
newDisplayTitle
- true
to set the viewer to display the report title.isDisplayTitle
public void setEnableDrillDown(boolean enable)
Sets whether the user can drill down on report parts.
enable
- true
to allow the user to drill down on report parts.isEnableDrillDown
public void setEnableImageForMobileDevices(boolean value)
Sets whether the report part viewer is enabled for mobile devices. If false
the report part viewer will only display text and will not display charts or images for
mobile devices.
value
- true
if images are enabled for mobile devices, otherwise
false
isEnableImageForMobileDevices
public void setHasBorder(boolean border)
Sets whether a border is included when rendering the viewer.
border
- true
to include a border when rendering the viewer.hasBorder
public void setHasPageNavigationLinks(boolean newHasPageNavigationButtons)
Sets whether page navigation links are included when rendering the viewer.
newHasPageNavigationButtons
- true
to include page navigation links when
rendering the viewer.hasPageNavigationLinks
public void setPreserveLayout(boolean preserve)
Sets whether the report page layout is preserved when rendering the report parts.
preserve
- true
to preserve the page layout when rendering the report
parts.isPreserveLayout
public void setRecordNumber(int recordNumber)
Sets the number of records to display per page.
Note: The default value is 10.
recordNumber
- An int
that specifies the number of records to display per
page.getRecordNumber
public void setReportParts(java.lang.Object reportParts)
Sets an Object
that defines the report parts to display in the viewer. The
Object
should be an instance of the
ReportPartsDefinition
class.
Note: If set, the setReportParts
method overrides the one specified in
the report. The default value is null
. In the default case, the report must
define the initial report parts.
Note: This method is not supported by the Java Reporting Component. (Java Reporting Component not shipped in Business Objects XI release 3.0)
reportParts
- An Object
that defines the report parts to display in the
viewer.getReportParts
public void setReportTitle(java.lang.String newReportTitle)
Sets the title displayed at the top of the viewer.
Note:
setDisplayTitle
method must be set
to true
in order to display the title.setTitle
method of the
ReportPartsDefinition
class.setReportTitle
method overrides the setTitle
method.
newReportTitle
- A String
that specifies the title displayed at the top
of the viewer.getReportTitle()
public void setRotateSections(boolean rotate)
Sets whether the viewer will rotate sections (that is, convert columns to rows or convert rows to columns).
rotate
- true
to rotate sections in the viewer.isRotateSections
public void setZoomFactor(int zoomFactor)
Sets the magnification to use when the viewer loads a report.
Note: The zoom factor must be set to a value not less than 10 and not greater than 400.
zoomFactor
- An int
that specifies the magnification to use when the
viewer loads a report.getZoomFactor
public java.lang.String getMobileDevicesCharset()
Returns the charset currently set for mobile devices.
String
that specifies the charset currently set for mobile devices.public void setMobileDevicesCharset(java.lang.String charset)
Sets the charset used for mobile devices.
charset
- a String
that specifies the charset to use for mobile devices.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |