Package com.microstrategy.web.app.beans
Interface ObjectBrowserTabBean
-
- All Superinterfaces:
AppComponent
,TabBean
,Transformable
,ViewBeanParserBean
,WebComponent
- All Known Subinterfaces:
ReportWorkingSetBrowserTabBean
,RWProjectBrowserTabBean
,RWWorkingSetBrowserTabBean
- All Known Implementing Classes:
AbstractObjectBrowserTabBean
public interface ObjectBrowserTabBean extends TabBean
This interface shall be used as base for creating tab beans that can be displayed by aObjectBrowserManagerBean
instance or on their own, showing features related with project and object browsing.- Since:
- MicroStrategy Web 8.0.0
-
-
Field Summary
Fields Modifier and Type Field Description static int
CONTENTS_TYPE_RWDATAELEMENTS
Constant that indicates the object of the contents this instance will generate is an instance ofRWDataSets
static int
CONTENTS_TYPE_WEB_WORKING_SET
Constant that indicates the object of the contents this instance will generate is an instance ofWebWorkingSet
static int
CONTENTS_TYPE_WEBFOLDER
Constant that indicates the object of the contents this instance will generate is an instance ofWebFolder
-
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.Object
getContents()
Get an instance with the contents to be rendered on the tabint
getContentsType()
This method allows users of this interface to know the type of output to expect from thegetContents()
method, since for example, in some cases, it might be aWebFolder
instance (when returning searches, folder browsing or report working set information) or aRWDataSets
instance (when returning data element information from a report writing bean)int
getDesignModeStage()
Get the stage of the design mode (EnumReportDesignMode
).int[]
getObjectFilter()
Get an array of object subtypes to use for filtering when a search is run.int[]
getObjectFilter(int targetMode)
Get an array of object subtypes to use for filtering when a search is run.boolean
isTargetingFilter()
Returns if the object browser is targeting the filter or notvoid
prepareTabContentsList()
Prepare the list of contents this tab will get displayed to the user.void
setDesignModeStage(int designModeStage)
Holds the stage of the design mode (EnumReportDesignMode
) .void
setObjectFilter(java.lang.String objectFilter)
Set the filter to use when obtaining the contents to display.-
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.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
-
-
-
-
Field Detail
-
CONTENTS_TYPE_WEBFOLDER
static final int CONTENTS_TYPE_WEBFOLDER
Constant that indicates the object of the contents this instance will generate is an instance ofWebFolder
- See Also:
- Constant Field Values
-
CONTENTS_TYPE_RWDATAELEMENTS
static final int CONTENTS_TYPE_RWDATAELEMENTS
Constant that indicates the object of the contents this instance will generate is an instance ofRWDataSets
- See Also:
- Constant Field Values
-
CONTENTS_TYPE_WEB_WORKING_SET
static final int CONTENTS_TYPE_WEB_WORKING_SET
Constant that indicates the object of the contents this instance will generate is an instance ofWebWorkingSet
- See Also:
- Constant Field Values
-
-
Method Detail
-
getContents
java.lang.Object getContents()
Get an instance with the contents to be rendered on the tab- Returns:
- an
Object
instance with the objects that should be rendered as part of the tab information for the Object Browser. For determining the type of instance this object is, thegetContentsType()
method can be called.
-
getContentsType
int getContentsType()
This method allows users of this interface to know the type of output to expect from thegetContents()
method, since for example, in some cases, it might be aWebFolder
instance (when returning searches, folder browsing or report working set information) or aRWDataSets
instance (when returning data element information from a report writing bean)- Returns:
- an
int
value indicating the type of instance thegetContents()
method will return. For example it will returnCONTENTS_TYPE_WEBFOLDER
when the output is aWebFolder
instance, orCONTENTS_TYPE_RWDATAELEMENTS
when it is aRWDataSets
instance.
-
setObjectFilter
void setObjectFilter(java.lang.String objectFilter)
Set the filter to use when obtaining the contents to display. A default object filter specification is defined, but it can be overwritten when using this method. The filter specified here will be applicable only when a search is run for retrieving the information to render to the user.- Parameters:
objectFilter
- aString
specifying the object filter to use, with the following format:
targetMode1:objectSubtype1,objectSubtype2,objectSubtype3;targetMode2:objectSubtype2
Where the target mode is specified on the parentObjectBrowserManagerBean
instance.
If no target is specified, then it means that regardless of the target mode, it will use the list of object subtypes specified as filter. For example:
objectSubtype1,objectSubtype2,objectSubtype3
-
getObjectFilter
int[] getObjectFilter()
Get an array of object subtypes to use for filtering when a search is run.- Returns:
- an array of
int
values representing the filter to use if the target mode is the data (EnumObjectBrowserTargets.ObjectBrowserTargetReport
)
-
getObjectFilter
int[] getObjectFilter(int targetMode)
Get an array of object subtypes to use for filtering when a search is run.- Parameters:
targetMode
- the target mode indicated for selecting the filter defined for it. For example,EnumObjectBrowserTargets.ObjectBrowserTargetReport
- Returns:
- an array of
int
values representing the filter to use corresponding to the target mode specified.
-
prepareTabContentsList
void prepareTabContentsList()
Prepare the list of contents this tab will get displayed to the user. These contents will later on be available to users via thegetContents()
method.
-
setDesignModeStage
void setDesignModeStage(int designModeStage)
Holds the stage of the design mode (EnumReportDesignMode
) . The report frame bean will be responsible for setting this property of the objectbrowser tab beans.- Parameters:
designModeStage
-
-
getDesignModeStage
int getDesignModeStage()
Get the stage of the design mode (EnumReportDesignMode
).- Returns:
- int
-
isTargetingFilter
boolean isTargetingFilter()
Returns if the object browser is targeting the filter or not- Returns:
- True if the user is editing the report filter, False otherwise
-
-