Class actuate.viewer.UIOptions

Description

The UIOptions class specifies feature availability for the viewer object.

Constructor

Syntax

void actuate.viewer.UIOptions( )

Generates a new UIOptions object to manage the features of the viewer.

Function summary

Table 4-48 lists actuate.viewer.UIOptions functions.

Table 4-48  actuate.viewer.UIOptions functions

Function	Description
enableAdvancedSort( )	Enables the advanced sort feature.
enableAggregation( )	Enables the aggregation feature.
enableCalculatedColumn( )	Enables the calculated column feature.
enableChartProperty( )	Enables the chart properties feature.
enableChartSubType( )	Enables the chart subtype selection.
enableCollapseExpand( )	Enables the collapse/expand feature.
enableColumnEdit( )	Enables the column editing feature.
enableColumnResize( )	Enables the column resizing feature.
enableContentMargin( )	Enables the content margin feature.
enableDataAnalyzer( )	Enables the data analyzer feature.
enableDataExtraction( )	Enables the data extraction feature.
enableEditReport( )	Enables the report editing feature.
enableExportReport( )	Enables the export report feature.
enableFilter( )	Enables the filter feature.
enableFlashGadgetType( )	Enables the flash gadget type change feature.
enableFormat( )	Enables the format editing feature.
enableGroupEdit( )	Enables the group editing feature.
enableHideShowItems( )	Enables the hide/show item feature.
enableHighlight( )	Enables the highlight feature.
enableHoverHighlight( )	Enables the hover highlight feature.
enableLaunchViewer( )	Enables the launch viewer feature.
enableLinkToThisPage( )	Enables the "link to this page" feature.
enableMainMenu( )	Enables the main menu feature.
enableMoveColumn( )	Enables column moving.
enablePageBreak( )	Enables the page break editing feature.
enablePageNavigation( )	Enables the page navigation feature.
enableParameterPage( )	Enables the parameter page feature.
enablePrint( )	Enables the print feature.
enableReorderColumns( )	Enables the column reordering.
enableRowResize( )	Enables row resizing.
enableSaveDesign( )	Enables the report design save feature.
enableSaveDocument( )	Enables the report document save feature.
enableShowToolTip( )	Enables the show tooltip feature.
enableSort( )	Enables the sort feature.
enableSuppressDuplicate( )	Enables the duplication suppression feature.
enableSwitchView( )	Enables the switch view feature.
enableTextEdit( )	Enables the text editing feature.
enableTOC( )	Enables the table of contents feature.
enableToolBar( )	Enables the tool bar feature.
enableToolBarContextMenu( )	Enables the tool bar context menu feature.
enableToolbarHelp( )	Enables the tool bar help feature.
enableTopBottomNFilter( )	Enables the top N and bottom N filter feature.
enableUndoRedo( )	Enables the undo and redo feature.
getFeatureMap( )	Returns a list of enabled and disabled features.

actuate.viewer.UIOptions.enableAdvancedSort

Syntax

void UIOptions.enableAdvancedSort(boolean enabled)

Enables or disables the advanced sort feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the advanced sort feature, use code similar to the following:

viewerOpts.enableAdvancedSort(false);

actuate.viewer.UIOptions.enableAggregation

Syntax

void UIOptions.enableAggregation(boolean enabled)

Enables or disables the aggregation feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the aggregation feature, use code similar to the following:

viewerOpts.enableAggregation(false);

actuate.viewer.UIOptions.enableCalculatedColumn

Syntax

void UIOptions.enableCalculatedColumn(boolean enabled)

Enables or disables the calculated column feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the calculated column feature, use code similar to the following:

viewerOpts.enableCalculatedColumn(false);

actuate.viewer.UIOptions.enableChartProperty

Syntax

void UIOptions.enableChartProperty(boolean enabled)

Enables or disables the chart properties feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the chart properties feature, use code similar to the following:

viewerOpts.enableChartProperty(false);

actuate.viewer.UIOptions.enableChartSubType

Syntax

void UIOptions.enableChartSubType(boolean enabled)

Enables or disables the chart subtype selection feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the chart subtype selection feature, use code similar to the following:

viewerOpts.enableChartSubType(false);

actuate.viewer.UIOptions.enableCollapseExpand

Syntax

void UIOptions.enableCollapseExpand(boolean enabled)

Enables or disables the collapse/expand feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the collapse/expand feature, use code similar to the following:

viewerOpts.enableCollapseExpand(false);

actuate.viewer.UIOptions.enableColumnEdit

Syntax

void UIOptions.enableColumnEdit(boolean enabled)

Enables or disables the column editing feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the column editing feature, use code similar to the following:

viewerOpts.enableColumnEdit(false);

actuate.viewer.UIOptions.enableColumnResize

Syntax

void UIOptions.enableColumnResize(boolean enabled)

Enables or disables the column resizing feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the column resizing feature, use code similar to the following:

viewerOpts.enableColumnResize(false);

actuate.viewer.UIOptions.enableContentMargin

Syntax

void UIOptions.enableContentMargin(boolean enabled)

Enables or disables the content margin feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the content margin feature, use code similar to the following:

viewerOpts.enableContentMargin(false);

actuate.viewer.UIOptions.enableDataAnalyzer

Syntax

void UIOptions.enableDataAnalyzer(boolean enabled)

Enables or disables the data analyzer feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the data analyzer feature, use code similar to the following:

viewerOpts.enableDataAnalyzer(false);

actuate.viewer.UIOptions.enableDataExtraction

Syntax

void UIOptions.enableDataExtraction(boolean enabled)

Enables or disables the data extraction feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the data extraction feature, use code similar to the following:

viewerOpts.enableDataExtraction(false);

actuate.viewer.UIOptions.enableEditReport

Syntax

void UIOptions.enableEditReport(boolean enabled)

Enables or disables the report editing feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the report editing feature, use code similar to the following:

viewerOpts.enableEditReport(false);

actuate.viewer.UIOptions.enableExportReport

Syntax

void UIOptions.enableExportReport(boolean enabled)

Enables or disables the export report feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the export report feature, use code similar to the following:

viewerOpts.enableExportReport(false);

actuate.viewer.UIOptions.enableFilter

Syntax

void UIOptions.enableFilter(boolean enabled)

Enables or disables the filter feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the filter feature, use code similar to the following:

viewerOpts.enableFilter(false);

actuate.viewer.UIOptions.enableFlashGadgetType

Syntax

void UIOptions.enableFlashGadgetType(boolean enabled)

Enables or disables the Flash gadget type change control.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the Flash gadget type change control, use code similar to the following:

viewerOpts.enableFlashGadgetType(false);

actuate.viewer.UIOptions.enableFormat

Syntax

void UIOptions.enableFormat(boolean enabled)

Enables or disables the format editing feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the format editing feature, use code similar to the following:

viewerOpts.enableFormat(false);

actuate.viewer.UIOptions.enableGroupEdit

Syntax

void UIOptions.enableGroupEdit(boolean enabled)

Enables or disables the group editing feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the group editing feature, use code similar to the following:

viewerOpts.enableGroupEdit(false);

actuate.viewer.UIOptions.enableHideShowItems

Syntax

void UIOptions.enableHideShowItems(boolean enabled)

Enables or disables the hide/show item feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the hide/show feature, use code similar to the following:

viewerOpts.enableHideShowItems(false);

actuate.viewer.UIOptions.enableHighlight

Syntax

void UIOptions.enableHighlight(boolean enabled)

Enables or disables the highlight feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the highlight feature, use code similar to the following:

viewerOpts.enableHighlight(false);

actuate.viewer.UIOptions.enableHoverHighlight

Syntax

void UIOptions.enableHoverHighlight(boolean enabled)

Enables or disables the hover highlight feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the hover highlight feature, use code similar to the following:

viewerOpts.enableHoverHighlight(false);

actuate.viewer.UIOptions.enableLaunchViewer

Syntax

void UIOptions.enableLaunchViewer(boolean enabled)

Enables or disables the launch viewer feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the launch viewer feature, use code similar to the following:

viewerOpts.enableLaunchViewer(false);

actuate.viewer.UIOptions.enableLinkToThisPage

Syntax

void UIOptions.enableLinkToThisPage(boolean enabled)

Enables or disables the "link to this page" feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the "link to this page" feature, use code similar to the following:

viewerOpts.enableLinkToThisPage(false);

actuate.viewer.UIOptions.enableMainMenu

Syntax

void UIOptions.enableMainMenu(boolean enabled)

Enables or disables the main menu feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the main menu feature, use code similar to the following:

viewerOpts.enableMainMenu(false);

actuate.viewer.UIOptions.enableMoveColumn

Syntax

void UIOptions.enableMoveColumn(boolean enabled)

Enables or disables the option to move columns.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the option to move columns, use code similar to the following:

viewerOpts.enableMoveColumn(false);

actuate.viewer.UIOptions.enablePageBreak

Syntax

void UIOptions.enablePageBreak(boolean enabled)

Enables or disables the page break editing feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the page break editing feature, use code similar to the following:

viewerOpts.enablePageBreak(false);

actuate.viewer.UIOptions.enablePageNavigation

Syntax

void UIOptions.enablePageNavigation(boolean enabled)

Enables or disables the page navigation feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the page navigation feature, use code similar to the following:

viewerOpts.enablePageNavigation(false);

actuate.viewer.UIOptions.enableParameterPage

Syntax

void UIOptions.enableParameterPage(boolean enabled)

Enables or disables the parameter page feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the parameter page feature, use code similar to the following:

viewerOpts.enableParameterPage(false);

actuate.viewer.UIOptions.enablePrint

Syntax

void UIOptions.enablePrint(boolean enabled)

Enables or disables the print feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the print feature, use code similar to the following:

viewerOpts.enablePrint(false);

actuate.viewer.UIOptions.enableReorderColumns

Syntax

void UIOptions.enableReorderColumns(boolean enabled)

Enables or disables the column reordering feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the column reordering feature, use code similar to the following:

viewerOpts.enableReorderColumns(false);

actuate.viewer.UIOptions.enableRowResize

Syntax

void UIOptions.enableRowResize(boolean enabled)

Enables or disables row resizing.

Parameters

enabled

Boolean. True enables this option.

Example

To disable row resizing, use code similar to the following:

viewerOpts.enableRowResize(false);

actuate.viewer.UIOptions.enableSaveDesign

Syntax

void UIOptions.enableSaveDesign(boolean enabled)

Enables or disables the report design save feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the report design save feature, use code similar to the following:

viewerOpts.enableSaveDesign(false);

actuate.viewer.UIOptions.enableSaveDocument

Syntax

void UIOptions.enableSaveDocument(boolean enabled)

Enables or disables the report document save feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the report document save feature, use code similar to the following:

viewerOpts.enableSaveDocument(false);

actuate.viewer.UIOptions.enableShowToolTip

Syntax

void UIOptions.enableShowToolTip(boolean enabled)

Enables or disables the showing of tooltips.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the showing of tooltips, use code similar to the following:

viewerOpts.enableShowToolTip(false);

actuate.viewer.UIOptions.enableSort

Syntax

void UIOptions.enableSort(boolean enabled)

Enables or disables the sort feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the sort feature, use code similar to the following:

viewerOpts.enableSort(false);

actuate.viewer.UIOptions.enableSuppressDuplicate

Syntax

void UIOptions.enableSuppressDuplicate(boolean enabled)

Enables or disables the duplication suppression feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the duplication suppression feature, use code similar to the following:

viewerOpts.enableSuppressDuplicate(false);

actuate.viewer.UIOptions.enableSwitchView

Syntax

void UIOptions.enableSwitchView(boolean enabled)

Enables or disables the switch view feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the switch view feature, use code similar to the following:

viewerOpts.enableSwitchView(false);

actuate.viewer.UIOptions.enableTextEdit

Syntax

void UIOptions.enableTextEdit(boolean enabled)

Enables or disables the text editing feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the text editing feature, use code similar to the following:

viewerOpts.enableTextEdit(false);

actuate.viewer.UIOptions.enableTOC

Syntax

void UIOptions.enableTOC(boolean enabled)

Enables or disables the table of contents feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the table of contents feature, use code similar to the following:

viewerOpts.enableTOC(false);

actuate.viewer.UIOptions.enableToolBar

Syntax

void UIOptions.enableToolBar(boolean enabled)

Enables or disables the tool bar feature.

Parameters

enabled

Boolean. True enables this option.

Example

This code initializes a new viewer display, using enableToolBar(false) to disable the tool bar.

function initDisplay( ){

  var uioptions = new actuate.viewer.UIOptions( );

  viewer = new actuate.Viewer("viewerpane");

  var viewerwidth = 800;

  var viewerheight = 600;

  viewer.setWidth(viewerwidth);

  viewer.setHeight(viewerheight);

  uioptions.enableToolBar(false);

  viewer.setUIOptions(uioptions);

  document.getElementById("display").disabled = false;

}

actuate.viewer.UIOptions.enableToolbarHelp

Syntax

void UIOptions.enableToolbarHelp(boolean enabled)

Enables or disables the tool bar help feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the tool bar help feature, use code similar to the following:

viewerOpts.enableToolbarHelp(false);

actuate.viewer.UIOptions.enableToolbarContextMenu

Syntax

void UIOptions.enableToolbarContextMenu(boolean enabled)

Enables or disables the context menu feature.

Parameters

enabled

Boolean. True enables this option.

Example

This code initializes a new viewer display, using enableToolbarHelp(true) to enable the tool bar help feature.

function initDisplay( ){

  var uioptions = new actuate.viewer.UIOptions( );

  viewer = new actuate.Viewer("viewerpane");

  var viewerwidth = 800;

  var viewerheight = 600;

  viewer.setWidth(viewerwidth);

  viewer.setHeight(viewerheight);

  uioptions.enableToolBar(true);

  uioptions.enableToolbarHelp(true);

  viewer.setUIOptions(uioptions);

  document.getElementById("display").disabled = false;

}

actuate.viewer.UIOptions.enableTopBottomNFilter

Syntax

void UIOptions.enableTopBottomNFilter(boolean enabled)

Enables or disables the top N and bottom N filter feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the top N and bottom N filter feature, use code similar to the following:

viewerOpts.enableTopBottomNFilter(false);

actuate.viewer.UIOptions.enableUndoRedo

Syntax

void UIOptions.enableUndoRedo(boolean enabled)

Enables or disables the undo and redo feature.

Parameters

enabled

Boolean. True enables this option.

Example

To disable the undo and redo feature, use code similar to the following:

viewerOpts.enableUndoRedo(false);

actuate.viewer.UIOptions.getFeatureMap

Syntax

object UIOptions.getFeatureMap( )

Returns the features and their boolean values as an associative array. This function makes the name of each feature an object property and sets the value of that property to the associated enabled boolean value.

Returns

Object.

(c) Copyright Actuate Corporation 2011