public interface

OptionsBean

implements PreferencesBean
com.microstrategy.web.app.beans.OptionsBean
Known Indirect Subclasses

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

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

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.