Class actuate.xtabanalyzer.UIOptions
Description
Specifies feature availability for the Interactive Crosstabs viewer.
Constructor
Syntax
void actuate.xtabanalyzer.UIOptions( )
Generates a new UIOptions object to manage the features of the xtabanalyzer.
Function summary
Table 45‑21 lists actuate.xtabanalyzer.UIOptions functions.
Table 45‑21 actuate.xtabanalyzer.UIOptions functions
Function
Description
Enables the cross tab layout view feature
Enables the cube view feature
Enables the filter summary view
Enables the toolbar feature
Enables the toolbar help feature
Enables the toolbar save feature
Enables the toolbar save design feature
Enables the toolbar save document feature
Returns a list of enabled and disabled features
enableCrosstabView
Syntax
void UIOptions.enableCrosstabView(boolean enabled)
Enables or disables the cross tab layout view.
Parameter
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);
}
enableCubeView
Syntax
void UIOptions.enableCubeView(boolean enabled)
Enables or disables the cube view.
Parameter
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);
}
enableFilterSummaryView
Syntax
void UIOptions.enableFilterSummaryView(boolean enabled)
Enables or disables the filter summary view.
Parameter
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);
}
enableToolBar
Syntax
void UIOptions.enableToolBar(boolean enabled)
Enables or disables the toolbar feature.
Parameter
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);
}
enableToolbarHelp
Syntax
void UIOptions.enableToolbarHelp(boolean enabled)
Enables or disables the toolbar help feature.
Parameter
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);
}
enableToolbarSave
Syntax
void UIOptions.enableToolbarSave(boolean enabled)
Enables or disables the toolbar save feature.
Parameter
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);
}
enableToolbarSaveDesign
Syntax
void UIOptions.enableToolbarSaveDesign(boolean enabled)
Enables or disables the toolbar save design feature.
Parameter
enabled
Boolean. A value of true enables this option.
Example
This example enables or disables toolbar save design:
function setToolbarSave(flag){
var uiOptions = new actuate.xtabanalyzer.UIOptions( );
uiOptions.enableToolbarSaveDesign(flag);
myXTabAnalyzer.setUIOptions(uiOptions);
}
enableToolbarSaveDocument
Syntax
void UIOptions.enableToolbarSaveDocument(boolean enabled)
Enables or disables the toolbar save document feature.
Parameter
enabled
Boolean. A value of true enables this option.
Example
This example enables or disables toolbar save document:
function setToolbarSave(flag){
var uiOptions = new actuate.xtabanalyzer.UIOptions( );
uiOptions.enableToolbarSaveDocument(flag);
myXTabAnalyzer.setUIOptions(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. An associative array of string name and Boolean value pairs.
Example
This example retrieves the feature map:
function retrieveFeatureMap( ){
var uiOptions = new actuate.xtabanalyzer.UIOptions( );
var features = uiOptions.getFeatureMap( );
return features;
}