Summary: Inherited Constants | Methods | Inherited Methods | [Expand All]

public interface

FormatTabBean

implements TabBean

com.microstrategy.web.app.beans.FormatTabBean

Known Indirect Subclasses

FormatColorLinesTabBean, FormatNumberTabBean

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

[Expand]

Inherited Constants

From interface com.microstrategy.web.app.beans.AppComponent

From interface com.microstrategy.web.app.beans.TabBean

Public Methods
abstract String	getSelectedTypes() set the list of object types selected in the client.
abstract int	getTargetAxis() Get the axis where the target is located
abstract int	getTargetLevel() Get the level at which the formatting will be applied
abstract int	getTargetPosition() Get the position in the axis where the target is located
abstract void	setSelectedTypes(String selectedTypes) Set the list of object types selected in the client.
abstract void	setTargetAxis(int axis) Set the axis where the target is located
abstract void	setTargetLevel(int level) Set the level at which the formatting will be applied
abstract void	setTargetPosition(int position) Set the position in the axis where the target is located

[Expand]

Inherited Methods

From interface com.microstrategy.web.app.beans.AppComponent

abstract AppContext	getAppContext() This method returns the application context object associated with this component.
abstract String	getDescriptor(String key) Retrieve the descriptor when the key is a string
abstract String	getDescriptor(int key) Retrieve the descriptor when the key is an integer value...
abstract EventManager	getEventManager() This method returns the application EventManager used to generates events.
abstract String	getExtraInput() Get any extra input form information to be used when generating form information on the transforms associated with this instance.
abstract String	getExtraUrl() Get any extra url information to be used when generating link information on the transforms associated with this instance.
abstract int	getLeft() Get the left position where the bean should be displayed by the transform if applicable
abstract int	getResultFilterMode()
abstract int	getTop() Get the top position where the bean should be displayed by the transform if applicable
abstract boolean	isDialog() Returns true if this bean should be treated as a dialog
abstract boolean	isForcedChildrenStateSaving() Return whether the state will be save despite it's open or closed state.
abstract boolean	isModal() Retrieves the modal state of the bean
abstract boolean	isModalOpen() indicates whether there is a Modal AppComponent open in the hierarchy
abstract boolean	isOpen() Retrieves the open/close state of the bean
abstract void	setExtraInput(String newValue) Set any extra input form information to be used when generating form information on the transforms associated with this instance.
abstract void	setExtraUrl(String newValue) Set any extra url information to be used when generating link information on the transforms associated with this instance.
abstract void	setForcedChildrenStateSaving(boolean value) Forces the bean state to be save despite it's open or closed state.
abstract void	setHasJustOpened(boolean value) Sets whether the component has just been opened.
abstract void	setIsDialog(boolean value) Sets the bean to its dialog mode.
abstract void	setIsModal(boolean value) Sets the bean to its modal mode.
abstract void	setIsOpen(boolean value) Sets the bean to its enabled mode, meaning the editor will be visible to the user
abstract void	setLeft(int x) Set the left position where the bean should be displayed by the transform if applicable.
abstract void	setTop(int y) Set the top position where the bean should be displayed by the transform if applicable.

From interface com.microstrategy.web.app.beans.TabBean

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`.

From interface com.microstrategy.web.app.beans.ViewBeanParserBean

From interface com.microstrategy.web.beans.Transformable

From interface com.microstrategy.web.beans.WebComponent

abstract void	addChild(String key, WebComponent child) adds a child WebComponent instance on the current WebComponent.
abstract void	addChildStateInfo(ParameterBuilder paramBldr) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	addChildStateInfo(ParameterBuilder paramBldr, int howMuchState) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	collectData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
abstract void	collectMinimalData() This is similar to `collectData()` except data collected is minimal.
abstract MarkupOutput	generateOutput() This is the generic method to ask the WebComponent to generate some output for the client.
abstract BeanContext	getBeanContext() Returns an instance of `BeanContext`.
abstract WebComponent	getChild(String key) Returns the child WebComponent instance specified by the key.
abstract WebComponent	getChild(int index) Returns the child WebComponent instance specified by the index.
abstract WebComponent	getChildByClass(Class className) Returns the child WebComponent instance specified by the class.
abstract WebComponent	getChildByType(int childType) Returns the child WebComponent instance specified by the component type(`EnumWebTransformableType`).
abstract int	getChildCount() Returns the total number of children on the current WebComponent.
abstract void	getChildrenByClass(Class className, HashList retList, boolean recursive) Returns a collection of children specified by the class name
abstract int	getDefaultStateLevel() Returns the default state level for the WebComponent.
abstract WebFeatures	getFeaturesManager() Return the WebFeatures implementation associated with this WebComponent
abstract int	getMaximumStateLevel() Returns the maximum state level that is supported by the WebComponent.
abstract String	getName() Returns the name of the current WebComponent.
abstract int	getOutputFormat() Returns the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract WebComponent	getParent() Returns the parent WebComponent of the current WebComponent.
abstract String	getPath() Returns the path from the root WebComponent to the current WebComponent.
abstract int	getPersistMode() Returns the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract Set	getRenderingFilter() returns the rendering filter.
abstract WebComponent	getRoot() Returns the root of the current WebComponent.
abstract WebComponent	getTargetBean() Get the target bean associated with this instance
abstract String	getTargetBeanPath()
abstract WebEvent	getWebEvent(int event, boolean recurse) Returns the `WebEvent` instance with the specified event ID.
abstract WebEvent	getWebEvent(int event) Returns the `WebEvent` instance with the specified event ID.
abstract WebEventHandler	getWebEventHandler() Returns the `WebEventHandler` instance associated with the current WebComponent.
abstract int	getXMLStatus() This method returns the `EnumRequestStatus` status of the current Component.
abstract boolean	handleRequest(RequestKeys keys) Handles a request.
abstract boolean	hasChanged() Verifies the state of the component has changed
abstract boolean	hasJustOpened() Verifies if the component has just been opened.
abstract void	initBean() Initialize the component after it's created and its properties initialized
abstract void	invalidateChildrenState() Invalidates the cached URL and hidden INPUT states of all the components, including the current component, along the path to the root component.
abstract boolean	isBeanContextEmpty() Verifies if a bean context exists for the current WebComponent.
abstract boolean	isFeatureAvailable(String featureID) Verifies the feature provided is accesible based on the properties of this WebComponent
abstract void	prepareForReuse() If a Web Component instance is going to be reused across different requests, this API serves as a notifier to the component to do the necessary cleanup.
abstract WebComponent	removeChild(String key) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	removeChild(WebComponent component) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	searchChild(String key) Returns the child WebComponent instance specified by the key.
abstract void	setBeanContext(BeanContext beanContext, boolean propagate) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setBeanContext(BeanContext beanContext) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setChanged(boolean value) Sets the changed state of the component.
abstract void	setChanged(boolean value, boolean forceRecurse) Sets the changed state of the component
abstract void	setDefaultStateLevel(int stateLevel) Sets the default state level for the WebComponent.
abstract void	setFeaturesManager(WebFeatures featuresManager) Associate a WebFeatures implementation with this WebComponent
abstract void	setName(String name) Sets the name on the current WebComponent.
abstract void	setOutputFormat(int outputFormat) Sets the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract void	setParent(WebComponent parent) Sets the parent WebComponent of the current WebComponent.
abstract void	setPersistMode(int persistFlag) Sets the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract void	setRenderingFilter(Set renderingFilter) Sets the list of beans to render.
abstract void	setTargetBean(WebComponent bean) Set the target bean that will be associated with this instance.
abstract void	setTargetBeanPath(String beanName) Define the base bean for this instance.
abstract void	setWebEventHandler(WebEventHandler handler) Sets a `WebEventHandler` on this component.

Public Methods

public abstract String getSelectedTypes ()

set the list of object types selected in the client.

Returns

String representing the list of selected objects.

public abstract int getTargetAxis ()

Get the axis where the target is located

Returns

Element from the EnumDSSXMLAxisName enumeration

public abstract int getTargetLevel ()

Get the level at which the formatting will be applied

Returns

Element of the EnumWebFormatType enumeration indicating if the formatting is to be applied at the header, subtotal header, grid or subtotal grid level

public abstract int getTargetPosition ()

Get the position in the axis where the target is located

Returns

the index where the target is located

public abstract void setSelectedTypes (String selectedTypes)

Set the list of object types selected in the client.

Parameters

selectedTypes	`String` representing the list of selected objects.

public abstract void setTargetAxis (int axis)

Set the axis where the target is located

Parameters

axis	Element from the `EnumDSSXMLAxisName` enumeration

public abstract void setTargetLevel (int level)

Set the level at which the formatting will be applied

Parameters

level	Element of the `EnumWebFormatType` enumeration indicating if the formatting is to be applied at the header, subtotal header, grid or subtotal grid level

public abstract void setTargetPosition (int position)

Set the position in the axis where the target is located

Parameters

position	the index where the target is located

Interfaces

Classes

Exceptions

FormatTabBean

Class Overview

Summary

Public Methods

public abstract String getSelectedTypes ()

Returns

public abstract int getTargetAxis ()

Returns

public abstract int getTargetLevel ()

Returns

public abstract int getTargetPosition ()

Returns

public abstract void setSelectedTypes (String selectedTypes)

Parameters

public abstract void setTargetAxis (int axis)

Parameters

public abstract void setTargetLevel (int level)

Parameters

public abstract void setTargetPosition (int position)

Parameters