public class

PreferencesExportAdminHeaderFooterTransform

extends AbstractHeaderFooterTransform
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
                 ↳ com.microstrategy.web.app.transforms.PreferencesExportAdminHeaderFooterTransform

Class Overview

Transform to render the Project Header/Footer Editor for Exporting.
Accessed via:

  • "Preferences > Project Defaults > Export Reports > Project Header and Footer"

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractHeaderFooterTransform
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
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractHeaderFooterTransform
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
PreferencesExportAdminHeaderFooterTransform()
Public Methods
WebEvent getApplyEvent()
Returns the event used to apply the editor's changes
String getTitle()
void initializeTransform(Transformable data)
Initialize the private and protected fields of the transform.
void renderAdminExportFooter(MarkupOutput out)
Generate the footer section for export
void renderAdminExportHeader(MarkupOutput out)
Generate the header section for export
Protected Methods
boolean checkPropertiesPresent(String propSetName)
String getHeaderFooterPropertyValue(String propName)
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractHeaderFooterTransform
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

Public Constructors

public PreferencesExportAdminHeaderFooterTransform ()

Public Methods

public WebEvent getApplyEvent ()

Returns the event used to apply the editor's changes

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

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 renderAdminExportFooter (MarkupOutput out)

Generate the footer section for export

Parameters
out MarkupOutput instance where the HTML output generated will be saved

public void renderAdminExportHeader (MarkupOutput out)

Generate the header section for export

Parameters
out MarkupOutput instance where the HTML output generated will be saved

Protected Methods

protected boolean checkPropertiesPresent (String propSetName)

protected String getHeaderFooterPropertyValue (String propName)