Package com.microstrategy.web.app.beans

Class OptionsBeanImpl

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

All Implemented Interfaces:

EnumWebPersistableState, Persistable, AppComponent, OptionsBean, PreferencesBean, RequestPersistable, Transformable, WebComponent

public class OptionsBeanImpl
extends PreferencesBeanImpl
implements OptionsBean

Deprecated.

this class will be made non-public

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.

Since:

MicroStrategy Web 7.3.1 or earlier

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.web.app.beans.PreferencesBeanImpl

PreferencesBeanImpl.GroupInfoImpl

Nested classes/interfaces inherited from interface com.microstrategy.web.app.beans.PreferencesBean

PreferencesBean.GroupInfo

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	PREFERENCE_FOOTER_CENTER	Deprecated.
protected static java.lang.String	PREFERENCE_FOOTER_LEFT	Deprecated.
protected static java.lang.String	PREFERENCE_FOOTER_RIGHT	Deprecated.
protected static java.lang.String	PREFERENCE_HEADER_CENTER	Deprecated.
protected static java.lang.String	PREFERENCE_HEADER_FOOTER_CHANGED	Deprecated.
protected static java.lang.String	PREFERENCE_HEADER_LEFT	Deprecated.
protected static java.lang.String	PREFERENCE_HEADER_RIGHT	Deprecated.

Fields inherited from class com.microstrategy.web.app.beans.PreferencesBeanImpl

_applyToAllProjects, _currentGroup, _currentGroupSet, _prevGroupName, PREFERENCE_CURRENT_GROUP, PREFERENCE_CURRENT_GROUP_SET, SEPARATOR, TOKEN_DIV

Fields inherited from class com.microstrategy.web.app.beans.AbstractPersistableAppComponent

STATE_DELIMITOR, STATE_ITEM_SEPARATOR

Fields inherited from class com.microstrategy.web.beans.AbstractWebComponent

_features, _hasJustOpened

Fields inherited from class com.microstrategy.web.beans.AbstractTransformable

_beanContext

Fields inherited from class com.microstrategy.utils.serialization.AbstractPersistable

scriptEndTagEncoder

Fields inherited from interface com.microstrategy.web.app.beans.AppComponent

COMPONENT_POSITION_NOT_INITIALIZED

Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState

BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Fields inherited from interface com.microstrategy.web.app.beans.PreferencesBean

KEEP_TEMP_PREFERENCE, SAVE_TEMP_PREFERENCE

Method Summary

Modifier and Type	Method	Description
protected void	doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)	Deprecated. Proceses the save/restore state opperation of the AppComponent
MarkupOutput	generateOutput()	Deprecated. Uses a transform to generate the output.
DirectExportBean	getDirectExportBean()	Deprecated.
java.lang.String	getDontPromptAgain()	Deprecated. Returns whether not to show the options page.
java.lang.String	getFooterCenterText()	Deprecated. we now use OptionsBean.getHeaderFooterPropValue(String)
java.lang.String	getFooterLeftText()	Deprecated. we now use OptionsBean.getHeaderFooterPropValue(String)
java.lang.String	getFooterRightText()	Deprecated. we now use OptionsBean.getHeaderFooterPropValue(String)
java.lang.String	getHeaderCenterText()	Deprecated. we now use OptionsBean.getHeaderFooterPropValue(String)
boolean	getHeaderFooterChanged()	Deprecated. Return whether the Header/Footer has been changed.
java.lang.String	getHeaderFooterMacroPrefix()	Deprecated.
java.lang.String	getHeaderFooterMacroSuffix()	Deprecated.
java.util.HashMap<java.lang.String,java.lang.String>	getHeaderFooterProps()	Deprecated.
java.lang.String	getHeaderFooterPropValue(java.lang.String name)	Deprecated.
java.lang.String	getHeaderFooterSectionName()	Deprecated. Returns the name of the current header footer section.
java.lang.String	getHeaderLeftText()	Deprecated. we now use OptionsBean.getHeaderFooterPropValue(String)
java.lang.String	getHeaderRightText()	Deprecated. we now use OptionsBean.getHeaderFooterPropValue(String)
boolean	getIsProjectHeaderFooter()	Deprecated. Returns whether the header/footer properties are the project level ones.
ReportBean	getReportBean()	Deprecated.
boolean	getShowAdvancedOptions()	Deprecated. Returns whether to show the Advanced Options.
boolean	getShowOptions()	Deprecated. Returns whether the options page is being displayed.
int	getType()	Deprecated. Returns the type of Bean.
boolean	getUseForExport()	Deprecated.
boolean	getUseForPDF()	Deprecated.
boolean	getUseForPDFPrint()	Deprecated.
boolean	getUseForPrint()	Deprecated.
protected WebEventHandler	newDefaultEventHandler()	Deprecated.
void	setDontPromptAgain(java.lang.String value)	Deprecated. Sets whether not to show the options page.
void	setFooterCenterText(java.lang.String value)	Deprecated. we now use OptionsBean.setHeaderFooterPropValue(String, String)
void	setFooterLeftText(java.lang.String value)	Deprecated. we now use OptionsBean.setHeaderFooterPropValue(String, String)
void	setFooterRightText(java.lang.String value)	Deprecated. we now use OptionsBean.setHeaderFooterPropValue(String, String)
void	setHeaderCenterText(java.lang.String value)	Deprecated. we now use OptionsBean.setHeaderFooterPropValue(String, String)
void	setHeaderFooterChanged(boolean value)	Deprecated. Sets whether the Header/Footer has been changed.
void	setHeaderFooterPropValue(java.lang.String name, java.lang.String value)	Deprecated. Sets a temporary property.
void	setHeaderFooterSectionName(java.lang.String value)	Deprecated. Sets the name of the current header footer section.
void	setHeaderLeftText(java.lang.String value)	Deprecated. we now use OptionsBean.setHeaderFooterPropValue(String, String)
void	setHeaderRightText(java.lang.String value)	Deprecated. we now use OptionsBean.setHeaderFooterPropValue(String, String)
void	setIsProjectHeaderFooter(boolean value)	Deprecated. Sets whether the header/footer properties are the project level ones.
void	setShowAdvancedOptions(boolean value)	Deprecated. Sets whether to show the Advanced Options.
void	setShowOptions(boolean showOptions)	Deprecated. Sets whether the options page is being displayed.
void	setUseForExport(boolean value)	Deprecated. Sets whether the bean is used for Export.
void	setUseForPDF(boolean value)	Deprecated. Sets whether the bean is used for PDF.
void	setUseForPDFPrint(boolean value)	Deprecated. Sets whether the bean is used for PDF Print.
void	setUseForPrint(boolean value)	Deprecated. Sets whether the bean is used for Printing.
boolean	useForHeaderFooter()	Deprecated.

Methods inherited from class com.microstrategy.web.app.beans.PreferencesBeanImpl

afterUpdate, collectData, getApplyToAllProjects, getCurrentGroup, getCurrentGroupInfo, getCurrentGroupName, getCurrentGroupSet, getCurrentGroupSetInfo, getCurrentLevel, getFeatureInfos, getGroupSetInfo, getPrevGroupName, getSettingVisibility, getTemporalValues, getValidationErrors, getValidationMessage, getValues, getVisibleGroupSetCount, getXMLStatus, hasValidationErrors, havePreferencesChanged, initFromXML, isLoginRequired, isValidLevel, isValidPreference, renderGroupsList, renderGroupsList, setApplyToAllProjects, setBeanContext, setCurrentGroup, setCurrentGroupSet, setIsLoginRequired, setPrevGroupName, setSettingVisibility, setXMLStatus, toggleSettingsVisibility

Methods inherited from class com.microstrategy.web.app.beans.AbstractPersistableAppComponent

addChildStateInfo, isCookieOpen, isSaveStateEnabled, saveState, saveState, saveState, saveState

Methods inherited from class com.microstrategy.web.app.beans.AbstractAppComponent

addChildStateInfo, collectMinimalData, compareChildsTargetWithCurrent, createTransformInstance, doCollectData, doCollectMinimalData, getAppContext, getContactInfo, getContainerServices, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getFeaturesManager, getLeft, getObjectSource, getResultFilterMode, getSession, getTargetBean, getTop, getWebObjectsFactory, getWebObjectsFactory, hasChanged, hasTargetBeanChanged, haveChildrenChanged, initComponent, internalCollectData, isDialog, isForcedChildrenStateSaving, isIFrameRequest, isModal, isModalOpen, isOpen, newDefaultBeanContext, newHiddenInputBuilder, newNamespaceEncoder, newStyleRequestContext, newURIBuilder, setExtraInput, setExtraUrl, setForcedChildrenStateSaving, setHasJustOpened, setIsDialog, setIsModal, setIsOpen, setLeft, setOutputFormat, setTop

Methods inherited from class com.microstrategy.web.beans.AbstractWebComponent

addChild, addChildStateInfo, addChildStateInfo, addChildStateInfo, addStateInfo, childValues, clearChildren, clearStateCache, getCachedState, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, handleRequest, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isChangeComparisonFlagSet, isFeatureAvailable, prepareForReuse, removeChild, removeChild, restoreState, restoreStateFromRequest, restoreStateFromRequest, saveXMLState, saveXMLState, saveXMLState, searchChild, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setParent, setPersistMode, setRenderingFilter, setStateCache, setTargetBean, setTargetBeanPath, setWebEventHandler

Methods inherited from class com.microstrategy.web.beans.AbstractTransformable

addTransform, addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, createTransformInstance, getBeanContext, getDefaultTransform, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, hasTransform, hasTransform, internalCollectData, internalCollectData, invalidateTransformCache, isTransformSuitable, transform, transform, transform, transform

Methods inherited from class com.microstrategy.utils.serialization.AbstractPersistable

doFlatState, getStateHandler, isXMLStateZipped, restoreState, restoreXMLState, saveXMLState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.microstrategy.web.app.beans.AppComponent

getAppContext, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getLeft, getResultFilterMode, getTop, isDialog, isForcedChildrenStateSaving, isModal, isModalOpen, isOpen, setExtraInput, setExtraUrl, setForcedChildrenStateSaving, setHasJustOpened, setIsDialog, setIsModal, setIsOpen, setLeft, setTop

Methods inherited from interface com.microstrategy.utils.serialization.Persistable

restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.web.app.beans.PreferencesBean

afterUpdate, getApplyToAllProjects, getCurrentGroup, getCurrentGroupInfo, getCurrentGroupName, getCurrentGroupSet, getCurrentGroupSetInfo, getCurrentLevel, getFeatureInfos, getGroupSetInfo, getPrevGroupName, getSettingVisibility, getTemporalValues, getValidationMessage, getValues, hasValidationErrors, havePreferencesChanged, initFromXML, isLoginRequired, isValidLevel, isValidPreference, renderGroupsList, renderGroupsList, setApplyToAllProjects, setCurrentGroup, setCurrentGroupSet, setIsLoginRequired, setPrevGroupName, setSettingVisibility, setXMLStatus, toggleSettingsVisibility

Methods inherited from interface com.microstrategy.web.beans.RequestPersistable

restoreStateFromRequest, restoreStateFromRequest

Methods inherited from interface com.microstrategy.web.beans.Transformable

addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, getBeanContext, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, hasTransform, hasTransform, invalidateTransformCache, setBeanContext, transform, transform

Methods inherited from interface com.microstrategy.web.beans.WebComponent

addChild, addChildStateInfo, addChildStateInfo, collectData, collectMinimalData, getBeanContext, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getFeaturesManager, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBean, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, getXMLStatus, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setTargetBean, setTargetBeanPath, setWebEventHandler

Field Detail

PREFERENCE_HEADER_LEFT

protected static final java.lang.String PREFERENCE_HEADER_LEFT

Deprecated.

See Also:

Constant Field Values

PREFERENCE_HEADER_CENTER

protected static final java.lang.String PREFERENCE_HEADER_CENTER

Deprecated.

See Also:

Constant Field Values

PREFERENCE_HEADER_RIGHT

protected static final java.lang.String PREFERENCE_HEADER_RIGHT

Deprecated.

See Also:

Constant Field Values

PREFERENCE_FOOTER_LEFT

protected static final java.lang.String PREFERENCE_FOOTER_LEFT

Deprecated.

See Also:

Constant Field Values

PREFERENCE_FOOTER_CENTER

protected static final java.lang.String PREFERENCE_FOOTER_CENTER

Deprecated.

See Also:

Constant Field Values

PREFERENCE_FOOTER_RIGHT

protected static final java.lang.String PREFERENCE_FOOTER_RIGHT

Deprecated.

See Also:

Constant Field Values

PREFERENCE_HEADER_FOOTER_CHANGED

protected static final java.lang.String PREFERENCE_HEADER_FOOTER_CHANGED

Deprecated.

See Also:

Constant Field Values

Method Detail

generateOutput

public MarkupOutput generateOutput()

Deprecated.

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

Specified by:

generateOutput in interface WebComponent

Overrides:

generateOutput in class PreferencesBeanImpl

Returns:

the dialog for the current Preferences group

doFlatState

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

Deprecated.

Description copied from class: AbstractPersistableAppComponent

Proceses the save/restore state opperation of the AppComponent

Overrides:

doFlatState in class PreferencesBeanImpl

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

getShowOptions

public boolean getShowOptions()

Deprecated.

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

Specified by:

getShowOptions in interface OptionsBean

Returns:

whether the options page is being displayed.

setShowOptions

public void setShowOptions(boolean showOptions)

Deprecated.

Sets whether the options page is being displayed.

Specified by:

setShowOptions in interface OptionsBean

Parameters:

showOptions - whether the options page is being displayed.

getShowAdvancedOptions

public boolean getShowAdvancedOptions()

Deprecated.

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

Specified by:

getShowAdvancedOptions in interface OptionsBean

Returns:

whether to show the Advanced Options.

setShowAdvancedOptions

public void setShowAdvancedOptions(boolean value)

Deprecated.

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

Specified by:

setShowAdvancedOptions in interface OptionsBean

Parameters:

value - whether to show the Advanced Options

getUseForPrint

public boolean getUseForPrint()

Deprecated.

Specified by:

getUseForPrint in interface OptionsBean

Returns:

whether the bean is used for Printing.

setUseForPrint

public void setUseForPrint(boolean value)

Deprecated.

Sets whether the bean is used for Printing.

Specified by:

setUseForPrint in interface OptionsBean

Parameters:

value - whether the bean is used for Printing.

getUseForPDF

public boolean getUseForPDF()

Deprecated.

Specified by:

getUseForPDF in interface OptionsBean

Returns:

whether the bean is used for PDF.

setUseForPDF

public void setUseForPDF(boolean value)

Deprecated.

Sets whether the bean is used for PDF.

Specified by:

setUseForPDF in interface OptionsBean

Parameters:

value - whether the bean is used for PDF

getUseForPDFPrint

public boolean getUseForPDFPrint()

Deprecated.

Specified by:

getUseForPDFPrint in interface OptionsBean

Returns:

whether the bean is used for PDF Print.

Since:

MicroStrategy Web 8.0.0

setUseForPDFPrint

public void setUseForPDFPrint(boolean value)

Deprecated.

Sets whether the bean is used for PDF Print.

Specified by:

setUseForPDFPrint in interface OptionsBean

Parameters:

value - whether the bean is used for PDF Print

Since:

MicroStrategy Web 8.0.0

getUseForExport

public boolean getUseForExport()

Deprecated.

Specified by:

getUseForExport in interface OptionsBean

Returns:

whether the bean is used for Export

setUseForExport

public void setUseForExport(boolean value)

Deprecated.

Sets whether the bean is used for Export.

Specified by:

setUseForExport in interface OptionsBean

Parameters:

value - whether the bean is used for Export

getHeaderFooterChanged

public boolean getHeaderFooterChanged()

Deprecated.

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.

Specified by:

getHeaderFooterChanged in interface OptionsBean

Returns:

whether the Header/Footer has been changed.

setHeaderFooterChanged

public void setHeaderFooterChanged(boolean value)

Deprecated.

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.

Specified by:

setHeaderFooterChanged in interface OptionsBean

Parameters:

value -

getHeaderFooterSectionName

public java.lang.String getHeaderFooterSectionName()

Deprecated.

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

Specified by:

getHeaderFooterSectionName in interface OptionsBean

Returns:

the name of the current header footer section.

setHeaderFooterSectionName

public void setHeaderFooterSectionName(java.lang.String value)

Deprecated.

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

Specified by:

setHeaderFooterSectionName in interface OptionsBean

Parameters:

value - the name of the current header footer section.

getHeaderLeftText

public java.lang.String getHeaderLeftText()

Deprecated.

we now use OptionsBean.getHeaderFooterPropValue(String)

Specified by:

getHeaderLeftText in interface OptionsBean

Returns:

the left section of the header.

setHeaderLeftText

public void setHeaderLeftText(java.lang.String value)

Deprecated.

we now use OptionsBean.setHeaderFooterPropValue(String, String)

Sets the left section of the header.

Specified by:

setHeaderLeftText in interface OptionsBean

Parameters:

value - the left section of the header.

getHeaderCenterText

public java.lang.String getHeaderCenterText()

Deprecated.

we now use OptionsBean.getHeaderFooterPropValue(String)

Specified by:

getHeaderCenterText in interface OptionsBean

Returns:

the center section of the header.

setHeaderCenterText

public void setHeaderCenterText(java.lang.String value)

Deprecated.

we now use OptionsBean.setHeaderFooterPropValue(String, String)

Sets the center section of the header.

Specified by:

setHeaderCenterText in interface OptionsBean

Parameters:

value - the center section of the header.

getHeaderRightText

public java.lang.String getHeaderRightText()

Deprecated.

we now use OptionsBean.getHeaderFooterPropValue(String)

Specified by:

getHeaderRightText in interface OptionsBean

Returns:

the right section of the header.

setHeaderRightText

public void setHeaderRightText(java.lang.String value)

Deprecated.

we now use OptionsBean.setHeaderFooterPropValue(String, String)

Sets the right section of the header.

Specified by:

setHeaderRightText in interface OptionsBean

Parameters:

value - the right section of the header.

getFooterLeftText

public java.lang.String getFooterLeftText()

Deprecated.

we now use OptionsBean.getHeaderFooterPropValue(String)

Specified by:

getFooterLeftText in interface OptionsBean

Returns:

the left section of the footer.

setFooterLeftText

public void setFooterLeftText(java.lang.String value)

Deprecated.

we now use OptionsBean.setHeaderFooterPropValue(String, String)

Sets the left section of the footer.

Specified by:

setFooterLeftText in interface OptionsBean

Parameters:

value - the left section of the footer.

getFooterCenterText

public java.lang.String getFooterCenterText()

Deprecated.

we now use OptionsBean.getHeaderFooterPropValue(String)

Specified by:

getFooterCenterText in interface OptionsBean

Returns:

the center section of the footer.

setFooterCenterText

public void setFooterCenterText(java.lang.String value)

Deprecated.

we now use OptionsBean.setHeaderFooterPropValue(String, String)

Sets the center section of the footer.

Specified by:

setFooterCenterText in interface OptionsBean

Parameters:

value - the center section of the footer.

getFooterRightText

public java.lang.String getFooterRightText()

Deprecated.

we now use OptionsBean.getHeaderFooterPropValue(String)

Specified by:

getFooterRightText in interface OptionsBean

Returns:

the right section of the footer.

setFooterRightText

public void setFooterRightText(java.lang.String value)

Deprecated.

we now use OptionsBean.setHeaderFooterPropValue(String, String)

Sets the right section of the footer.

Specified by:

setFooterRightText in interface OptionsBean

Parameters:

value - the right section of the footer.

getReportBean

public ReportBean getReportBean()

Deprecated.

Specified by:

getReportBean in interface OptionsBean

Returns:

the report bean.

getDirectExportBean

public DirectExportBean getDirectExportBean()

Deprecated.

Specified by:

getDirectExportBean in interface OptionsBean

Returns:

the direct export bean.

Since:

MicroStrategy Web 8.0.0

getType

public int getType()

Deprecated.

Returns the type of Bean.

Specified by:

getType in interface OptionsBean

Specified by:

getType in interface PreferencesBean

Specified by:

getType in interface Transformable

Overrides:

getType in class PreferencesBeanImpl

Returns:

the type of Bean.

getDontPromptAgain

public java.lang.String getDontPromptAgain()

Deprecated.

Returns whether not to show the options page.

Specified by:

getDontPromptAgain in interface OptionsBean

Returns:

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

Since:

MicroStrategy Web 8.0.0

setDontPromptAgain

public void setDontPromptAgain(java.lang.String value)

Deprecated.

Sets whether not to show the options page.

Specified by:

setDontPromptAgain in interface OptionsBean

Parameters:

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

Since:

MicroStrategy Web 8.0.0

getIsProjectHeaderFooter

public boolean getIsProjectHeaderFooter()

Deprecated.

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

Specified by:

getIsProjectHeaderFooter in interface OptionsBean

Returns:

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

Since:

MicroStrategy Web 8.0.0

setIsProjectHeaderFooter

public void setIsProjectHeaderFooter(boolean value)

Deprecated.

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

Specified by:

setIsProjectHeaderFooter in interface OptionsBean

Parameters:

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

Since:

MicroStrategy Web 8.0.0

newDefaultEventHandler

protected WebEventHandler newDefaultEventHandler()

Deprecated.

Overrides:

newDefaultEventHandler in class PreferencesBeanImpl

Since:

MicroStrategy Web 9.0.0

getHeaderFooterMacroPrefix

public java.lang.String getHeaderFooterMacroPrefix()

Deprecated.

Specified by:

getHeaderFooterMacroPrefix in interface OptionsBean

Returns:

the prefix used for the macros on the header/footer

Since:

MicroStrategy Web 9.0.0

getHeaderFooterMacroSuffix

public java.lang.String getHeaderFooterMacroSuffix()

Deprecated.

Specified by:

getHeaderFooterMacroSuffix in interface OptionsBean

Returns:

the suffix used for the macros on the header/footer

Since:

MicroStrategy Web 9.0.0

getHeaderFooterPropValue

public java.lang.String getHeaderFooterPropValue(java.lang.String name)

Deprecated.

Specified by:

getHeaderFooterPropValue in interface OptionsBean

Returns:

the value of a property

Since:

MicroStrategy Web 9.0.0

setHeaderFooterPropValue

public void setHeaderFooterPropValue(java.lang.String name,
                                     java.lang.String value)

Deprecated.

Description copied from interface: OptionsBean

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

Specified by:

setHeaderFooterPropValue in interface OptionsBean

Since:

MicroStrategy Web 9.0.0

useForHeaderFooter

public boolean useForHeaderFooter()

Deprecated.

Specified by:

useForHeaderFooter in interface OptionsBean

Returns:

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

Since:

MicroStrategy Web 9.0.0

getHeaderFooterProps

public java.util.HashMap<java.lang.String,java.lang.String> getHeaderFooterProps()

Deprecated.

Specified by:

getHeaderFooterProps in interface OptionsBean

Returns:

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

Since:

MicroStrategy Web 9.0.0