Classes


Class actuate.viewer.UIOptions

The UIOptions class specifies features availability.
Member of: actuate.viewer.

Class Summary
Constructor Attributes Constructor Name and Description
 
The UIOptions class specifies features availability.
Method Summary
Method Attributes Method Name and Description
 
Specifies whether the advanced sort feature must be enabled.
 
Specifies whether the aggregation feature must be enabled.
 
Specifies whether the calculated column feature must be enabled.
 
Specifies whether the chart properties feature must be enabled.
 
Specifies whether the chart subtype selection feature must be enabled.
 
Specifies whether the collapse/expand feature must be enabled.
 
Specifies whether the column editing feature must be enabled.
 
Specifies whether the column resizing feature must be enabled.
 
Specifies whether the data extraction feature must be enabled.
 
Specifies whether the report editing feature must be enabled.
 
Specifies whether the export report feature must be enabled.
 
enableFilter(enabled)
Specifies whether the filter feature must be enabled.
 
enableFormat(enabled)
Specifies whether the format editing feature must be enabled.
 
enableGroupEdit(enabled)
Specifies whether the group editing feature must be enabled.
 
Specifies whether the hide/show item feature must be enabled.
 
enableHighlight(enabled)
Specifies whether the highlight feature must be enabled.
 
Specifies whether the hover highlight feature must be enabled.
 
Specifies whether the "link to this page" feature must be enabled.
 
enableMainMenu(enabled)
Specifies whether the main menu feature must be enabled.
 
enablePageBreak(enabled)
Specifies whether the page break editing feature must be enabled.
 
Specifies whether the page navigation feature must be enabled.
 
Specifies whether the parameter page feature must be enabled.
 
enablePrint(enabled)
Specifies whether the print feature must be enabled.
 
Specifies whether the column reordering feature must be enabled.
 
Specifies whether the report design save feature must be enabled.
 
Specifies whether the report document save feature must be enabled.
 
enableScroll(enabled)
Specifies whether the scrolling feature must be enabled.
 
Specifies whether the scroll control feature must be enabled.
 
Specifies whether the server-side printing feature must be enabled.
 
enableSort(enabled)
Specifies whether the sort feature must be enabled.
 
Specifies whether the duplication suppression feature must be enabled.
 
Specifies whether the switch view feature must be enabled.
 
enableTextEdit(enabled)
Specifies whether the text editing feature must be enabled.
 
enableTOC(enabled)
Specifies whether the table of contents feature must be enabled.
 
enableToolBar(enabled)
Specifies whether the tool bar feature must be enabled.
 
Specifies whether the tool bar help feature must be enabled.
 
Specifies whether the top N and bottom N filter feature must be enabled.
 
Returns the feature map.
Class Detail
actuate.viewer.UIOptions()
The UIOptions class specifies features availability.
Method Detail
enableAdvancedSort(enabled)
Specifies whether the advanced sort feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enableAggregation(enabled)
Specifies whether the aggregation feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enableCalculatedColumn(enabled)
Specifies whether the calculated column feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enableChartProperty(enabled)
Specifies whether the chart properties feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enableChartSubType(enabled)
Specifies whether the chart subtype selection feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enableCollapseExpand(enabled)
Specifies whether the collapse/expand feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enableColumnEdit(enabled)
Specifies whether the column editing feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enableColumnResize(enabled)
Specifies whether the column resizing feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enableDataExtraction(enabled)
Specifies whether the data extraction feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enableEditReport(enabled)
Specifies whether the report editing feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enableExportReport(enabled)
Specifies whether the export report feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enableFilter(enabled)
Specifies whether the filter feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enableFormat(enabled)
Specifies whether the format editing feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enableGroupEdit(enabled)
Specifies whether the group editing feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enableHideShowItems(enabled)
Specifies whether the hide/show item feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enableHighlight(enabled)
Specifies whether the highlight feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enableHoverHighlight(enabled)
Specifies whether the hover highlight feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enableLinkToThisPage(enabled)
Specifies whether the "link to this page" feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enableMainMenu(enabled)
Specifies whether the main menu feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enablePageBreak(enabled)
Specifies whether the page break editing feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enablePageNavigation(enabled)
Specifies whether the page navigation feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enableParameterPage(enabled)
Specifies whether the parameter page feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enablePrint(enabled)
Specifies whether the print feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enableReorderColumns(enabled)
Specifies whether the column reordering feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enableSaveDesign(enabled)
Specifies whether the report design save feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enableSaveDocument(enabled)
Specifies whether the report document save feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enableScroll(enabled)
Specifies whether the scrolling feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enableScrollControl(enabled)
Specifies whether the scroll control feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enableServerPrint(enabled)
Specifies whether the server-side printing feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enableSort(enabled)
Specifies whether the sort feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enableSuppressDuplicate(enabled)
Specifies whether the duplication suppression feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enableSwitchView(enabled)
Specifies whether the switch view feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enableTextEdit(enabled)
Specifies whether the text editing feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enableTOC(enabled)
Specifies whether the table of contents feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enableToolBar(enabled)
Specifies whether the tool bar feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enableToolbarHelp(enabled)
Specifies whether the tool bar help feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

enableTopBottomNFilter(enabled)
Specifies whether the top N and bottom N filter feature must be enabled.
Parameters:
{boolean} enabled
true for enabled, false for disabled.

{Map} getFeatureMap()
Returns the feature map.
Returns:
{Map} feature map

Documentation generated by JsDoc Toolkit 2.0.1 on Tue Jan 19 2010 15:56:28 GMT-0800 (PST)