Class actuate.viewer.PageContent

A container for the content of a report document file. PageContent contains a comprehensive list of report elements, such as tables, charts, labels, and data items.
Member of: actuate.viewer.

Class Summary
Constructor Attributes	Constructor Name and Description
	actuate.viewer.PageContent() The PageContent class represents the report content generated by a report design file or document file.

Method Summary
Method Attributes	Method Name and Description
	getChartByBookmark(bookmark) Returns the chart element specified by the given bookmark.
	getDataItemByBookmark(bookmark) Returns the data element specified by the given bookmark.
	getFlashObjectByBookmark(bookmark) Returns the flash element specified by the given bookmark.
	getGadgetByBookmark(bookmark) Returns the gadget element specified by the given bookmark.
	getLabelByBookmark(bookmark) Returns the label element specified by the given bookmark.
	getTableByBookmark(bookmark) Returns the table element specified by the given bookmark.
	getTextByBookmark(bookmark) Returns the text element specified by the given bookmark.
	getViewerId() Returns the viewer ID.

Class Detail

actuate.viewer.PageContent()

The PageContent class represents the report content generated by a report design file or document file.

Method Detail

{actuate.report.Chart} getChartByBookmark(bookmark)

Returns the chart element specified by the given bookmark. The following example retrieves the Chart object and changes the chart title:

	this.onclick = function(event){
		var bviewer = this.getViewer( );
		var bpagecontents = bviewer.getCurrentPageContent( );
		var bchart = bpagecontents.getChartByBookmark("ChartBookmark");
		bchart.setChartTitle("Orders By Country (Classic Cars)");
		bchart.submit( );
	}

Parameters:
{String} bookmark: A bookmark to identify a chart element. When the bookmark value is not given, this function returns the first chart element found in the report content.

Returns:: {actuate.report.Chart} chart

{actuate.report.DataItem} getDataItemByBookmark(bookmark)

Returns the data element specified by the given bookmark. Use this function to access the bookmarks for specific elements in the page content. For example, to access the data item mydataitem on the page loaded in the myViewer Viewer object, use the following code:

	var element = myViewer.getCurrentPageContent( ).getDataItemByBookmark("mydataitem");}

Parameters:
{String} bookmark: A bookmark to identify a data element. When the bookmark value is not given, this function returns the first data element found in the report content.

Returns:: {actuate.report.DataItem} data item

{actuate.report.FlashObject} getFlashObjectByBookmark(bookmark)

Returns the flash element specified by the given bookmark. Use this function to access the bookmarks for specific elements in the page content. For example, to access the flash object mymovie on the page loaded in the myViewer Viewer object, use the following code:

	var element = myViewer.getCurrentPageContent( ).getFlashObjectByBookmark("mymovie");}

Parameters:
{String} bookmark: A bookmark to identify a flash element. When the bookmark value is not given, this function returns the first flash element found in the report content.

Returns:: {actuate.report.FlashObject} flashObject

{actuate.report.Gadget} getGadgetByBookmark(bookmark)

Returns the gadget element specified by the given bookmark. Use this function to access the bookmarks for specific elements in the page content. For example, to access the gadget mygadget on the page loaded in the myViewer Viewer object, use the following code:

	var element = myViewer.getCurrentPageContent( ).getGadgetByBookmark("mygadget");}

Parameters:
{String} bookmark: A bookmark to identify a gadget element. When the bookmark value is not given, this function returns the first gadget element found in the report content.

Returns:: {actuate.report.Gadget} gadget

{actuate.report.Label} getLabelByBookmark(bookmark)

Returns the label element specified by the given bookmark. Use this function to access the bookmarks for specific elements in the page content. For example, to access the label mylabel on the page loaded in the myViewer Viewer object, use the following code:

	var element = myViewer.getCurrentPageContent( ).getLabelByBookmark("mylabel");}

Parameters:
{String} bookmark: A bookmark to identify a label element. When the bookmark value is not given, this function returns the first label element found in the report content.

Returns:: {actuate.report.Label}

{actuate.report.Table} getTableByBookmark(bookmark)

Returns the table element specified by the given bookmark. Use this function to access the bookmarks for specific elements in the page content. For example, to access the table mytable on the page loaded in the myViewer Viewer object, use the following code:

	var element = myViewer.getCurrentPageContent( ).getTableByBookmark("mytable");}

Parameters:
{String} bookmark: A bookmark to identify a table element. When the bookmark value is not given, this function returns the first table element found in the report content.

Returns:: {actuate.report.Table} table

{actuate.report.TextItem} getTextByBookmark(bookmark)

Returns the text element specified by the given bookmark. Use this function to access the bookmarks for specific elements in the page content. For example, to access the text element myname on the page loaded in the myViewer Viewer object, use the following code:

	var element = myViewer.getCurrentPageContent( ).getTextByBookmark("myname");}

Parameters:
{String} bookmark: A bookmark to identify a text element. When the bookmark value is not given, this function returns the first text element found in the report content.

Returns:: {actuate.report.TextItem} text item

{String} getViewerId()

Returns the viewer ID.

Returns:: {String} viewer ID

Classes

Class actuate.viewer.PageContent