public class

PreferencesPrintHeaderFooterTransform

extends AbstractHeaderFooterTransform
implements EnumWebPreferences
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.PreferencesPrintHeaderFooterTransform

Class Overview

This is the transform that render the Print Header/Footer editor. Accessed via:

  • "Preferences > Print Reports > Header and Footer"
  • "Print Options page (for reports) > Header and Footer"

Summary

Nested Classes
class PreferencesPrintHeaderFooterTransform.ImageButtonInformation This class provides the fields necessary to generate an image for a macro button. 
[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
From interface com.microstrategy.web.objects.EnumWebPreferences
Fields
protected boolean _hasReportProperties
protected HashList _projectPropertyValues
protected HashList _propertyValues
protected FormalParameter dateImage This field is deprecated. image is not used anymore as we now use a pulldown
protected FormalParameter filterDetailsImage This field is deprecated. image is not used anymore as we now use a pulldown
protected FormalParameter filterNameImage This field is deprecated. image is not used anymore as we now use a pulldown
protected FormalParameter numberOfPagesImage This field is deprecated. image is not used anymore as we now use a pulldown
protected FormalParameter pageByImage This field is deprecated. image is not used anymore as we now use a pulldown
protected FormalParameter pageNumberImage This field is deprecated. image is not used anymore as we now use a pulldown
protected FormalParameter projectNameImage This field is deprecated. image is not used anymore as we now use a pulldown
protected FormalParameter reportNameImage This field is deprecated. image is not used anymore as we now use a pulldown
protected FormalParameter templateNameImage This field is deprecated. image is not used anymore as we now use a pulldown
protected FormalParameter timeImage This field is deprecated. image is not used anymore as we now use a pulldown
protected FormalParameter userNameImage This field is deprecated. image is not used anymore as we now use a pulldown
[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
From interface com.microstrategy.web.objects.EnumWebPreferences
Public Constructors
PreferencesPrintHeaderFooterTransform()
Default empty constructor.
Public Methods
boolean canHavePageByMacro()
Returns true if the macro to add page-by information is available.
void initializeImages()
Initialize the images to be used by this transform.
void initializeTransform(Transformable data)
Initialize the private and protected fields of the transform.
void renderFooterCenter(MarkupOutput out)
Render the center footer portion of the preferences dialog
void renderFooterLeft(MarkupOutput out)
Render the left footer portion of the preferences dialog
void renderFooterRight(MarkupOutput out)
Render the right footer portion of the preferences dialog
void renderHeaderCenter(MarkupOutput out)
Render the center header portion of the preferences dialog
void renderHeaderLeft(MarkupOutput out)
Generate the left header portion of the preferences dialog
void renderHeaderRight(MarkupOutput out)
Render the right header portion of the preferences dialog
void renderMacroButtons(MarkupOutput out)

Renders the list of macros fields available for the headers and footers of a report.

void renderPreference(String preferenceName, MarkupOutput out)
This method is deprecated. Call the corresponding renderXXX method directly.
void transformBody(MarkupOutput out)
Generates the content for the Print header footer Preference's dialog.
Protected Methods
AnchorTag generateAnchor(WebEvent event)
Overwrites the parent method by setting special attributes if the event is not provided
void generateImageAnchor(MarkupOutput out, String name, String imageSource, String tooltip)
Generate an image anchor for the options for the print header/footer preferences, depending if the current environment is HTML or DHTML.
void generateOptions(MarkupOutput out)
Generate the different options the user can add to the header/footer, such as date, page number, etc.
ArrayList getButtonList()
Returns the list of available macros for the headers and footers.
void renderJavascript(MarkupOutput out)
This method is called to generate all javascript functions related to this transform.
[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

Fields

protected boolean _hasReportProperties

protected HashList _projectPropertyValues

protected HashList _propertyValues

protected FormalParameter dateImage

This field is deprecated.
image is not used anymore as we now use a pulldown

Specifies the image on the header/footer editor's toolbar used for adding the date to a header/footer section.
Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

protected FormalParameter filterDetailsImage

This field is deprecated.
image is not used anymore as we now use a pulldown

Specifies the image on the header/footer editor's toolbar used for adding the filter details to a header/footer section.
Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

protected FormalParameter filterNameImage

This field is deprecated.
image is not used anymore as we now use a pulldown

Specifies the image on the header/footer editor's toolbar used for adding the filter name to a header/footer section.
Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

protected FormalParameter numberOfPagesImage

This field is deprecated.
image is not used anymore as we now use a pulldown

Specifies the image on the header/footer editor's toolbar used for adding the number of pages to a header/footer section.
Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

protected FormalParameter pageByImage

This field is deprecated.
image is not used anymore as we now use a pulldown

Specifies the image on the header/footer editor's toolbar used for adding the page-by information to a header/footer section.
Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

protected FormalParameter pageNumberImage

This field is deprecated.
image is not used anymore as we now use a pulldown

Specifies the image on the header/footer editor's toolbar used for adding the page number to a header/footer section.
Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

protected FormalParameter projectNameImage

This field is deprecated.
image is not used anymore as we now use a pulldown

Specifies the image on the header/footer editor's toolbar used for adding the project name to a header/footer section.
Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

protected FormalParameter reportNameImage

This field is deprecated.
image is not used anymore as we now use a pulldown

Specifies the image on the header/footer editor's toolbar used for adding the report name to a header/footer section.
Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

protected FormalParameter templateNameImage

This field is deprecated.
image is not used anymore as we now use a pulldown

Specifies the image on the header/footer editor's toolbar used for adding the template name to a header/footer section.
Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

protected FormalParameter timeImage

This field is deprecated.
image is not used anymore as we now use a pulldown

Specifies the image on the header/footer editor's toolbar used for adding the time to a header/footer section.
Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

protected FormalParameter userNameImage

This field is deprecated.
image is not used anymore as we now use a pulldown

Specifies the image on the header/footer editor's toolbar used for adding the user name to a header/footer section.
Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

Public Constructors

public PreferencesPrintHeaderFooterTransform ()

Default empty constructor.
Initialize formal parameters.

Public Methods

public boolean canHavePageByMacro ()

Returns true if the macro to add page-by information is available.

public void initializeImages ()

Initialize the images to be used by this transform.

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

Render the center footer portion of the preferences dialog

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

public void renderFooterLeft (MarkupOutput out)

Render the left footer portion of the preferences dialog

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

public void renderFooterRight (MarkupOutput out)

Render the right footer portion of the preferences dialog

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

public void renderHeaderCenter (MarkupOutput out)

Render the center header portion of the preferences dialog

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

public void renderHeaderLeft (MarkupOutput out)

Generate the left header portion of the preferences dialog

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

public void renderHeaderRight (MarkupOutput out)

Render the right header portion of the preferences dialog

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

public void renderMacroButtons (MarkupOutput out)

Renders the list of macros fields available for the headers and footers of a report. Each macro is rendered as a button, when the button is clicked, the macro's text is appended to the currently selected field.

The list of available macros is obtained from the getButtonList() method.

public void renderPreference (String preferenceName, MarkupOutput out)

This method is deprecated.
Call the corresponding renderXXX method directly.

Render individual preferences based on the name provided

Parameters
preferenceName name id of the preference
out MarkupOutput instance where the HTML output will be saved

public void transformBody (MarkupOutput out)

Generates the content for the Print header footer Preference's dialog.

Parameters
out the body content

Protected Methods

protected AnchorTag generateAnchor (WebEvent event)

Overwrites the parent method by setting special attributes if the event is not provided

Parameters
event WebEvent instance from where the anchor will be constructed
Returns
  • AnchorTag initialized instance with the information as provided

protected void generateImageAnchor (MarkupOutput out, String name, String imageSource, String tooltip)

Generate an image anchor for the options for the print header/footer preferences, depending if the current environment is HTML or DHTML.

Parameters
out MarkupOutput instance where the HTML content generated will be saved.
name String name of the image to render
imageSource String location of the image to display
tooltip String with tooltip information about the button to render

protected void generateOptions (MarkupOutput out)

Generate the different options the user can add to the header/footer, such as date, page number, etc.

Parameters
out MarkupOutput instance where the HTML content will be saved.

protected ArrayList getButtonList ()

Returns the list of available macros for the headers and footers. Each member of the returned ArrayList is an instance of an PreferencesPrintHeaderFooterTransform.ImageButtonInformation class.

protected void renderJavascript (MarkupOutput out)

This method is called to generate all javascript functions related to this transform.