Package com.microstrategy.web.app.beans
Interface OptionsBean
-
- All Superinterfaces:
AppComponent
,EnumWebPersistableState
,Persistable
,PreferencesBean
,RequestPersistable
,Transformable
,WebComponent
- All Known Implementing Classes:
OptionsBeanImpl
public interface OptionsBean extends PreferencesBean
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.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.microstrategy.web.app.beans.PreferencesBean
PreferencesBean.GroupInfo
-
-
Field Summary
-
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
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description DirectExportBean
getDirectExportBean()
java.lang.String
getDontPromptAgain()
Returns whether not to show the options page.java.lang.String
getFooterCenterText()
Deprecated.not used anymore.java.lang.String
getFooterLeftText()
Deprecated.not used anymore.java.lang.String
getFooterRightText()
Deprecated.not used anymore.java.lang.String
getHeaderCenterText()
Deprecated.not used anymore.boolean
getHeaderFooterChanged()
Deprecated.not used anymore.java.lang.String
getHeaderFooterMacroPrefix()
java.lang.String
getHeaderFooterMacroSuffix()
java.util.HashMap<java.lang.String,java.lang.String>
getHeaderFooterProps()
java.lang.String
getHeaderFooterPropValue(java.lang.String name)
java.lang.String
getHeaderFooterSectionName()
Returns the name of the current header footer section.java.lang.String
getHeaderLeftText()
Deprecated.not used anymore.java.lang.String
getHeaderRightText()
Deprecated.not used anymore.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(java.lang.String value)
Sets whether not to show the options page.void
setFooterCenterText(java.lang.String value)
Deprecated.not used anymore.void
setFooterLeftText(java.lang.String value)
Deprecated.not used anymore.void
setFooterRightText(java.lang.String value)
Deprecated.not used anymore.void
setHeaderCenterText(java.lang.String value)
Deprecated.not used anymore.void
setHeaderFooterChanged(boolean value)
Deprecated.not used anymorevoid
setHeaderFooterPropValue(java.lang.String name, java.lang.String value)
Sets a temporary property.void
setHeaderFooterSectionName(java.lang.String value)
Sets the name of the current header footer section.void
setHeaderLeftText(java.lang.String value)
Deprecated.not used anymore.void
setHeaderRightText(java.lang.String value)
Deprecated.not used anymore.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()
-
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, generateOutput, getBeanContext, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getFeaturesManager, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBean, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, getXMLStatus, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setTargetBean, setTargetBeanPath, setWebEventHandler
-
-
-
-
Method Detail
-
getShowAdvancedOptions
boolean getShowAdvancedOptions()
Returns whether to show the Advanced Options.
Used for Printing in HTML mode.- Returns:
- whether to show the Advanced Options.
-
setShowAdvancedOptions
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
-
getUseForPrint
boolean getUseForPrint()
- Returns:
- whether the bean is used for Printing.
-
setUseForPrint
void setUseForPrint(boolean value)
Sets whether the bean is used for Printing.- Parameters:
value
- whether the bean is used for Printing.
-
getUseForPDF
boolean getUseForPDF()
- Returns:
- whether the bean is used for PDF.
-
setUseForPDF
void setUseForPDF(boolean value)
Sets whether the bean is used for PDF.- Parameters:
value
- whether the bean is used for PDF
-
getUseForPDFPrint
boolean getUseForPDFPrint()
- Returns:
- whether the bean is used for PDF Print.
- Since:
- MicroStrategy Web 8.0.0
-
setUseForPDFPrint
void setUseForPDFPrint(boolean value)
Sets whether the bean is used for PDF Print.- Parameters:
value
- whether the bean is used for PDF Print- Since:
- MicroStrategy Web 8.0.0
-
getUseForExport
boolean getUseForExport()
- Returns:
- whether the bean is used for Export
-
setUseForExport
void setUseForExport(boolean value)
Sets whether the bean is used for Export.- Parameters:
value
- whether the bean is used for Export
-
getHeaderFooterChanged
boolean getHeaderFooterChanged()
Deprecated.not used anymore. This can be determined by checking if the size ofgetHeaderFooterProps()
is greater than 0Return 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.
-
setHeaderFooterChanged
void setHeaderFooterChanged(boolean value)
Deprecated.not used anymoreSets 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.- Parameters:
value
-
-
getHeaderFooterSectionName
java.lang.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.
-
setHeaderFooterSectionName
void setHeaderFooterSectionName(java.lang.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.
-
getHeaderLeftText
java.lang.String getHeaderLeftText()
Deprecated.not used anymore. We now usegetHeaderFooterPropValue(String)
- Returns:
- the left section of the header.
-
setHeaderLeftText
void setHeaderLeftText(java.lang.String value)
Deprecated.not used anymore. We now usesetHeaderFooterPropValue(String, String)
Sets the left section of the header.- Parameters:
value
- the left section of the header.
-
getHeaderCenterText
java.lang.String getHeaderCenterText()
Deprecated.not used anymore. We now usegetHeaderFooterPropValue(String)
- Returns:
- the center section of the header.
-
setHeaderCenterText
void setHeaderCenterText(java.lang.String value)
Deprecated.not used anymore. We now usesetHeaderFooterPropValue(String, String)
Sets the center section of the header.- Parameters:
value
- the center section of the header.
-
getHeaderRightText
java.lang.String getHeaderRightText()
Deprecated.not used anymore. We now usegetHeaderFooterPropValue(String)
- Returns:
- the right section of the header.
-
setHeaderRightText
void setHeaderRightText(java.lang.String value)
Deprecated.not used anymore. We now usesetHeaderFooterPropValue(String, String)
Sets the right section of the header.- Parameters:
value
- the right section of the header.
-
getFooterLeftText
java.lang.String getFooterLeftText()
Deprecated.not used anymore. We now usegetHeaderFooterPropValue(String)
- Returns:
- the left section of the footer.
-
setFooterLeftText
void setFooterLeftText(java.lang.String value)
Deprecated.not used anymore. We now usesetHeaderFooterPropValue(String, String)
Sets the left section of the footer.- Parameters:
value
- the left section of the footer.
-
getFooterCenterText
java.lang.String getFooterCenterText()
Deprecated.not used anymore. We now usegetHeaderFooterPropValue(String)
- Returns:
- the center section of the footer.
-
setFooterCenterText
void setFooterCenterText(java.lang.String value)
Deprecated.not used anymore. We now usesetHeaderFooterPropValue(String, String)
Sets the center section of the footer.- Parameters:
value
- the center section of the footer.
-
getFooterRightText
java.lang.String getFooterRightText()
Deprecated.not used anymore. We now usegetHeaderFooterPropValue(String)
- Returns:
- the right section of the footer.
-
setFooterRightText
void setFooterRightText(java.lang.String value)
Deprecated.not used anymore. We now usesetHeaderFooterPropValue(String, String)
Sets the right section of the footer.- Parameters:
value
- the right section of the footer.
-
getShowOptions
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.
-
setShowOptions
void setShowOptions(boolean showOptions)
Sets whether the options page is being displayed.- Parameters:
showOptions
- whether the options page is being displayed.
-
getReportBean
ReportBean getReportBean()
- Returns:
- the report bean.
-
getDirectExportBean
DirectExportBean getDirectExportBean()
- Returns:
- the direct export bean.
- Since:
- MicroStrategy Web 8.0.0
-
getType
int getType()
Returns the type of Bean.- Specified by:
getType
in interfacePreferencesBean
- Specified by:
getType
in interfaceTransformable
- Returns:
- the type of Bean.
-
getDontPromptAgain
java.lang.String getDontPromptAgain()
Returns whether not to show the options page.- Returns:
- a
String
value indicating whether not to show the options page. - Since:
- MicroStrategy Web 8.0.0
-
setDontPromptAgain
void setDontPromptAgain(java.lang.String value)
Sets whether not to show the options page.- Parameters:
value
- aString
value indicating whether not to show the options page.- Since:
- MicroStrategy Web 8.0.0
-
getIsProjectHeaderFooter
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. - Since:
- MicroStrategy Web 8.0.0
-
setIsProjectHeaderFooter
void setIsProjectHeaderFooter(boolean value)
Sets whether the header/footer properties are the project level ones.
Note: Used on the Header/Footer editor.- Parameters:
value
- aboolean
value indicating whether the header/footer properties are the project level ones.- Since:
- MicroStrategy Web 8.0.0
-
getHeaderFooterMacroPrefix
java.lang.String getHeaderFooterMacroPrefix()
- Returns:
- the prefix used for the macros on the header/footer
- Since:
- MicroStrategy Web 9.0.0
-
getHeaderFooterMacroSuffix
java.lang.String getHeaderFooterMacroSuffix()
- Returns:
- the suffix used for the macros on the header/footer
- Since:
- MicroStrategy Web 9.0.0
-
getHeaderFooterPropValue
java.lang.String getHeaderFooterPropValue(java.lang.String name)
- Returns:
- the value of a property
- Since:
- MicroStrategy Web 9.0.0
-
setHeaderFooterPropValue
void setHeaderFooterPropValue(java.lang.String name, java.lang.String value)
Sets a temporary property. These properties are part of the bean state- Since:
- MicroStrategy Web 9.0.0
-
useForHeaderFooter
boolean useForHeaderFooter()
- Returns:
- whether the options bean is used to display a Header/footer Editor which requires special handling.
- Since:
- MicroStrategy Web 9.0.0
-
getHeaderFooterProps
java.util.HashMap<java.lang.String,java.lang.String> getHeaderFooterProps()
- Returns:
- the collection of all the header/footer properties (set through
setHeaderFooterPropValue(String, String)
- Since:
- MicroStrategy Web 9.0.0
-
-