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
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
From class com.microstrategy.web.beans.AbstractWebComponent
From class com.microstrategy.web.beans.AbstractTransformable
From class com.microstrategy.utils.serialization.AbstractPersistable
From class java.lang.Object
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.app.beans.AppComponent
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

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

protected WebEventHandler newDefaultEventHandler ()