public class

OptionsBeanImpl

extends PreferencesBeanImpl
implements OptionsBean

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.PreferencesBeanImpl
						↳	com.microstrategy.web.app.beans.OptionsBeanImpl

This class is deprecated.
this class will be made non-public

Class Overview

The OptionsBeanImpl 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

Constants
String	PREFERENCE_FOOTER_CENTER
String	PREFERENCE_FOOTER_LEFT
String	PREFERENCE_FOOTER_RIGHT
String	PREFERENCE_HEADER_CENTER
String	PREFERENCE_HEADER_FOOTER_CHANGED
String	PREFERENCE_HEADER_LEFT
String	PREFERENCE_HEADER_RIGHT

[Expand]

Inherited Constants

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

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

[Expand]

Inherited Fields

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

From class com.microstrategy.web.beans.AbstractWebComponent

From class com.microstrategy.web.beans.AbstractTransformable

From class com.microstrategy.utils.serialization.AbstractPersistable

Public Methods
MarkupOutput	generateOutput() Uses a transform to generate the output.
DirectExportBean	getDirectExportBean()
String	getDontPromptAgain() Returns whether not to show the options page.
String	getFooterCenterText() This method is deprecated. we now use `getHeaderFooterPropValue(String)`
String	getFooterLeftText() This method is deprecated. we now use `getHeaderFooterPropValue(String)`
String	getFooterRightText() This method is deprecated. we now use `getHeaderFooterPropValue(String)`
String	getHeaderCenterText() This method is deprecated. we now use `getHeaderFooterPropValue(String)`
boolean	getHeaderFooterChanged() Return whether the Header/Footer has been changed.
String	getHeaderFooterMacroPrefix()
String	getHeaderFooterMacroSuffix()
String	getHeaderFooterPropValue(String name)
HashMap<String, String>	getHeaderFooterProps()
String	getHeaderFooterSectionName() Returns the name of the current header footer section.
String	getHeaderLeftText() This method is deprecated. we now use `getHeaderFooterPropValue(String)`
String	getHeaderRightText() This method is deprecated. we now use `getHeaderFooterPropValue(String)`
boolean	getIsProjectHeaderFooter() Returns whether the header/footer properties are the project level ones.
ReportBean	getReportBean()
boolean	getShowAdvancedOptions() Returns whether to show the Advanced Options.
boolean	getShowOptions() Returns whether the options page is being displayed.
int	getType() Returns the type of Bean.
boolean	getUseForExport()
boolean	getUseForPDF()
boolean	getUseForPDFPrint()
boolean	getUseForPrint()
void	setDontPromptAgain(String value) Sets whether not to show the options page.
void	setFooterCenterText(String value) This method is deprecated. we now use `setHeaderFooterPropValue(String, String)`
void	setFooterLeftText(String value) This method is deprecated. we now use `setHeaderFooterPropValue(String, String)`
void	setFooterRightText(String value) This method is deprecated. we now use `setHeaderFooterPropValue(String, String)`
void	setHeaderCenterText(String value) This method is deprecated. we now use `setHeaderFooterPropValue(String, String)`
void	setHeaderFooterChanged(boolean value) Sets whether the Header/Footer has been changed.
void	setHeaderFooterPropValue(String name, String value) Sets a temporary property.
void	setHeaderFooterSectionName(String value) Sets the name of the current header footer section.
void	setHeaderLeftText(String value) This method is deprecated. we now use `setHeaderFooterPropValue(String, String)`
void	setHeaderRightText(String value) This method is deprecated. we now use `setHeaderFooterPropValue(String, String)`
void	setIsProjectHeaderFooter(boolean value) Sets whether the header/footer properties are the project level ones.
void	setShowAdvancedOptions(boolean value) Sets whether to show the Advanced Options.
void	setShowOptions(boolean showOptions) Sets whether the options page is being displayed.
void	setUseForExport(boolean value) Sets whether the bean is used for Export.
void	setUseForPDF(boolean value) Sets whether the bean is used for PDF.
void	setUseForPDFPrint(boolean value) Sets whether the bean is used for PDF Print.
void	setUseForPrint(boolean value) Sets whether the bean is used for Printing.
boolean	useForHeaderFooter()

Protected Methods
void	doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer) Proceses the save/restore state opperation of the AppComponent
WebEventHandler	newDefaultEventHandler()

[Expand]

Inherited Methods

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

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

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.

Constants

protected static final String PREFERENCE_FOOTER_CENTER

Constant Value: "fc"

protected static final String PREFERENCE_FOOTER_LEFT

Constant Value: "fl"

protected static final String PREFERENCE_FOOTER_RIGHT

Constant Value: "fr"

protected static final String PREFERENCE_HEADER_CENTER

Constant Value: "hc"

protected static final String PREFERENCE_HEADER_FOOTER_CHANGED

Constant Value: "hfc"

protected static final String PREFERENCE_HEADER_LEFT

Constant Value: "hl"

protected static final String PREFERENCE_HEADER_RIGHT

Constant Value: "hr"

Public Methods

public MarkupOutput generateOutput ()

Uses a transform to generate the output. The transform used will be the one of the current group.

Returns

the dialog for the current Preferences group

public DirectExportBean getDirectExportBean ()

Returns

the direct export bean.

public String getDontPromptAgain ()

Returns whether not to show the options page.

Returns

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

public String getFooterCenterText ()

This method is deprecated.
we now use getHeaderFooterPropValue(String)

Returns

the center section of the footer.

public String getFooterLeftText ()

This method is deprecated.
we now use getHeaderFooterPropValue(String)

Returns

the left section of the footer.

public String getFooterRightText ()

This method is deprecated.
we now use getHeaderFooterPropValue(String)

Returns

the right section of the footer.

public String getHeaderCenterText ()

This method is deprecated.
we now use getHeaderFooterPropValue(String)

Returns

the center section of the header.

public boolean getHeaderFooterChanged ()

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 String getHeaderFooterMacroPrefix ()

public String getHeaderFooterMacroSuffix ()

public String getHeaderFooterPropValue (String name)

public HashMap<String, String> getHeaderFooterProps ()

public 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 String getHeaderLeftText ()

This method is deprecated.
we now use getHeaderFooterPropValue(String)

Returns

the left section of the header.

public String getHeaderRightText ()

This method is deprecated.
we now use getHeaderFooterPropValue(String)

Returns

the right section of the header.

public 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 ReportBean getReportBean ()

Returns

the report bean.

public boolean getShowAdvancedOptions ()

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

Returns

whether to show the Advanced Options.

public 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 int getType ()

Returns the type of Bean.

Returns

the type of Bean.

public boolean getUseForExport ()

Returns

whether the bean is used for Export

public boolean getUseForPDF ()

Returns

whether the bean is used for PDF.

public boolean getUseForPDFPrint ()

Returns

whether the bean is used for PDF Print.

public boolean getUseForPrint ()

Returns

whether the bean is used for Printing.

public 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 void setFooterCenterText (String value)

This method is deprecated.
we now use setHeaderFooterPropValue(String, String)

Sets the center section of the footer.

Parameters

value	the center section of the footer.

public void setFooterLeftText (String value)

This method is deprecated.
we now use setHeaderFooterPropValue(String, String)

Sets the left section of the footer.

Parameters

value	the left section of the footer.

public void setFooterRightText (String value)

This method is deprecated.
we now use setHeaderFooterPropValue(String, String)

Sets the right section of the footer.

Parameters

value	the right section of the footer.

public void setHeaderCenterText (String value)

This method is deprecated.
we now use setHeaderFooterPropValue(String, String)

Sets the center section of the header.

Parameters

value	the center section of the header.

public void setHeaderFooterChanged (boolean value)

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 void setHeaderFooterPropValue (String name, String value)

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

public 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 void setHeaderLeftText (String value)

This method is deprecated.
we now use setHeaderFooterPropValue(String, String)

Sets the left section of the header.

Parameters

value	the left section of the header.

public void setHeaderRightText (String value)

This method is deprecated.
we now use setHeaderFooterPropValue(String, String)

Sets the right section of the header.

Parameters

value	the right section of the header.

public 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 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 void setShowOptions (boolean showOptions)

Sets whether the options page is being displayed.

Parameters

showOptions	whether the options page is being displayed.

public void setUseForExport (boolean value)

Sets whether the bean is used for Export.

Parameters

value	whether the bean is used for Export

public void setUseForPDF (boolean value)

Sets whether the bean is used for PDF.

Parameters

value	whether the bean is used for PDF

public void setUseForPDFPrint (boolean value)

Sets whether the bean is used for PDF Print.

Parameters

value	whether the bean is used for PDF Print

public void setUseForPrint (boolean value)

Sets whether the bean is used for Printing.

Parameters

value	whether the bean is used for Printing.

public boolean useForHeaderFooter ()

Protected Methods

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

Proceses the save/restore state opperation of the AppComponent

Parameters

serializer	an instance of the `FlatStateSerializer` object to use
howMuchState	defines how much information needs to be saved
tokenizer	an instance of the `FlatStateTokenizer` object to use

Interfaces

Classes

Exceptions

OptionsBeanImpl

Class Overview

Summary

Constants

protected static final String PREFERENCE_FOOTER_CENTER

protected static final String PREFERENCE_FOOTER_LEFT

protected static final String PREFERENCE_FOOTER_RIGHT

protected static final String PREFERENCE_HEADER_CENTER

protected static final String PREFERENCE_HEADER_FOOTER_CHANGED

protected static final String PREFERENCE_HEADER_LEFT

protected static final String PREFERENCE_HEADER_RIGHT

Public Methods

public MarkupOutput generateOutput ()

Returns

public DirectExportBean getDirectExportBean ()

Returns

public String getDontPromptAgain ()

Returns

public String getFooterCenterText ()

Returns

public String getFooterLeftText ()

Returns

public String getFooterRightText ()

Returns

public String getHeaderCenterText ()

Returns

public boolean getHeaderFooterChanged ()

Returns

public String getHeaderFooterMacroPrefix ()

public String getHeaderFooterMacroSuffix ()

public String getHeaderFooterPropValue (String name)

public HashMap<String, String> getHeaderFooterProps ()

public String getHeaderFooterSectionName ()

Returns

public String getHeaderLeftText ()

Returns

public String getHeaderRightText ()

Returns

public boolean getIsProjectHeaderFooter ()

Returns

public ReportBean getReportBean ()

Returns

public boolean getShowAdvancedOptions ()

Returns

public boolean getShowOptions ()

Returns

public int getType ()

Returns

public boolean getUseForExport ()

Returns

public boolean getUseForPDF ()

Returns

public boolean getUseForPDFPrint ()

Returns

public boolean getUseForPrint ()

Returns

public void setDontPromptAgain (String value)

Parameters

public void setFooterCenterText (String value)

Parameters

public void setFooterLeftText (String value)

Parameters

public void setFooterRightText (String value)

Parameters

public void setHeaderCenterText (String value)

Parameters

public void setHeaderFooterChanged (boolean value)

public void setHeaderFooterPropValue (String name, String value)

public void setHeaderFooterSectionName (String value)

Parameters

public void setHeaderLeftText (String value)

Parameters

public void setHeaderRightText (String value)

Parameters

public void setIsProjectHeaderFooter (boolean value)

Parameters

public void setShowAdvancedOptions (boolean value)