Class actuate.xtabanalyzer.UIOptions

Description

The UIOptions class specifies feature availability for the xtabanalyzer object.

Constructor

Syntax

void actuate.xtabanalyzer.UIOptions( )

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

Function summary

Table 5-20 lists actuate.xtabanalyzer.UIOptions functions.

Table 5-20  actuate.xtabanalyzer.UIOptions functions 

Function	Description
enableCrosstabView( )	Enables the cross tab layout view feature.
enableCubeView( )	Enables the cube view feature.
enableFilterSummaryView( )	Enables the filter summary view.
enableToolBar( )	Enables the toolbar feature.
enableToolbarHelp( )	Enables the toolbar help feature.
enableToolbarSave( )	Enables the toolbar save feature.
getFeatureMap( )	Returns a list of enabled and disabled features.

actuate.xtabanalyzer.UIOptions.enableCrosstabView

Syntax

void UIOptions.enableCrosstabView(boolean enabled)

Enables or disables the cross tab layout view.

Parameters

enabled

Boolean. True enables this option.

Example

This example enables or disables the cross tab view.

function setCrosstabView(flag){

  var uiOptions = new actuate.xtabanalyzer.UIOptions( );

  uiOptions.enableCrosstabView(flag);

  myXTabAnalyzer.setUIOptions(uiOptions);

}

actuate.xtabanalyzer.UIOptions.enableCubeView

Syntax

void UIOptions.enableCubeView(boolean enabled)

Enables or disables the cube view.

Parameters

enabled

Boolean. A value of true enables this option.

Example

This example enables or disables the cube view.

function setCubeView(flag){

  var uiOptions = new actuate.xtabanalyzer.UIOptions( );

  uiOptions.enableCubeView(flag);

  myXTabAnalyzer.setUIOptions(uiOptions);

}

actuate.xtabanalyzer.UIOptions.
enableFilterSummaryView

Syntax

void UIOptions.enableFilterSummaryView(boolean enabled)

Enables or disables the filter summary view.

Parameters

enabled

Boolean. A value of true enables this option.

Example

This example enables or disables the filter summary view.

function setFilterSummary(flag) {

  var uiOptions = new actuate.xtabanalyzer.UIOptions( );

  uiOptions.enableFilterSummaryView(enabled);

  myXTabAnalyzer.setUIOptions(uiOptions);

}

actuate.xtabanalyzer.UIOptions.enableToolBar

Syntax

void UIOptions.enableToolBar(boolean enabled)

Enables or disables the toolbar feature.

Parameters

enabled

Boolean. A value of true enables this option.

Example

This example enables or disables the toolbar.

function setToolbar(flag){

  var uiOptions = new actuate.xtabanalyzer.UIOptions( );

  uiOptions.enableToolBar(flag);

  myXTabAnalyzer.setUIOptions(uiOptions);

}

actuate.xtabanalyzer.UIOptions.enableToolbarHelp

Syntax

void UIOptions.enableToolbarHelp(boolean enabled)

Enables or disables the toolbar help feature.

Parameters

enabled

Boolean. A value of true enables this option.

Example

This example enables or disables toolbar help.

function setToolbarHelp(flag){

  var uiOptions = new actuate.xtabanalyzer.UIOptions( );

  uiOptions.enableToolbarHelp(flag);

  myXTabAnalyzer.setUIOptions(uiOptions);

}

actuate.xtabanalyzer.UIOptions.enableToolbarSave

Syntax

void UIOptions.enableToolbarSave(boolean enabled)

Enables or disables the toolbar save feature.

Parameters

enabled

Boolean. A value of true enables this option.

Example

This example enables or disables toolbar save.

function setToolbarSave(flag){

  var uiOptions = new actuate.xtabanalyzer.UIOptions( );

  uiOptions.enableToolbarSave(flag);

  myXTabAnalyzer.setUIOptions(uiOptions);

}

actuate.xtabanalyzer.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.

Example

This example retrieves the feature map.

function retrieveFeatureMap( ){

  var uiOptions = new actuate.xtabanalyzer.UIOptions( );

  var features = uiOptions.getFeatureMap( );

  return features;

}

(c) Copyright Actuate Corporation 2011