Package com.microstrategy.web.app.beans
Interface FormatNumberTabBean
-
- All Superinterfaces:
AppComponent
,FormatTabBean
,TabBean
,Transformable
,ViewBeanParserBean
,WebComponent
public interface FormatNumberTabBean extends FormatTabBean
Interface that represents the bean which will allow users to modify Number formatting properties on a given target object, showing its options as aTabBean
in aTabManagerBean
component.- Since:
- MicroStrategy Web 8.0.0
-
-
Field Summary
-
Fields inherited from interface com.microstrategy.web.app.beans.AppComponent
COMPONENT_POSITION_NOT_INITIALIZED
-
Fields inherited from interface com.microstrategy.web.app.beans.TabBean
CACHED, FETCH, TAB_REPRESENTED_NOT_SPECIFIED
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getDataSetId()
Get the DSS ID of the dataset whose user metric is selected from the object browserWebFormat
getUserMetricFormat()
Get the WebFormat for the currently selected user metric in the object browserjava.lang.String
getUserMetricID()
Get the DSS ID of the currently selected user metric in the object browserint
getUserMetricKey()
Get the value of the key of the user metric selected from the object browser.void
setDataSetId(java.lang.String dataSetID)
Set the DSS ID of the dataset where the user metric is selected from the object browservoid
setUserMetricKey(int userMetricKey)
Set the key of the user metric selected from the object browser.-
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.FormatTabBean
getSelectedTypes, getTargetAxis, getTargetLevel, getTargetPosition, setSelectedTypes, setTargetAxis, setTargetLevel, setTargetPosition
-
Methods inherited from interface com.microstrategy.web.app.beans.TabBean
getEnabledCmdId, getFeatures, getHelpTopic, getHelpType, getRequireSingleSelector, getSupportedTypes, getSwitchMode, getTabId, getTabLabel, getTabLabelId, getTabManager, getTabName, getTabRepresented, getViewBean, isAvailable, isPartialUpdate, setEnabledCmdId, setFeatures, setHelpTopic, setHelpType, setPartialUpdate, setRequireSingleSelector, setSupportedTypes, setSwitchMode, setTabLabel, setTabLabelId, setTabName, setTabRepresented
-
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, 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, getTargetBean, getTargetBeanPath, 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, setTargetBean, setTargetBeanPath, setWebEventHandler
-
-
-
-
Method Detail
-
getUserMetricKey
int getUserMetricKey()
Get the value of the key of the user metric selected from the object browser. This key can then be used to obtain the user metric object from the data set- Returns:
- int
-
setUserMetricKey
void setUserMetricKey(int userMetricKey)
Set the key of the user metric selected from the object browser.- Parameters:
userMetricKey
- int
-
setDataSetId
void setDataSetId(java.lang.String dataSetID)
Set the DSS ID of the dataset where the user metric is selected from the object browser- Parameters:
dataSetID
- String
-
getDataSetId
java.lang.String getDataSetId()
Get the DSS ID of the dataset whose user metric is selected from the object browser- Returns:
- String
-
getUserMetricFormat
WebFormat getUserMetricFormat()
Get the WebFormat for the currently selected user metric in the object browser- Returns:
- WebFormat
-
getUserMetricID
java.lang.String getUserMetricID()
Get the DSS ID of the currently selected user metric in the object browser- Returns:
- String
-
-