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

public interface

FormulaBarBean

implements ReportFrameElement TemplateElementsBean

com.microstrategy.web.app.beans.FormulaBarBean

Class Overview

The FormulaBarBean is representing the formular bar for a report page. It's a subcomponent of ReportFrameBean. It can change alias for attributes or metrics, change formula for metrics, add derived metrics.

Summary

[Expand]

Inherited Constants

From interface com.microstrategy.utils.serialization.EnumWebPersistableState

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

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

Public Methods
abstract boolean	allowInsertNewMetric() Check to see if the user is allowed to insert new metric.
abstract String	getActiveAlias() return the active name.
abstract TemplateElement	getActiveElement() Returns the active template element.
abstract int	getActiveElementIndex()
abstract String	getActiveFormula() return the active formula.
abstract String	getActiveUserMetricId() Returns the active User Metric Id.
abstract Boolean	getAggFromBase() return Aggregate from Base flag.
abstract int	getDMMode()
abstract boolean	getDynamicAliasFlag() return the dynamic alias flag.
abstract String	getErrorMessage() Indicates an error description when processing FormularBar events.
abstract ArrayList	getMetricsList() This method is deprecated. The metrics list can be obtained from the working set.
abstract String[][]	getTemplateElementsArray() This method is deprecated. the element array can be obtained using the `getTemplateElementsList()` method.
abstract boolean	isPassThrough()
abstract void	setActiveAlias(String activeAlias) Set the active name.
abstract void	setActiveElementIndex(int activeElementIndex) Set the Active element index.
abstract void	setActiveFormula(String activeFormula) Set the active formula.
abstract void	setActiveUserMetricId(String activeUserMetricId) Set the active User Metric Id.
abstract void	setAggFromBase(Boolean aggFromBase) Set Aggregate from Base flag.
abstract void	setDynamicAliasFlag(boolean dynamicAliasFlag) Set the dynamic alias flag.
abstract void	setErrorMessage(String errMssg) Specify an error description when processing FormularBar events.
abstract void	setPassThrough(boolean value)

[Expand]

Inherited Methods

From interface com.microstrategy.utils.serialization.Persistable

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

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

abstract FrameBean	getFrameBean() Returns the frame bean that is containing this FrameElement.
abstract WebComponent	getTargetBean() Get the target bean associated with this instance
abstract String	getTargetBeanPath()
abstract boolean	getUseIFrame() Indicates whether a ReportFrameElement uses IFrames in its output
abstract boolean	isEditor() Indicates whether a ReportFrameElement most be considered editor.
abstract boolean	isEnabled() Indicates whether a ReportFrameElement is Enabled.
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	setUseIFrame(boolean value) Sets whether a ReportFrameElement should use IFrames in its output

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

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

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

From interface com.microstrategy.web.beans.RequestPersistable

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 boolean allowInsertNewMetric ()

Check to see if the user is allowed to insert new metric.

Returns

boolean true if insertion is allowed

public abstract String getActiveAlias ()

return the active name. It's used to pre-fill the textbox for the Alias textbox.

Returns

the active name.

public abstract TemplateElement getActiveElement ()

Returns the active template element.

Returns

TemplateElement instance.

public abstract int getActiveElementIndex ()

Returns

the Active element index. It's used to pre-select an item in the template elements list

public abstract String getActiveFormula ()

return the active formula. It's used to pre-fill the textbox for the formula textbox.

Returns

the active formula.

public abstract String getActiveUserMetricId ()

Returns the active User Metric Id.

Returns

String Id

public abstract Boolean getAggFromBase ()

return Aggregate from Base flag.

Returns

the Aggregate from Base flag.

public abstract int getDMMode ()

public abstract boolean getDynamicAliasFlag ()

return the dynamic alias flag. It's used to pre-fill the dynamic alias checkbox.

Returns

the active name.

public abstract String getErrorMessage ()

Indicates an error description when processing FormularBar events.

Returns

errMssg Localized error message.

public abstract ArrayList getMetricsList ()

This method is deprecated.
The metrics list can be obtained from the working set.

Returns the list of metrics in the working set

Returns

ArrayList

public abstract String[][] getTemplateElementsArray ()

This method is deprecated.
the element array can be obtained using the getTemplateElementsList() method.

Returns list of elements in template.

Returns

String

public abstract boolean isPassThrough ()

public abstract void setActiveAlias (String activeAlias)

Set the active name. It's used to pre-fill the textbox for the Alias textbox.

Parameters

activeAlias	the alias in String format

public abstract void setActiveElementIndex (int activeElementIndex)

Set the Active element index. It's used to pre-select an item in the template elements list

Parameters

activeElementIndex	the active element index

public abstract void setActiveFormula (String activeFormula)

Set the active formula. It's used to pre-fill the textbox for the Formula textbox.

Parameters

activeFormula	the formula in String format

public abstract void setActiveUserMetricId (String activeUserMetricId)

Set the active User Metric Id.
It's used for indicating which User Metric was selected.

Parameters

activeUserMetricId	The specific User Metric Id to set as active.

public abstract void setAggFromBase (Boolean aggFromBase)

Set Aggregate from Base flag.

Parameters

aggFromBase	the Aggregate from Base flag

public abstract void setDynamicAliasFlag (boolean dynamicAliasFlag)

Set the dynamic alias flag. It's used to pre-fill the dynamic alias checkbox.

Parameters

dynamicAliasFlag	the alias flag in boolean format

public abstract void setErrorMessage (String errMssg)

Specify an error description when processing FormularBar events.

Parameters

errMssg	Localized error message.

Interfaces

Classes

Exceptions

FormulaBarBean

Class Overview

Summary

Public Methods

public abstract boolean allowInsertNewMetric ()

Returns

public abstract String getActiveAlias ()

Returns

public abstract TemplateElement getActiveElement ()

Returns

public abstract int getActiveElementIndex ()

Returns

public abstract String getActiveFormula ()

Returns

public abstract String getActiveUserMetricId ()

Returns

public abstract Boolean getAggFromBase ()

Returns

public abstract int getDMMode ()

public abstract boolean getDynamicAliasFlag ()

Returns

public abstract String getErrorMessage ()

Returns

public abstract ArrayList getMetricsList ()

Returns

public abstract String[][] getTemplateElementsArray ()

Returns

public abstract boolean isPassThrough ()

public abstract void setActiveAlias (String activeAlias)

Parameters

public abstract void setActiveElementIndex (int activeElementIndex)

Parameters

public abstract void setActiveFormula (String activeFormula)

Parameters

public abstract void setActiveUserMetricId (String activeUserMetricId)

Parameters

public abstract void setAggFromBase (Boolean aggFromBase)

Parameters

public abstract void setDynamicAliasFlag (boolean dynamicAliasFlag)

Parameters

public abstract void setErrorMessage (String errMssg)

Parameters

public abstract void setPassThrough (boolean value)