public abstract class

AbstractHeaderFooterTransform

extends AbstractOptionsTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractPreferencesTransform
           ↳ com.microstrategy.web.app.transforms.PreferencesGenericTransform
             ↳ com.microstrategy.web.app.transforms.AbstractOptionsTransform
               ↳ com.microstrategy.web.app.transforms.AbstractHeaderFooterTransform
Known Direct Subclasses

Class Overview

Abstract class for all transforms that display a header/footer editor on preferences or Options pages.
Used for Exporting, Printing and PDF

Summary

Constants
String EXCEL_FOOTER_PANEL Identifier for the Excel footer panel
String EXCEL_HEADER_PANEL Identifier for the Excel header panel
String FOOTER_CENTER_PANEL Identifier for the center footer panel
String FOOTER_LEFT_PANEL Identifier for the left footer panel
String FOOTER_RIGHT_PANEL Identifier for the right footer panel
String HEADER_CENTER_PANEL Identifier for the center header panel
String HEADER_LEFT_PANEL Identifier for the left header panel
String HEADER_RIGHT_PANEL Identifier for the right header panel
String PDF_REPORT_HEADER_PANEL Identifier for the pdf report header panel
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractOptionsTransform
From class com.microstrategy.web.app.transforms.PreferencesGenericTransform
From class com.microstrategy.web.app.transforms.AbstractPreferencesTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected FormalParameter prevGroupName Specifies the name of the previous group preferences.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractOptionsTransform
From class com.microstrategy.web.app.transforms.AbstractPreferencesTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
AbstractHeaderFooterTransform()
Default empty constructor.
Public Methods
boolean canHaveFilterDetailsMacro()
Returns true if the macro to add filter-details is available.
WebEvent getApplyEvent()
Returns the event used to apply the editor's changes
WebEvent getCancelEvent()
WebEvent getPopulateTextEvent()
Returns the event used to populate the editor with the preferences values
WebEvent getSelectGroupEvent()
This is the event used to return to the preferences page after editing headers and footers.
String getTitle()
void initializeTransform(Transformable data)
Initialize the private and protected fields of the transform.
void renderApplyChanges(MarkupOutput out)
Renders the "Apply" changes section.
void renderApplyChangesButton(MarkupOutput out)
This method generates the "Apply" button to save current changes.
void renderCancelButton(MarkupOutput out)
This method generates the "Cancel" button to go back to the previous dialog discarding changes.
void renderFormEnd(MarkupOutput out, WebEvent event)
Renders the Form end tag
void renderMacroPulldown(MarkupOutput out)
Renders a pulldown (select box) with the list of macros supported on the editor
Protected Methods
boolean checkPropertiesPresent(String propSetName)
String getHeaderFooterPropertyValue(String prefName, String propSetName, String propName)
List getMacros()
void renderHeaderFooterTextArea(MarkupOutput out, String prefName, String value, boolean defaultSelection)
void renderHeaderFooterTextArea(MarkupOutput out, String prefName, String value)
void renderSelectGroupHiddenInputs(MarkupOutput out)
This method generates hidden inputs for the select group event, used to go back to the preferences page.
void transformFooter(MarkupOutput out)
Generates the footer of the Preferences dialog
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractOptionsTransform
From class com.microstrategy.web.app.transforms.PreferencesGenericTransform
From class com.microstrategy.web.app.transforms.AbstractPreferencesTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.transform.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Constants

public static final String EXCEL_FOOTER_PANEL

Identifier for the Excel footer panel

Constant Value: "8"

public static final String EXCEL_HEADER_PANEL

Identifier for the Excel header panel

Constant Value: "7"

public static final String FOOTER_CENTER_PANEL

Identifier for the center footer panel

Constant Value: "5"

public static final String FOOTER_LEFT_PANEL

Identifier for the left footer panel

Constant Value: "4"

public static final String FOOTER_RIGHT_PANEL

Identifier for the right footer panel

Constant Value: "6"

public static final String HEADER_CENTER_PANEL

Identifier for the center header panel

Constant Value: "2"

public static final String HEADER_LEFT_PANEL

Identifier for the left header panel

Constant Value: "1"

public static final String HEADER_RIGHT_PANEL

Identifier for the right header panel

Constant Value: "3"

public static final String PDF_REPORT_HEADER_PANEL

Identifier for the pdf report header panel

Constant Value: "9"

Fields

protected FormalParameter prevGroupName

Specifies the name of the previous group preferences. We will go to this group if the button \"Cancel\" is clicked on the form.
Allowed Values:
The available preferences groups are specified in the preferencesGroups file.

Public Constructors

public AbstractHeaderFooterTransform ()

Default empty constructor.
Initialize formal parameters.

Public Methods

public boolean canHaveFilterDetailsMacro ()

Returns true if the macro to add filter-details is available.

public WebEvent getApplyEvent ()

Returns the event used to apply the editor's changes

Returns
  • a WebEvent used to apply the editor's changes

public WebEvent getCancelEvent ()

Returns
  • WebEvent instance initialized with the information for cancelling a request

public WebEvent getPopulateTextEvent ()

Returns the event used to populate the editor with the preferences values

Returns
  • a WebEvent used to populate the editor's values.

public WebEvent getSelectGroupEvent ()

This is the event used to return to the preferences page after editing headers and footers.

public String getTitle ()

Returns
  • String value representing the title of this preferences dialog

public void initializeTransform (Transformable data)

Initialize the private and protected fields of the transform.

Parameters
data Transformable instance representing the information being transformed

public void renderApplyChanges (MarkupOutput out)

Renders the "Apply" changes section.
If used for preferences it calls renderApplyChangesCombobox(MarkupOutput)

public void renderApplyChangesButton (MarkupOutput out)

This method generates the "Apply" button to save current changes.

public void renderCancelButton (MarkupOutput out)

This method generates the "Cancel" button to go back to the previous dialog discarding changes.

Parameters
out output for this transform

public void renderFormEnd (MarkupOutput out, WebEvent event)

Renders the Form end tag

Parameters
out where to write the output of the method.

public void renderMacroPulldown (MarkupOutput out)

Renders a pulldown (select box) with the list of macros supported on the editor

Parameters
out the markup output where to render the pulldown

Protected Methods

protected boolean checkPropertiesPresent (String propSetName)

protected String getHeaderFooterPropertyValue (String prefName, String propSetName, String propName)

protected List getMacros ()

protected void renderHeaderFooterTextArea (MarkupOutput out, String prefName, String value, boolean defaultSelection)

protected void renderHeaderFooterTextArea (MarkupOutput out, String prefName, String value)

protected void renderSelectGroupHiddenInputs (MarkupOutput out)

This method generates hidden inputs for the select group event, used to go back to the preferences page.

protected void transformFooter (MarkupOutput out)

Generates the footer of the Preferences dialog

Parameters
out where to create the output