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

public interface

OptionsBean

implements PreferencesBean

com.microstrategy.web.app.beans.OptionsBean

Known Indirect Subclasses

OptionsBeanImpl

Class Overview

The OptionsBean is an application level bean that allows end users to set their preferences values. This bean extends the preferences bean and used specifically for the Print/PDF/Export options. This bean uses most of the methods and logic that it inherits from its parent. the only difference being the setters and getters for the header/footer text and the getter for the report bean. The state of this bean is also an extension of its parent with the information of the header/footer text as a part of the state.

Summary

[Expand]

Inherited Constants

From interface com.microstrategy.utils.serialization.EnumWebPersistableState

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

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

Public Methods
abstract DirectExportBean	getDirectExportBean()
abstract String	getDontPromptAgain() Returns whether not to show the options page.
abstract String	getFooterCenterText() This method is deprecated. not used anymore. We now use `getHeaderFooterPropValue(String)`
abstract String	getFooterLeftText() This method is deprecated. not used anymore. We now use `getHeaderFooterPropValue(String)`
abstract String	getFooterRightText() This method is deprecated. not used anymore. We now use `getHeaderFooterPropValue(String)`
abstract String	getHeaderCenterText() This method is deprecated. not used anymore. We now use `getHeaderFooterPropValue(String)`
abstract boolean	getHeaderFooterChanged() This method is deprecated. not used anymore. This can be determined by checking if the size of `getHeaderFooterProps()` is greater than 0
abstract String	getHeaderFooterMacroPrefix()
abstract String	getHeaderFooterMacroSuffix()
abstract String	getHeaderFooterPropValue(String name)
abstract HashMap<String, String>	getHeaderFooterProps()
abstract String	getHeaderFooterSectionName() Returns the name of the current header footer section.
abstract String	getHeaderLeftText() This method is deprecated. not used anymore. We now use `getHeaderFooterPropValue(String)`
abstract String	getHeaderRightText() This method is deprecated. not used anymore. We now use `getHeaderFooterPropValue(String)`
abstract boolean	getIsProjectHeaderFooter() Returns whether the header/footer properties are the project level ones.
abstract ReportBean	getReportBean()
abstract boolean	getShowAdvancedOptions() Returns whether to show the Advanced Options.
abstract boolean	getShowOptions() Returns whether the options page is being displayed.
abstract int	getType() Returns the type of Bean.
abstract boolean	getUseForExport()
abstract boolean	getUseForPDF()
abstract boolean	getUseForPDFPrint()
abstract boolean	getUseForPrint()
abstract void	setDontPromptAgain(String value) Sets whether not to show the options page.
abstract void	setFooterCenterText(String value) This method is deprecated. not used anymore. We now use `setHeaderFooterPropValue(String, String)`
abstract void	setFooterLeftText(String value) This method is deprecated. not used anymore. We now use `setHeaderFooterPropValue(String, String)`
abstract void	setFooterRightText(String value) This method is deprecated. not used anymore. We now use `setHeaderFooterPropValue(String, String)`
abstract void	setHeaderCenterText(String value) This method is deprecated. not used anymore. We now use `setHeaderFooterPropValue(String, String)`
abstract void	setHeaderFooterChanged(boolean value) This method is deprecated. not used anymore
abstract void	setHeaderFooterPropValue(String name, String value) Sets a temporary property.
abstract void	setHeaderFooterSectionName(String value) Sets the name of the current header footer section.
abstract void	setHeaderLeftText(String value) This method is deprecated. not used anymore. We now use `setHeaderFooterPropValue(String, String)`
abstract void	setHeaderRightText(String value) This method is deprecated. not used anymore. We now use `setHeaderFooterPropValue(String, String)`
abstract void	setIsProjectHeaderFooter(boolean value) Sets whether the header/footer properties are the project level ones.
abstract void	setShowAdvancedOptions(boolean value) Sets whether to show the Advanced Options.
abstract void	setShowOptions(boolean showOptions) Sets whether the options page is being displayed.
abstract void	setUseForExport(boolean value) Sets whether the bean is used for Export.
abstract void	setUseForPDF(boolean value) Sets whether the bean is used for PDF.
abstract void	setUseForPDFPrint(boolean value) Sets whether the bean is used for PDF Print.
abstract void	setUseForPrint(boolean value) Sets whether the bean is used for Printing.
abstract boolean	useForHeaderFooter()

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

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 Methods

public abstract DirectExportBean getDirectExportBean ()

Returns

the direct export bean.

public abstract String getDontPromptAgain ()

Returns whether not to show the options page.

Returns

a String value indicating whether not to show the options page.

public abstract String getFooterCenterText ()

This method is deprecated.
not used anymore. We now use getHeaderFooterPropValue(String)

Returns

the center section of the footer.

public abstract String getFooterLeftText ()

This method is deprecated.
not used anymore. We now use getHeaderFooterPropValue(String)

Returns

the left section of the footer.

public abstract String getFooterRightText ()

This method is deprecated.
not used anymore. We now use getHeaderFooterPropValue(String)

Returns

the right section of the footer.

public abstract String getHeaderCenterText ()

This method is deprecated.
not used anymore. We now use getHeaderFooterPropValue(String)

Returns

the center section of the header.

public abstract boolean getHeaderFooterChanged ()

This method is deprecated.
not used anymore. This can be determined by checking if the size of getHeaderFooterProps() is greater than 0

Return whether the Header/Footer has been changed.
If we are displaying the Options page and this value is true we include header/footer values as hidden imputs in the form.

Returns

whether the Header/Footer has been changed.

public abstract String getHeaderFooterMacroPrefix ()

Returns

the prefix used for the macros on the header/footer

public abstract String getHeaderFooterMacroSuffix ()

Returns

the suffix used for the macros on the header/footer

public abstract String getHeaderFooterPropValue (String name)

Returns

the value of a property

public abstract HashMap<String, String> getHeaderFooterProps ()

Returns

the collection of all the header/footer properties (set through setHeaderFooterPropValue(String, String)

public abstract String getHeaderFooterSectionName ()

Returns the name of the current header footer section.
Used for the Header/footer editor in HTML mode.

Returns

the name of the current header footer section.

public abstract String getHeaderLeftText ()

This method is deprecated.
not used anymore. We now use getHeaderFooterPropValue(String)

Returns

the left section of the header.

public abstract String getHeaderRightText ()

This method is deprecated.
not used anymore. We now use getHeaderFooterPropValue(String)

Returns

the right section of the header.

public abstract boolean getIsProjectHeaderFooter ()

Returns whether the header/footer properties are the project level ones.
Note: Used on the Header/Footer editor.

Returns

a boolean value indicating whether the header/footer properties are the project level ones.

public abstract ReportBean getReportBean ()

Returns

the report bean.

public abstract boolean getShowAdvancedOptions ()

Returns whether to show the Advanced Options.
Used for Printing in HTML mode.

Returns

whether to show the Advanced Options.

public abstract boolean getShowOptions ()

Returns whether the options page is being displayed.
A false value means that the preferences page is being displayed.

Returns

whether the options page is being displayed.

public abstract int getType ()

Returns the type of Bean.

Returns

the type of Bean.

public abstract boolean getUseForExport ()

Returns

whether the bean is used for Export

public abstract boolean getUseForPDF ()

Returns

whether the bean is used for PDF.

public abstract boolean getUseForPDFPrint ()

Returns

whether the bean is used for PDF Print.

public abstract boolean getUseForPrint ()

Returns

whether the bean is used for Printing.

public abstract void setDontPromptAgain (String value)

Sets whether not to show the options page.

Parameters

value	a `String` value indicating whether not to show the options page.

public abstract void setFooterCenterText (String value)

This method is deprecated.
not used anymore. We now use setHeaderFooterPropValue(String, String)

Sets the center section of the footer.

Parameters

value	the center section of the footer.

public abstract void setFooterLeftText (String value)

This method is deprecated.
not used anymore. We now use setHeaderFooterPropValue(String, String)

Sets the left section of the footer.

Parameters

value	the left section of the footer.

public abstract void setFooterRightText (String value)

This method is deprecated.
not used anymore. We now use setHeaderFooterPropValue(String, String)

Sets the right section of the footer.

Parameters

value	the right section of the footer.

public abstract void setHeaderCenterText (String value)

This method is deprecated.
not used anymore. We now use setHeaderFooterPropValue(String, String)

Sets the center section of the header.

Parameters

value	the center section of the header.

public abstract void setHeaderFooterChanged (boolean value)

This method is deprecated.
not used anymore

Sets whether the Header/Footer has been changed.
If we are displaying the Options page and this value is true we include header/footer values as hidden imputs in the form.

public abstract void setHeaderFooterPropValue (String name, String value)

Sets a temporary property. These properties are part of the bean state

public abstract void setHeaderFooterSectionName (String value)

Sets the name of the current header footer section.
Used for the Header/footer editor in HTML mode.

Parameters

value	the name of the current header footer section.

public abstract void setHeaderLeftText (String value)

This method is deprecated.
not used anymore. We now use setHeaderFooterPropValue(String, String)

Sets the left section of the header.

Parameters

value	the left section of the header.

public abstract void setHeaderRightText (String value)

This method is deprecated.
not used anymore. We now use setHeaderFooterPropValue(String, String)

Sets the right section of the header.

Parameters

value	the right section of the header.

public abstract void setIsProjectHeaderFooter (boolean value)

Sets whether the header/footer properties are the project level ones.
Note: Used on the Header/Footer editor.

Parameters

value	a `boolean` value indicating whether the header/footer properties are the project level ones.

public abstract void setShowAdvancedOptions (boolean value)

Sets whether to show the Advanced Options.
Used for Printing in HTML mode.

Parameters

value	whether to show the Advanced Options

public abstract void setShowOptions (boolean showOptions)

Sets whether the options page is being displayed.

Parameters

showOptions	whether the options page is being displayed.

public abstract void setUseForExport (boolean value)

Sets whether the bean is used for Export.

Parameters

value	whether the bean is used for Export

public abstract void setUseForPDF (boolean value)

Sets whether the bean is used for PDF.

Parameters

value	whether the bean is used for PDF

public abstract void setUseForPDFPrint (boolean value)

Sets whether the bean is used for PDF Print.

Parameters

value	whether the bean is used for PDF Print

public abstract void setUseForPrint (boolean value)

Sets whether the bean is used for Printing.

Parameters

value	whether the bean is used for Printing.

public abstract boolean useForHeaderFooter ()

Returns

whether the options bean is used to display a Header/footer Editor which requires special handling.

Interfaces

Classes

Exceptions

OptionsBean

Class Overview

Summary

Public Methods

public abstract DirectExportBean getDirectExportBean ()

Returns

public abstract String getDontPromptAgain ()

Returns

public abstract String getFooterCenterText ()

Returns

public abstract String getFooterLeftText ()

Returns

public abstract String getFooterRightText ()

Returns

public abstract String getHeaderCenterText ()

Returns

public abstract boolean getHeaderFooterChanged ()

Returns

public abstract String getHeaderFooterMacroPrefix ()

Returns

public abstract String getHeaderFooterMacroSuffix ()

Returns

public abstract String getHeaderFooterPropValue (String name)

Returns

public abstract HashMap<String, String> getHeaderFooterProps ()

Returns

public abstract String getHeaderFooterSectionName ()

Returns

public abstract String getHeaderLeftText ()

Returns

public abstract String getHeaderRightText ()

Returns

public abstract boolean getIsProjectHeaderFooter ()

Returns

public abstract ReportBean getReportBean ()

Returns

public abstract boolean getShowAdvancedOptions ()

Returns

public abstract boolean getShowOptions ()

Returns

public abstract int getType ()

Returns

public abstract boolean getUseForExport ()

Returns

public abstract boolean getUseForPDF ()

Returns

public abstract boolean getUseForPDFPrint ()

Returns

public abstract boolean getUseForPrint ()

Returns

public abstract void setDontPromptAgain (String value)

Parameters

public abstract void setFooterCenterText (String value)

Parameters

public abstract void setFooterLeftText (String value)

Parameters

public abstract void setFooterRightText (String value)

Parameters

public abstract void setHeaderCenterText (String value)

Parameters

public abstract void setHeaderFooterChanged (boolean value)

public abstract void setHeaderFooterPropValue (String name, String value)

public abstract void setHeaderFooterSectionName (String value)

Parameters

public abstract void setHeaderLeftText (String value)

Parameters

public abstract void setHeaderRightText (String value)

Parameters

public abstract void setIsProjectHeaderFooter (boolean value)

Parameters

public abstract void setShowAdvancedOptions (boolean value)

Parameters

public abstract void setShowOptions (boolean showOptions)

Parameters

public abstract void setUseForExport (boolean value)

Parameters

public abstract void setUseForPDF (boolean value)