Class actuate.dashboard.Tab

Description

The actuate.dashboard.Tab class is a wrapper class for the raw definition of a tab in a dashboard file.

Constructor

Syntax

actuate.dashboard.Tab( )

Constructs a new Tab object.

Function summary

Table 4-8 lists the actuate.dashboard.Tab functions.

Table 4-8  actuate.dashboard.Tab functions

Function	Description
getName( )	Returns the tab’s name.
getTabType( )	Returns the tab’s type.
getTitle( )	Returns the tab’s title.

actuate.dashboard.Tab.getName

Syntax

string Tab.getName( )

Returns the tab’s name.

Returns

String. The name of the tab.

Example

This example calls getName( ) to display the tab object’s name in an alert box.

alert(myTab.getName( ));

actuate.dashboard.Tab.getTabType

Syntax

string Tab.getTabType( )

Returns the tab’s type.

Returns

String. The tab’s type. The legal type values are ISystemTabHandle and ITabHandle.

Example

This example calls getTabType( ) to display the tab object’s type in an alert box.

alert(myTab.getName( ));

actuate.dashboard.Tab.getTitle

Syntax

string Tab.getTitle( )

Returns the tab’s title.

Returns

String. The title of the tab.

Example

This example calls getTitle( ) to display the tab object’s title in an alert box.

alert(myTab.getTitle( ));

(c) Copyright Actuate Corporation 2011