public interface

TabBean

implements ViewBeanParserBean
com.microstrategy.web.app.beans.TabBean
Known Indirect Subclasses

Class Overview

This interface shall be used as base for creating tab beans that can be displayed by a TabManagerBean instance or on their own.

Summary

Constants
int CACHED
int FETCH
int TAB_REPRESENTED_NOT_SPECIFIED Constant to represent the tab identifier this instance represents has not been specified yet
[Expand]
Inherited Constants
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract String getEnabledCmdId()
Get the command id to be queried on the clioent site.
abstract String getFeatures()
Gets a list of feature ids that are required to enable the tab
abstract String getHelpTopic()
get the help topic of this tab
abstract String getHelpType()
get the type of the help file
abstract boolean getRequireSingleSelector()
Each instance of this class represents a tab in the TabManagerBean.
abstract String getSupportedTypes()
Get the list of objects this tab can be associated with.
abstract int getSwitchMode()
Gets the switch mode of the tab bean
abstract String getTabId()
Returns a string can be used as the identifier of the tab.
abstract String getTabLabel()
Get the description text to be used as title for the display of the tab.
abstract String getTabLabelId()
Get the identifier of the descriptor to be used as title for the display of the tab.
abstract TabManagerBean getTabManager()
Utility method for obtaining the parent tabe manager associated to this tab
abstract String getTabName()
Each instance of this class represents a tab in the TabManagerBean.
abstract int getTabRepresented()
Each instance of this class represents a tab in the TabManagerBean.
abstract ViewBean getViewBean()
Utility method for obtaining the ViewBean indicated as target bean for this tab instance.
abstract boolean isAvailable()
This method specifies if in the current scenario, the bean instance can be displayed as possible tab option, based on granted privileges, etc.
abstract boolean isPartialUpdate()
abstract void setEnabledCmdId(String value)
Set the command id to be queried on the client site.
abstract void setFeatures(String featureIds)
Sets a list of feature ids that are required to enable the tab
abstract void setHelpTopic(String topic)
set the help topic of the editor
abstract void setHelpType(String type)
set the help type for the editor
abstract void setPartialUpdate(boolean paritalUpdate)
abstract void setRequireSingleSelector(boolean requireSingleSelector)
Each instance of this class represents a tab in the TabManagerBean.
abstract void setSupportedTypes(String supportedTYpes)
Set the list of objects this tab can be associated with.
abstract void setSwitchMode(int switchMode)
Sets the switch mode of the tab bean (client side switch or server side switch)
abstract void setTabLabel(String description)
Set the description text to be used as title for the display of the tab.
abstract void setTabLabelId(String descriptionId)
Set the identifier of the descriptor to be used as title for the display of the tab.
abstract void setTabName(String tabName)
Each instance of this class represents a tab in the TabManagerBean.
abstract void setTabRepresented(int tab)
Each instance of this class represents a tab in the TabManagerBean.
[Expand]
Inherited Methods
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.ViewBeanParserBean
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Constants

public static final int CACHED

Constant Value: 0 (0x00000000)

public static final int FETCH

Constant Value: 1 (0x00000001)

public static final int TAB_REPRESENTED_NOT_SPECIFIED

Constant to represent the tab identifier this instance represents has not been specified yet

Constant Value: -999 (0xfffffc19)

Public Methods

public abstract String getEnabledCmdId ()

Get the command id to be queried on the clioent site. This determines the availability of the tab.

Returns
  • String with the tab's command id.

public abstract String getFeatures ()

Gets a list of feature ids that are required to enable the tab

Returns
  • String

public abstract String getHelpTopic ()

get the help topic of this tab

Returns
  • the help topic of this tab needs to point to

public abstract String getHelpType ()

get the type of the help file

Returns

public abstract boolean getRequireSingleSelector ()

Each instance of this class represents a tab in the TabManagerBean. This method inidicates whether this tab instance's availability relies on the selection of exactly one selector control among all the units the user has selected.

Returns
  • indicates whether a single selection on selector control is required for the tab to be available or not.

public abstract String getSupportedTypes ()

Get the list of objects this tab can be associated with.

Returns
  • String with the a list of supported objects.

public abstract int getSwitchMode ()

Gets the switch mode of the tab bean

Returns
  • int

public abstract String getTabId ()

Returns a string can be used as the identifier of the tab.

Returns
  • String with the text to be used as the id of the tab.

public abstract String getTabLabel ()

Get the description text to be used as title for the display of the tab.

Returns
  • String with the text to be used as title of the tab.

public abstract String getTabLabelId ()

Get the identifier of the descriptor to be used as title for the display of the tab.

Returns
  • String with the identifier of the descriptor to be used as title of the tab.

public abstract TabManagerBean getTabManager ()

Utility method for obtaining the parent tabe manager associated to this tab

Returns

public abstract String getTabName ()

Each instance of this class represents a tab in the TabManagerBean. This method allows an alternative other than getTabRepresented() to get which tab this instance presents , so the TabManagerBean manager knows how to transfer render control to the child, depending on which tab name the user requested.

Returns
  • the name identifier of the tab this instance represents

public abstract int getTabRepresented ()

Each instance of this class represents a tab in the TabManagerBean. This method allows to get which tab this instance will represent, so the TabManagerBean manager knows how to transfer render control to the child, depending on which tab the user requested.

Returns
  • the identifier of the tab this instance represents

public abstract ViewBean getViewBean ()

Utility method for obtaining the ViewBean indicated as target bean for this tab instance.

Returns
  • the ViewBean corresponding to the name specified on the ActiveViewKey property. Returns null if not found (or if bean type is not related with ViewBean).

public abstract boolean isAvailable ()

This method specifies if in the current scenario, the bean instance can be displayed as possible tab option, based on granted privileges, etc.

Returns
  • True if the instance is available for being displayed, if the user were to request it. Returns False otherwise.

public abstract boolean isPartialUpdate ()

public abstract void setEnabledCmdId (String value)

Set the command id to be queried on the client site. This determines the availability of the tab.

public abstract void setFeatures (String featureIds)

Sets a list of feature ids that are required to enable the tab

Parameters
featureIds String featureIds separated by ","

public abstract void setHelpTopic (String topic)

set the help topic of the editor

Parameters
topic the help topic

public abstract void setHelpType (String type)

set the help type for the editor

Parameters
type String is one of HELP_TYPE_ADMIN,HELP_TYPE_USER,HELP_TYPE_CUSTOM

public abstract void setPartialUpdate (boolean paritalUpdate)

public abstract void setRequireSingleSelector (boolean requireSingleSelector)

Each instance of this class represents a tab in the TabManagerBean. This method allows to specify whether this tab instance's availability relies on the selection of exactly one selector control among all the units the user has selected.

Parameters
requireSingleSelector boolean indicating whether a single selection on selector control is required for the tab to be available or not.

public abstract void setSupportedTypes (String supportedTYpes)

Set the list of objects this tab can be associated with.

Parameters
supportedTYpes String list of the associated objectys i.e. obj.103, obj.102

public abstract void setSwitchMode (int switchMode)

Sets the switch mode of the tab bean (client side switch or server side switch)

Parameters
switchMode int

public abstract void setTabLabel (String description)

Set the description text to be used as title for the display of the tab.

Parameters
description String with the text to be used as title of the tab.

public abstract void setTabLabelId (String descriptionId)

Set the identifier of the descriptor to be used as title for the display of the tab.

Parameters
descriptionId String with the identifier of the descriptor to be used as title of the tab.

public abstract void setTabName (String tabName)

Each instance of this class represents a tab in the TabManagerBean. This method allows an alternative other than getTabRepresented() to get which tab this instance presents , so the TabManagerBean manager knows how to transfer render control to the child, depending on which tab name the user requested.

Parameters
tabName the name identifier of the tab this instance represents

public abstract void setTabRepresented (int tab)

Each instance of this class represents a tab in the TabManagerBean. This method allows to specify which tab this instance will represent, so the TabManagerBean manager knows how to transfer render control to the child, depending on which tab the user requested.

Parameters
tab an identifier of the tab this instance represents.