public abstract class

AbstractObjectBrowserTabBean

extends AbstractViewBeanParserBean
implements ObjectBrowserTabBean TabBean

java.lang.Object
↳	com.microstrategy.utils.serialization.AbstractPersistable
	↳	com.microstrategy.web.beans.AbstractTransformable
		↳	com.microstrategy.web.beans.AbstractWebComponent
			↳	com.microstrategy.web.app.beans.AbstractAppComponent
				↳	com.microstrategy.web.app.beans.AbstractPersistableAppComponent
					↳	com.microstrategy.web.app.beans.AbstractPersistableFrameElement
						↳	com.microstrategy.web.app.beans.AbstractViewBeanParserBean
							↳	com.microstrategy.web.app.beans.AbstractObjectBrowserTabBean

Class Overview

Abstract implementation of the ObjectBrowserTabBean interface. This abstract class can be used for customizations, inheriting the basic definition of the methods available for these instances.

Summary

[Expand]

Inherited Constants

From class com.microstrategy.web.app.beans.AbstractPersistableAppComponent

From interface com.microstrategy.utils.serialization.EnumWebPersistableState

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

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

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

[Expand]

Inherited Fields

From class com.microstrategy.web.beans.AbstractWebComponent

From class com.microstrategy.web.beans.AbstractTransformable

From class com.microstrategy.utils.serialization.AbstractPersistable

Public Constructors
	AbstractObjectBrowserTabBean() Default constructor.

Public Methods
void	addChildStateInfo(ParameterBuilder paramBldr, int howMuchState) Adds children state information into an existing ParameterBuilder instance.
int	getDesignModeStage() Get the stage of the design mode (`EnumReportDesignMode`).
String	getEnabledCmdId() Get the command id to be queried on the clioent site.
String	getFeatures() Gets a list of feature ids that are required to enable the tab
String	getHelpTopic() get the help topic of this tab
String	getHelpType() get the type of the help file
int[]	getObjectFilter(int targetMode) Get an array of object subtypes to use for filtering when a search is run.
int[]	getObjectFilter() Get an array of object subtypes to use for filtering when a search is run.
boolean	getRequireSingleSelector() Each instance of this class represents a tab in the `TabManagerBean`.
String	getSupportedTypes() Get the list of objects this tab can be associated with.
int	getSwitchMode() the switching mode can be: CACHED - use the cached tab content on the client side FETCH - go back to the webserver to fetch the tab content
String	getTabId() Returns a string can be used as the identifier of the tab.
String	getTabLabel() Get the description text to be used as title for the display of the tab.
String	getTabLabelId() Get the identifier of the descriptor to be used as title for the display of the tab.
TabManagerBean	getTabManager() Utility method for obtaining the parent tabe manager associated to this tab
String	getTabName() Each instance of this class represents a tab in the `TabManagerBean`.
int	getTabRepresented() Each instance of this class represents a tab in the `TabManagerBean`.
int	getXMLStatus() Returns the `EnumRequestStatus` status of the component.
boolean	isAvailable() This method specifies if in the current scenario, the bean instance can be displayed as possible tab option, based on granted privileges, etc.
boolean	isEditor() Indicates whether the instance most be considered editor.
boolean	isPartialUpdate()
boolean	isTargetingFilter() Returns if the object browser is targeting the filter or not
void	setDesignModeStage(int designModeStage) Holds the stage of the design mode (`EnumReportDesignMode`) .
void	setEnabledCmdId(String value) Set the command id to be queried on the client site.
void	setFeatures(String featureIds) Sets a list of feature ids that are required to enable the tab
void	setHelpTopic(String topic) Set the help topic of the editor
void	setHelpType(String type) set the help type for the editor
void	setName(String name) Sets the name for the current component.
void	setObjectFilter(String objectFilter) Set the filter to use when obtaining the contents to display.
void	setPartialUpdate(boolean partialUpdate)
void	setRequireSingleSelector(boolean requireSingleSelector) Each instance of this class represents a tab in the `TabManagerBean`.
void	setSupportedTypes(String supportedTYpes) Set the list of objects this tab can be associated with.
void	setSwitchMode(int switchMode) the switching mode can be: CACHED - use the cached tab content on the client side FETCH - go back to the webserver to fetch the tab content
void	setTabLabel(String description) Set the description text to be used as title for the display of the tab.
void	setTabLabelId(String descriptionId) Set the identifier of the descriptor to be used as title for the display of the tab.
void	setTabName(String tabName) Each instance of this class represents a tab in the `TabManagerBean`.
void	setTabRepresented(int tabRepresented) Each instance of this class represents a tab in the `TabManagerBean`.

Protected Methods
void	doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer) Speciefies which bean's properties are persisted.
WebEventHandler	newDefaultEventHandler()

[Expand]

Inherited Methods

From class com.microstrategy.web.app.beans.AbstractViewBeanParserBean

void	doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer) Speciefies which bean's properties are persisted.
int	getActiveElementIndex() This method is deprecated. This method will no longer be part of this class.
String	getActiveViewKey() Returns the active view key.
ArrayList	getTemplateElementList() This method is deprecated. This method will no longer be part of this interface. Create the TemplateParser using the getViewBean to access the template element list.
ViewBean	getViewBean(int viewInstance) Get a specific instance of the ViewBean associated with the bean.
ViewBean	getViewBean() Get a instance of the ViewBean associated with the bean.
void	setActiveElementIndex(int activeElementIndex) This method is deprecated. This method will no longer be part of this class.
void	setActiveViewKey(String activeViewKey) Set the active view key.

From class com.microstrategy.web.app.beans.AbstractPersistableFrameElement

void	doCollectData() Extends collectData by setting the Persistable mode to Default (do not persist) if the bean is a FrameElement and it's not editable.
DocumentFrameBean	getDocumentFrameBean() Returns the `DocumentFrameBean` associated with this report frame element.
WebFeatures	getFeaturesManager() Overrides getFeaturesManager by providing a new Features implementation for FrameElements.
FrameBean	getFrameBean() Utility method for returning the `FrameBean` associated with this instance
RWFrameBean	getRWFrameBean() Returns the `RWFrameBean` associated with this report frame element.
ReportFrameBean	getReportFrameBean() Returns the `ReportFrameBean` associated with this report frame element.
boolean	getUseIFrame() Indicates whether a ReportFrameElement uses IFrames in its output
boolean	isEditor() Indicates whether a ReportFrameElement most be considered editor.
boolean	isGridDataNecessary() This method indicates the report frame that the element requires the grid for information.
boolean	isIFrameEnabled()
boolean	isOpen() Overrides isOpen by making sure FrameElements use the FrameBean to control their open-close status.
void	setIsOpen(boolean value) Overrides setIsOpen by making sure FrameElements use the FrameBean to control their open-close status.
void	setUseIFrame(boolean value) Sets whether a ReportFrameElement should use IFrames in its output

From class com.microstrategy.web.app.beans.AbstractPersistableAppComponent

From class com.microstrategy.web.app.beans.AbstractAppComponent

void	addChildStateInfo(ParameterBuilder paramBldr) Adds children state information into an existing `ParameterBuilder` instance.
void	collectData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
void	collectMinimalData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
boolean	compareChildsTargetWithCurrent() The implementing class should implement this method to return true if it wants to always call the current object's targetBean#hasChanged method in #hasTargetBeanChanged method.
TransformInstance	createTransformInstance(Transform transform)
void	doCollectData() Call the required methods so the data is collected for this instance
void	doCollectMinimalData() By default this method simply invokes `doCollectData()`, i.e.
MarkupOutput	generateOutput() Generates the output of a bean.
AppContext	getAppContext() This method returns the application context object associated with this component.
String	getContactInfo() This method is deprecated. Use Preferences.getValue(EnumWebPreferences.WebPreferenceAdminInfo) instead.
ContainerServices	getContainerServices() Convenience method to retrieve the connected Container Services object.
String	getDescriptor(int key) Retrieve the descriptor when the key is an integer value...
String	getDescriptor(String key) Retrieve the descriptor when the key is a string
EventManager	getEventManager() This method returns the application EventManager used to generates events.
String	getExtraInput() Get any extra input form information to be used when generating form information on the transforms associated with this instance.
String	getExtraUrl() Get any extra url information to be used when generating link information on the transforms associated with this instance.
WebFeatures	getFeaturesManager() Return the WebFeatures implementation associated with this WebComponent
int	getLeft() Get the left position where the bean should be displayed by the transform if applicable
WebObjectSource	getObjectSource()
int	getResultFilterMode()
WebIServerSession	getSession()
WebComponent	getTargetBean() Get the target bean associated with this instance
int	getTop() Get the top position where the bean should be displayed by the transform if applicable
int	getType() Returns the transformable type as in `EnumWebTransformableType`.
static WebObjectsFactory	getWebObjectsFactory(WebBean wb) Utility method for obtaining a `WebObjectsFactory` instance
WebObjectsFactory	getWebObjectsFactory()
int	getXMLStatus() Returns the `EnumRequestStatus` status of the component.
boolean	hasChanged() Verifies the state of the component has changed
boolean	hasTargetBeanChanged() When this method is called, we have already checked the children and each of the children has returned with hasChanged() as false.
boolean	haveChildrenChanged()
WebComponent	initComponent(WebComponent bean, String suffix) Initialize a WebComponent as child of this FrameBean.
void	internalCollectData() This method is called internally by the transform() method to ensure collectData has been triggered and the bean is ready to transform.
boolean	isDialog() Returns true if this bean should be treated as a dialog
boolean	isForcedChildrenStateSaving() Return wheter the bean's children will be save their states or not despite it's open or closed state.
boolean	isIFrameRequest() Utility method that determines if it's an IFrame type of request.
boolean	isModal() The property is used to determine wheter the component will be displayed as a floating (popup) dialog with modal property.
boolean	isModalOpen() indicates whether there is a Modal AppComponent open in the hierarchy
boolean	isOpen() Returns a boolean value indicating if the instance is marked as opened or closed.
BeanContext	newDefaultBeanContext() This method is called by getBeanContext() to automatically create an instance of a BeanContext if one has not been explicitly set.
ParameterBuilder	newHiddenInputBuilder() Convenience method to retrieve a new instance of a Hidden Input Builder from the connected Container Services object.
NamespaceEncoder	newNamespaceEncoder() Convenience method to retrieve a new instance of a Namespace Encoder from the connected Container Services object.
StyleRequestContext	newStyleRequestContext()
ParameterBuilder	newURIBuilder() Convenience method to retrieve a new instance of a URI Builder from the connected Container Services object.
void	setExtraInput(String newValue) Set any extra input form information to be used when generating form information on the transforms associated with this instance.
void	setExtraUrl(String newValue) Set any extra url information to be used when generating link information on the transforms associated with this instance.
void	setForcedChildrenStateSaving(boolean value) Forces the bean to propagate its children to save state despite it's open or closed state.
void	setHasJustOpened(boolean value) Sets whether the component has just been opened.
void	setIsDialog(boolean value) Set method for defining if the instance is to be defined as a Dialog or not.
void	setIsModal(boolean value) Set method for defining if the instance is to be defined as a Modal interface or not.
void	setIsOpen(boolean value) Set the current instance as opened.
void	setLeft(int x) Set the left position where the bean should be displayed by the transform if applicable.
void	setOutputFormat(int outputFormat) Sets the output format of `EnumBeanOutputFormat` for the current WebComponent.
void	setTop(int y) Set the top osition where the bean should be displayed by the transform if applicable.

From class com.microstrategy.web.beans.AbstractWebComponent

From class com.microstrategy.web.beans.AbstractTransformable

From class com.microstrategy.utils.serialization.AbstractPersistable

void	doFlatState(FlatStateSerializer ser, int howMuchState, FlatStateTokenizer tok, int stateFlag)
void	doFlatState(FlatStateSerializer ser, int howMuchState, FlatStateTokenizer tok)
AbstractHandler	getStateHandler()
boolean	isXMLStateZipped()
boolean	restoreState(SAXSupport parser, String uri, String localName, String qName, Attributes attrs) Restores a component from an embedded XML during a SAX parsing.
boolean	restoreState(String state) Restores a component based on its saved state.
void	restoreXMLState(String state)
String	saveState() Returns a `java.lang.String` representation of a component.
void	saveState(StringBuffer buf, int howMuchState, int stateFlag) Saves and stores a component's state into a `StringBuffer`.
void	saveState(StringBuffer buf, int howMuchState) Saves and stores a component's state into a `StringBuffer`.
String	saveState(int howMuchState) Returns a `java.lang.String` representation of a component.
void	saveXMLState(StringBuffer buf, int howMuchState, int stateFlag)
void	saveXMLState(StringBuffer buf, int howMuchState)

From class java.lang.Object

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

abstract Object	getContents() Get an instance with the contents to be rendered on the tab
abstract int	getContentsType() This method allows users of this interface to know the type of output to expect from the `getContents()` method, since for example, in some cases, it might be a `WebFolder` instance (when returning searches, folder browsing or report working set information) or a `RWDataSets` instance (when returning data element information from a report writing bean)
abstract int	getDesignModeStage() Get the stage of the design mode (`EnumReportDesignMode`).
abstract int[]	getObjectFilter() Get an array of object subtypes to use for filtering when a search is run.
abstract int[]	getObjectFilter(int targetMode) Get an array of object subtypes to use for filtering when a search is run.
abstract boolean	isTargetingFilter() Returns if the object browser is targeting the filter or not
abstract void	prepareTabContentsList() Prepare the list of contents this tab will get displayed to the user.
abstract void	setDesignModeStage(int designModeStage) Holds the stage of the design mode (`EnumReportDesignMode`) .
abstract void	setObjectFilter(String objectFilter) Set the filter to use when obtaining the contents to display.

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

abstract String	getEnabledCmdId() Get the command id to be queried on the clioent site.
abstract String	getFeatures() Gets a list of feature ids that are required to enable the tab
abstract String	getHelpTopic() get the help topic of this tab
abstract String	getHelpType() get the type of the help file
abstract boolean	getRequireSingleSelector() Each instance of this class represents a tab in the `TabManagerBean`.
abstract String	getSupportedTypes() Get the list of objects this tab can be associated with.
abstract int	getSwitchMode() Gets the switch mode of the tab bean
abstract String	getTabId() Returns a string can be used as the identifier of the tab.
abstract String	getTabLabel() Get the description text to be used as title for the display of the tab.
abstract String	getTabLabelId() Get the identifier of the descriptor to be used as title for the display of the tab.
abstract TabManagerBean	getTabManager() Utility method for obtaining the parent tabe manager associated to this tab
abstract String	getTabName() Each instance of this class represents a tab in the `TabManagerBean`.
abstract int	getTabRepresented() Each instance of this class represents a tab in the `TabManagerBean`.
abstract ViewBean	getViewBean() Utility method for obtaining the `ViewBean` indicated as target bean for this tab instance.
abstract boolean	isAvailable() This method specifies if in the current scenario, the bean instance can be displayed as possible tab option, based on granted privileges, etc.
abstract boolean	isPartialUpdate()
abstract void	setEnabledCmdId(String value) Set the command id to be queried on the client site.
abstract void	setFeatures(String featureIds) Sets a list of feature ids that are required to enable the tab
abstract void	setHelpTopic(String topic) set the help topic of the editor
abstract void	setHelpType(String type) set the help type for the editor
abstract void	setPartialUpdate(boolean paritalUpdate)
abstract void	setRequireSingleSelector(boolean requireSingleSelector) Each instance of this class represents a tab in the `TabManagerBean`.
abstract void	setSupportedTypes(String supportedTYpes) Set the list of objects this tab can be associated with.
abstract void	setSwitchMode(int switchMode) Sets the switch mode of the tab bean (client side switch or server side switch)
abstract void	setTabLabel(String description) Set the description text to be used as title for the display of the tab.
abstract void	setTabLabelId(String descriptionId) Set the identifier of the descriptor to be used as title for the display of the tab.
abstract void	setTabName(String tabName) Each instance of this class represents a tab in the `TabManagerBean`.
abstract void	setTabRepresented(int tab) Each instance of this class represents a tab in the `TabManagerBean`.

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 Constructors

public AbstractObjectBrowserTabBean ()

Default constructor. No arguments.

Public Methods

public void addChildStateInfo (ParameterBuilder paramBldr, int howMuchState)

Adds children state information into an existing ParameterBuilder instance. It is up to the supplied ParameterBuilder to determine how this information is serialized.

Parameters

paramBldr	The ParameterBuilder instance which has child state information added to it.
howMuchState	How much state is added. (see `EnumWebPersistableState` for details).

public int getDesignModeStage ()

Get the stage of the design mode (EnumReportDesignMode).

Returns

int

public String getEnabledCmdId ()

Get the command id to be queried on the clioent site. This determines the availability of the tab.

Returns

String with the tab's command id.

public String getFeatures ()

Gets a list of feature ids that are required to enable the tab

Returns

String

public String getHelpTopic ()

get the help topic of this tab

Returns

the help topic of this tab needs to point to

public String getHelpType ()

get the type of the help file

Returns

the type is one of HELP_TYPE_ADMIN,HELP_TYPE_USER,HELP_TYPE_CUSTOM

public 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, `ObjectBrowserTargetReport`

Returns

an array of int values representing the filter to use corresponding to the target mode specified.

public 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 (ObjectBrowserTargetReport)

public boolean getRequireSingleSelector ()

Each instance of this class represents a tab in the TabManagerBean. This method inidicates whether this tab instance's availability relies on the selection of exactly one selector control among all the units the user has selected.

Returns

indicates whether a single selection on selector control is required for the tab to be available or not.

public String getSupportedTypes ()

Get the list of objects this tab can be associated with.

Returns

String with the a list of supported objects.

public int getSwitchMode ()

the switching mode can be: CACHED - use the cached tab content on the client side FETCH - go back to the webserver to fetch the tab content

Returns

the switching mode of this tab instance uses

public String getTabId ()

Returns a string can be used as the identifier of the tab.

Returns

String with the text to be used as the id of the tab.

public String getTabLabel ()

Get the description text to be used as title for the display of the tab.

Returns

String with the text to be used as title of the tab.

public String getTabLabelId ()

Get the identifier of the descriptor to be used as title for the display of the tab.

Returns

String with the identifier of the descriptor to be used as title of the tab.

public TabManagerBean getTabManager ()

Utility method for obtaining the parent tabe manager associated to this tab

Returns

the TabManagerBean parent

public String getTabName ()

Each instance of this class represents a tab in the TabManagerBean. This method allows an alternative other than getTabRepresented() to get which tab this instance presents , so the TabManagerBean manager knows how to transfer render control to the child, depending on which tab name the user requested.

Returns

the name identifier of the tab this instance represents

public int getTabRepresented ()

Each instance of this class represents a tab in the TabManagerBean. This method allows to get which tab this instance will represent, so the TabManagerBean manager knows how to transfer render control to the child, depending on which tab the user requested.

Returns

the identifier of the tab this instance represents

public int getXMLStatus ()

Returns the EnumRequestStatus status of the component. The status determined by by the status of its children with the following precedence.

WebBeanRequestEndsInError

WebBeanRequestCanceled

WebBeanRequestProcessing

WebBeanRequestNotInitiated

WebBeanRequestWaitingForUserInput

WebBeanRequestSuccessful

Returns

an EnumRequestStatus enumeration value for the component.

public boolean isAvailable ()

This method specifies if in the current scenario, the bean instance can be displayed as possible tab option, based on granted privileges, etc.

Returns

True if the instance is available for being displayed, if the user were to request it. Returns False otherwise.

public boolean isEditor ()

Indicates whether the instance most be considered editor.

Returns

True.

public boolean isPartialUpdate ()

public 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

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

public void setEnabledCmdId (String value)

Set the command id to be queried on the client site. This determines the availability of the tab.

public void setFeatures (String featureIds)

Sets a list of feature ids that are required to enable the tab

Parameters

featureIds	`String` featureIds separated by ","

public void setHelpTopic (String topic)

Set the help topic of the editor

Parameters

topic	the help topic

public void setHelpType (String type)

set the help type for the editor

Parameters

type	String is one of `HELP_TYPE_ADMIN`,`HELP_TYPE_USER`,`HELP_TYPE_CUSTOM`

public void setName (String name)

Sets the name for the current component.

Parameters

name	the name of the current component.

public void setObjectFilter (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 a String specifying the object filter to use, with the following format:
targetMode1:objectSubtype1,objectSubtype2,objectSubtype3;targetMode2:objectSubtype2
Where the target mode is specified on the parent ObjectBrowserManagerBean 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

public void setPartialUpdate (boolean partialUpdate)

public void setRequireSingleSelector (boolean requireSingleSelector)

Each instance of this class represents a tab in the TabManagerBean. This method allows to specify whether this tab instance's availability relies on the selection of exactly one selector control among all the units the user has selected.

Parameters

requireSingleSelector	boolean indicating whether a single selection on selector control is required for the tab to be available or not.

public void setSupportedTypes (String supportedTYpes)

Set the list of objects this tab can be associated with.

Parameters

supportedTYpes	`String` list of the associated objectys i.e. obj.103, obj.102

public void setSwitchMode (int switchMode)

the switching mode can be: CACHED - use the cached tab content on the client side FETCH - go back to the webserver to fetch the tab content

Parameters

switchMode	the switching mode to set for this tab instance

public void setTabLabel (String description)

Set the description text to be used as title for the display of the tab.

Parameters

description	`String` with the text to be used as title of the tab.

public void setTabLabelId (String descriptionId)

Set the identifier of the descriptor to be used as title for the display of the tab.

Parameters

descriptionId	`String` with the identifier of the descriptor to be used as title of the tab.

public void setTabName (String tabName)

Each instance of this class represents a tab in the TabManagerBean. This method allows an alternative other than getTabRepresented() to get which tab this instance presents , so the TabManagerBean manager knows how to transfer render control to the child, depending on which tab name the user requested.

Parameters

tabName	the name identifier of the tab this instance represents

public void setTabRepresented (int tabRepresented)

Each instance of this class represents a tab in the TabManagerBean. This method allows to specify which tab this instance will represent, so the TabManagerBean manager knows how to transfer render control to the child, depending on which tab the user requested.

Parameters

tabRepresented	an identifier of the tab this instance represents.

Protected Methods

protected void doFlatState (FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)

Speciefies which bean's properties are persisted.

Parameters

serializer	FlatStateSerializer initialized instance where the state of the instance is handled
howMuchState	`int` value from `EnumWebPersistableState` indicating how much state should be handled by this instance
tokenizer	FlatStateTokenizer initialized instance where the state of the instance is handled.

Interfaces

Classes

Exceptions

AbstractObjectBrowserTabBean

Class Overview

Summary

Public Constructors

public AbstractObjectBrowserTabBean ()

Public Methods

public void addChildStateInfo (ParameterBuilder paramBldr, int howMuchState)

Parameters

public int getDesignModeStage ()

Returns

See Also

public String getEnabledCmdId ()

Returns

public String getFeatures ()

Returns

public String getHelpTopic ()

Returns

public String getHelpType ()

Returns

public int[] getObjectFilter (int targetMode)

Parameters

Returns

public int[] getObjectFilter ()

Returns

public boolean getRequireSingleSelector ()

Returns

public String getSupportedTypes ()

Returns

public int getSwitchMode ()

Returns

public String getTabId ()

Returns

See Also

public String getTabLabel ()

Returns

public String getTabLabelId ()

Returns

public TabManagerBean getTabManager ()

Returns

public String getTabName ()

Returns

public int getTabRepresented ()

Returns

public int getXMLStatus ()

Returns

See Also

public boolean isAvailable ()

Returns

See Also

public boolean isEditor ()

Returns

public boolean isPartialUpdate ()

public boolean isTargetingFilter ()

Returns

See Also

public void setDesignModeStage (int designModeStage)

See Also

public void setEnabledCmdId (String value)

See Also

public void setFeatures (String featureIds)

Parameters

public void setHelpTopic (String topic)

Parameters

public void setHelpType (String type)

Parameters

public void setName (String name)

Parameters

See Also

public void setObjectFilter (String objectFilter)

Parameters

public void setPartialUpdate (boolean partialUpdate)

public void setRequireSingleSelector (boolean requireSingleSelector)

Parameters

public void setSupportedTypes (String supportedTYpes)

Parameters

public void setSwitchMode (int switchMode)

Parameters