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

public interface

SubtotalsEditorBean

implements ReportFrameElement ViewBeanParserBean

com.microstrategy.web.app.beans.SubtotalsEditorBean

Class Overview

The SubtotalsEditorBean supports the Advanced Sort Editor. It uses an standard microstrategy gui editor. The user will use this editor to select the keys she wants to sort from and the sorting order.

Summary

Constants
String	SUBTOTALS_AVG
String	SUBTOTALS_DISABLED
String	SUBTOTALS_GRAND_TOTAL
String	SUBTOTALS_MAX
String	SUBTOTALS_MIN
String	SUBTOTALS_SUBTOTALS
String	SUBTOTALS_SUM

[Expand]

Inherited Constants

From interface com.microstrategy.utils.serialization.EnumWebPersistableState

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

Public Methods
abstract int	getAllTotalsState(WebTemplateSubtotal subtotal) Return the state of the All Totals checkbox for the given subtotal
abstract Enumeration	getAvailableSubtotals() Returns a collection of `WebTemplateSubtotal` objects that are available for the template.
abstract int	getCurrentSubtotalIndex() Gets the index of the current subtotal being modified by the editor
abstract int	getDisplayOptions(int axis) Returns the position of the subtotals for the specified axis.
abstract int	getGrandTotalsState(WebTemplateSubtotal subtotal) Return the state of the Grand Totals checkbox for the given subtotal
abstract WebTemplateSubtotal	getSubtotal(int index) Returns a `WebTemplateSubtotal` object for the specified index of the subtotal.
abstract int	getSubtotalState(WebTemplateSubtotal subtotal) Gets the state of the subtotal specified.
abstract int	getSubtotalStyleForAxis(WebTemplateSubtotal subtotal, int axisIndex) Gets the subtotal style for a specified axis for the subtotal.
abstract Enumeration	getSubtotalUnits() Returns a collection of `WebObjectInfo` objects across whose level a subtotal can be added.
abstract SimpleList	getUnitsForLevel(WebTemplateSubtotal subtotal) Returns a collection of `WebObjectInfo` objects across whose level the subtotal is defined.
abstract boolean	isMetricTotalAvailable(int metricType, int subtotalStyle) This method is deprecated. Replaced by `getAllTotalsState(WebTemplateSubtotal)` and `getGrandTotalsState(WebTemplateSubtotal)`
abstract void	setCurrentSubtotalIndex(int index) Sets the index of the current subtotal being modified by the editor

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

Constants

public static final String SUBTOTALS_AVG

Constant Value: "AVG"

public static final String SUBTOTALS_DISABLED

Constant Value: "OFF"

public static final String SUBTOTALS_GRAND_TOTAL

Constant Value: "GT"

public static final String SUBTOTALS_MAX

Constant Value: "MAX"

public static final String SUBTOTALS_MIN

Constant Value: "MIN"

public static final String SUBTOTALS_SUBTOTALS

Constant Value: "SUB"

public static final String SUBTOTALS_SUM

Constant Value: "SUM"

Public Methods

public abstract int getAllTotalsState (WebTemplateSubtotal subtotal)

Return the state of the All Totals checkbox for the given subtotal

Parameters

subtotal	WebTemplateSubtotal for which the subtotal style is requested

Returns

state of the subtotal. From EnumSubtotalCheckboxState

public abstract Enumeration getAvailableSubtotals ()

Returns a collection of WebTemplateSubtotal objects that are available for the template.

Returns

An Enumeration of the list of subtotals

public abstract int getCurrentSubtotalIndex ()

Gets the index of the current subtotal being modified by the editor

public abstract int getDisplayOptions (int axis)

Returns the position of the subtotals for the specified axis. Used in the display options tab of the editor.

Parameters

axis	Index of the axis for which the position of the subtotal is required

Returns

int indicating the position of the subtotals from EnumDSSXMLSubtotalsPosition.

public abstract int getGrandTotalsState (WebTemplateSubtotal subtotal)

Return the state of the Grand Totals checkbox for the given subtotal

Parameters

subtotal	WebTemplateSubtotal for which the subtotal style is requested

Returns

state of the subtotal. From EnumSubtotalCheckboxState

public abstract WebTemplateSubtotal getSubtotal (int index)

Returns a WebTemplateSubtotal object for the specified index of the subtotal.

Parameters

index	Index of the subtotal

Returns

WebTemplateSubtotal

public abstract int getSubtotalState (WebTemplateSubtotal subtotal)

Gets the state of the subtotal specified.

Parameters

subtotal	WebTemplateSubtotal for which the subtotal style is requested

Returns

value indicating the state of the subtotal. From EnumSubtotalState

public abstract int getSubtotalStyleForAxis (WebTemplateSubtotal subtotal, int axisIndex)

Gets the subtotal style for a specified axis for the subtotal. If the subtotal is not defined 'By position' this method will return DssXmlSubtotalNone

Parameters

subtotal	WebTemplateSubtotal for which the subtotal style is requested
axisIndex	Index of the axis for which the style is requested

Returns

value indicating the state of the subtotal. From EnumDSSXMLSubtotalStyle.

public abstract Enumeration getSubtotalUnits ()

Returns a collection of WebObjectInfo objects across whose level a subtotal can be added. This list will include attributes, hierarchies, custom groups and consolidations.

public abstract SimpleList getUnitsForLevel (WebTemplateSubtotal subtotal)

Returns a collection of WebObjectInfo objects across whose level the subtotal is defined. Returns null if the subtotal is not active or if it is not defined Across Level.

Parameters

subtotal	WebTemplateSubtotal for which the list of units is requested

Returns

SimpleList collection of WebObjectInfo

public abstract boolean isMetricTotalAvailable (int metricType, int subtotalStyle)

This method is deprecated.
Replaced by getAllTotalsState(WebTemplateSubtotal) and getGrandTotalsState(WebTemplateSubtotal)

Returns true if the metric and subtotal are available for the metrics axis

Parameters

metricType	the metric type (subtotal \| gradtotal)
subtotalStyle	the subtotal style (i.e. min, max, avg, sum)

Returns

true if the metric and subtotal are available

public abstract void setCurrentSubtotalIndex (int index)

Sets the index of the current subtotal being modified by the editor

Interfaces

Classes

Exceptions

SubtotalsEditorBean

Class Overview

Summary

Constants

public static final String SUBTOTALS_AVG

public static final String SUBTOTALS_DISABLED

public static final String SUBTOTALS_GRAND_TOTAL

public static final String SUBTOTALS_MAX

public static final String SUBTOTALS_MIN

public static final String SUBTOTALS_SUBTOTALS

public static final String SUBTOTALS_SUM

Public Methods

public abstract int getAllTotalsState (WebTemplateSubtotal subtotal)

Parameters

Returns

public abstract Enumeration getAvailableSubtotals ()

Returns

public abstract int getCurrentSubtotalIndex ()

public abstract int getDisplayOptions (int axis)

Parameters

Returns

public abstract int getGrandTotalsState (WebTemplateSubtotal subtotal)

Parameters

Returns

public abstract WebTemplateSubtotal getSubtotal (int index)

Parameters

Returns

public abstract int getSubtotalState (WebTemplateSubtotal subtotal)

Parameters

Returns

public abstract int getSubtotalStyleForAxis (WebTemplateSubtotal subtotal, int axisIndex)

Parameters

Returns

public abstract Enumeration getSubtotalUnits ()

public abstract SimpleList getUnitsForLevel (WebTemplateSubtotal subtotal)

Parameters

Returns

public abstract boolean isMetricTotalAvailable (int metricType, int subtotalStyle)

Parameters

Returns

public abstract void setCurrentSubtotalIndex (int index)