Package com.microstrategy.web.app.beans
Interface SubtotalsEditorBean
-
- All Superinterfaces:
AppComponent
,EnumWebPersistableState
,FrameElement
,Persistable
,ReportFrameElement
,RequestPersistable
,Transformable
,ViewBeanParserBean
,WebComponent
public interface SubtotalsEditorBean extends ViewBeanParserBean, ReportFrameElement
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.- Since:
- MicroStrategy Web 8.0.0
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
SUBTOTALS_AVG
static java.lang.String
SUBTOTALS_DISABLED
static java.lang.String
SUBTOTALS_GRAND_TOTAL
static java.lang.String
SUBTOTALS_MAX
static java.lang.String
SUBTOTALS_MIN
static java.lang.String
SUBTOTALS_SUBTOTALS
static java.lang.String
SUBTOTALS_SUM
-
Fields inherited from interface com.microstrategy.web.app.beans.AppComponent
COMPONENT_POSITION_NOT_INITIALIZED
-
Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState
BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description int
getAllTotalsState(WebTemplateSubtotal subtotal)
Return the state of the All Totals checkbox for the given subtotaljava.util.Enumeration
getAvailableSubtotals()
Returns a collection ofWebTemplateSubtotal
objects that are available for the template.int
getCurrentSubtotalIndex()
Gets the index of the current subtotal being modified by the editorint
getDisplayOptions(int axis)
Returns the position of the subtotals for the specified axis.int
getGrandTotalsState(WebTemplateSubtotal subtotal)
Return the state of the Grand Totals checkbox for the given subtotalWebTemplateSubtotal
getSubtotal(int index)
Returns aWebTemplateSubtotal
object for the specified index of the subtotal.int
getSubtotalState(WebTemplateSubtotal subtotal)
Gets the state of the subtotal specified.int
getSubtotalStyleForAxis(WebTemplateSubtotal subtotal, int axisIndex)
Gets the subtotal style for a specified axis for the subtotal.java.util.Enumeration
getSubtotalUnits()
Returns a collection ofWebObjectInfo
objects across whose level a subtotal can be added.SimpleList
getUnitsForLevel(WebTemplateSubtotal subtotal)
Returns a collection ofWebObjectInfo
objects across whose level the subtotal is defined.boolean
isMetricTotalAvailable(int metricType, int subtotalStyle)
Deprecated.void
setCurrentSubtotalIndex(int index)
Sets the index of the current subtotal being modified by the editor-
Methods inherited from interface com.microstrategy.web.app.beans.AppComponent
getAppContext, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getLeft, getResultFilterMode, getTop, isDialog, isForcedChildrenStateSaving, isModal, isModalOpen, isOpen, setExtraInput, setExtraUrl, setForcedChildrenStateSaving, setHasJustOpened, setIsDialog, setIsModal, setIsOpen, setLeft, setTop
-
Methods inherited from interface com.microstrategy.web.app.beans.FrameElement
getFrameBean, getTargetBean, getTargetBeanPath, getUseIFrame, isEditor, isEnabled, setTargetBean, setTargetBeanPath, setUseIFrame
-
Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState
-
Methods inherited from interface com.microstrategy.web.app.beans.ReportFrameElement
getReportFrameBean, isGridDataNecessary
-
Methods inherited from interface com.microstrategy.web.beans.RequestPersistable
restoreStateFromRequest, restoreStateFromRequest
-
Methods inherited from interface com.microstrategy.web.beans.Transformable
addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, getBeanContext, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, getType, hasTransform, hasTransform, invalidateTransformCache, setBeanContext, transform, transform
-
Methods inherited from interface com.microstrategy.web.app.beans.ViewBeanParserBean
getActiveElementIndex, getActiveViewKey, getTemplateElementList, getViewBean, getViewBean, setActiveElementIndex, setActiveViewKey
-
Methods inherited from interface com.microstrategy.web.beans.WebComponent
addChild, addChildStateInfo, addChildStateInfo, collectData, collectMinimalData, generateOutput, getBeanContext, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getFeaturesManager, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getWebEvent, getWebEvent, getWebEventHandler, getXMLStatus, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setWebEventHandler
-
-
-
-
Field Detail
-
SUBTOTALS_SUM
static final java.lang.String SUBTOTALS_SUM
- See Also:
- Constant Field Values
-
SUBTOTALS_AVG
static final java.lang.String SUBTOTALS_AVG
- See Also:
- Constant Field Values
-
SUBTOTALS_MAX
static final java.lang.String SUBTOTALS_MAX
- See Also:
- Constant Field Values
-
SUBTOTALS_MIN
static final java.lang.String SUBTOTALS_MIN
- See Also:
- Constant Field Values
-
SUBTOTALS_DISABLED
static final java.lang.String SUBTOTALS_DISABLED
- See Also:
- Constant Field Values
-
SUBTOTALS_SUBTOTALS
static final java.lang.String SUBTOTALS_SUBTOTALS
- See Also:
- Constant Field Values
-
SUBTOTALS_GRAND_TOTAL
static final java.lang.String SUBTOTALS_GRAND_TOTAL
- See Also:
- Constant Field Values
-
-
Method Detail
-
isMetricTotalAvailable
boolean isMetricTotalAvailable(int metricType, int subtotalStyle)
Deprecated.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
-
getAvailableSubtotals
java.util.Enumeration getAvailableSubtotals()
Returns a collection ofWebTemplateSubtotal
objects that are available for the template.- Returns:
- An Enumeration of the list of subtotals
- Since:
- MicroStrategy Web 9.0.0
-
getAllTotalsState
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
- Since:
- MicroStrategy Web 9.0.0
-
getGrandTotalsState
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
- Since:
- MicroStrategy Web 9.0.0
-
getSubtotalUnits
java.util.Enumeration getSubtotalUnits()
Returns a collection ofWebObjectInfo
objects across whose level a subtotal can be added. This list will include attributes, hierarchies, custom groups and consolidations.- Since:
- MicroStrategy Web 9.0.0
-
getDisplayOptions
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
. - Since:
- MicroStrategy Web 9.0.0
-
getCurrentSubtotalIndex
int getCurrentSubtotalIndex()
Gets the index of the current subtotal being modified by the editor- Since:
- MicroStrategy Web 9.0.0
-
setCurrentSubtotalIndex
void setCurrentSubtotalIndex(int index)
Sets the index of the current subtotal being modified by the editor- Parameters:
index
-- Since:
- MicroStrategy Web 9.0.0
-
getSubtotalState
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
- Since:
- MicroStrategy Web 9.0.0
-
getSubtotalStyleForAxis
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 returnEnumDSSXMLSubtotalStyle.DssXmlSubtotalNone
- Parameters:
subtotal
- WebTemplateSubtotal for which the subtotal style is requestedaxisIndex
- Index of the axis for which the style is requested- Returns:
- value indicating the state of the subtotal. From
EnumDSSXMLSubtotalStyle
. - Since:
- MicroStrategy Web 9.0.0
-
getUnitsForLevel
SimpleList getUnitsForLevel(WebTemplateSubtotal subtotal)
Returns a collection ofWebObjectInfo
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 ofWebObjectInfo
- Since:
- MicroStrategy Web 9.0.0
-
getSubtotal
WebTemplateSubtotal getSubtotal(int index)
Returns aWebTemplateSubtotal
object for the specified index of the subtotal.- Parameters:
index
- Index of the subtotal- Returns:
WebTemplateSubtotal
- Since:
- MicroStrategy Web 9.0.0
-
-