public class

ReportToolbarTransform

extends AbstractReportTransform
implements LayoutTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractWebBeanTransform
           ↳ com.microstrategy.web.app.transforms.AbstractReportTransform
             ↳ com.microstrategy.web.app.transforms.ReportToolbarTransform

Class Overview

This Transform generates the content of the report toolbar area. This Transform implements LayoutTransform, therefore it can be customized simply by changing its layout-xml.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected FormalParameter graphIncrementalFetchStyleForRow This is the name of the style used to show the incremental fetch for row for grid graph reports.
protected FormalParameter gridAutoStyleBean This is the name of the grid autostyles bean.
protected FormalParameter gridGraphIncrementalFetchStyleForRow This is the name of the style used to show the incremental fetch for row for grid graph reports.
protected FormalParameter gridIncrementalFetchStyleForRow This is the name of the style used to show the incremental fetch for row for grid reports.
protected FormalParameter imgCheckOff This is the image name for check off image used in the transform.
protected FormalParameter imgCheckOn This is the image name for check on image used in the transform.
protected FormalParameter imgClose This is the image name for close image used in the transform.
protected FormalParameter imgGo This is the image name for go image used in the transform.
protected FormalParameter outlineModeDefaultLevelMax If this value is set to true the default level at which any newly run report wil open for outline mode will be maximum expanded.
protected FormalParameter showOutlineLevelButtons It is used in the transform to specify whether to show the outline mode level buttons.
protected FormalParameter showStyleList This is the flag used in the transform to specify whether to display auto styles list.
protected FormalParameter uniqueReportId This is the name of the report's associated bone.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractReportTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
ReportToolbarTransform()
default no-args constructor
Public Methods
String getDescription()
Return description for this Transform
String getID()
Returns the unique name of the component to be used as the ID for its shell.
void initializeCss()
initialize css information for the transform
void initializeImages()
initialize image information for the transform
boolean isColumnCountAvailable()
boolean isGraphAvailable()
Checks if the graph can be displayed with the available data.
boolean isOutlineModeAvailable()
boolean isPivotButtonsAvailable()
boolean isReportStylesAvailable()
boolean isRowCountAvailable()
boolean isRowIncrementalFetchAvailable()
boolean isSortButtonsAvailable()
void renderColumnCount(MarkupOutput out)
Generates a message with the reports column count.
void renderOutlineModeLevels(MarkupOutput out)
Generates the buttons that changes the current outline mode level.
void renderReportStyles(MarkupOutput out)
Generates the content for the report autostyles selection.
void renderRowCount(MarkupOutput out)
Generates a message with the reports row count.
void renderRowIncrementalFetch(MarkupOutput mo)
void renderShowPivotButtons(MarkupOutput out)
Generates a link that will toggle the pivot buttons on/off
void renderShowSortButtons(MarkupOutput out)
Generates a link that toggles the sort buttons on/off
void transformForRequestSuccessful(MarkupOutput out)
Transform when the status is "Successful".
Protected Methods
WebEvent getTogglePivotButtonsEvent()
WebEvent getToggleSortButtonsEvent()
boolean isShowingPivotButtons()
boolean isShowingSortButtons()
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractReportTransform
From class com.microstrategy.web.app.transforms.AbstractWebBeanTransform
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 FormalParameter graphIncrementalFetchStyleForRow

This is the name of the style used to show the incremental fetch for row for grid graph reports.
Allowed Values: any report style name from StyelCatalog.xml file.

protected FormalParameter gridAutoStyleBean

This is the name of the grid autostyles bean.
Allowed Values: String values.

protected FormalParameter gridGraphIncrementalFetchStyleForRow

This is the name of the style used to show the incremental fetch for row for grid graph reports.
Allowed Values: any report style name from StyelCatalog.xml file.

protected FormalParameter gridIncrementalFetchStyleForRow

This is the name of the style used to show the incremental fetch for row for grid reports.
Allowed Values: any report style name from StyelCatalog.xml file.

protected FormalParameter imgCheckOff

This is the image name for check off image used in the transform.
Allowed values: a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

protected FormalParameter imgCheckOn

This is the image name for check on image used in the transform.
Allowed values: a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

protected FormalParameter imgClose

This is the image name for close image used in the transform.
Allowed values: a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

protected FormalParameter imgGo

This is the image name for go image used in the transform.
Allowed values: a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

protected FormalParameter outlineModeDefaultLevelMax

If this value is set to true the default level at which any newly run report wil open for outline mode will be maximum expanded.
If it is false, the default will be fully collapsed.
This property will be used only if the report property denoting the outline mode level is not present.
Allowed Values: String values.

protected FormalParameter showOutlineLevelButtons

It is used in the transform to specify whether to show the outline mode level buttons.
Allowed Values: TRUE/FALSE.

protected FormalParameter showStyleList

This is the flag used in the transform to specify whether to display auto styles list.
Allowed Values: TRUE/FALSE.

protected FormalParameter uniqueReportId

This is the name of the report's associated bone.
Allowed Values: String values.

Public Constructors

public ReportToolbarTransform ()

default no-args constructor

Public Methods

public String getDescription ()

Return description for this Transform

Returns
  • description for this Transform

public String getID ()

Returns the unique name of the component to be used as the ID for its shell. This id is used for updating the page using the iFrame technology, and as the id for the corresponding bone (if any).

Returns
  • the component's unique id

public void initializeCss ()

initialize css information for the transform

public void initializeImages ()

initialize image information for the transform

public boolean isColumnCountAvailable ()

Returns
  • boolean true if the column count is available for the report

public boolean isGraphAvailable ()

Checks if the graph can be displayed with the available data.

public boolean isOutlineModeAvailable ()

Returns
  • boolean true if the outline mode is available (i.e. enabled and not in graph mode).

public boolean isPivotButtonsAvailable ()

Returns
  • boolean true if the pivot buttons are available.

public boolean isReportStylesAvailable ()

public boolean isRowCountAvailable ()

Returns
  • boolean true if the row count is available for the report

public boolean isRowIncrementalFetchAvailable ()

Returns
  • boolean true, if row incremental fetch information is available

public boolean isSortButtonsAvailable ()

Returns
  • boolean true if the sort buttons are available.

public void renderColumnCount (MarkupOutput out)

Generates a message with the reports column count.

Parameters
out the MarkupOutput where the content is generated.

public void renderOutlineModeLevels (MarkupOutput out)

Generates the buttons that changes the current outline mode level.

Parameters
out the MarkupOutput object

public void renderReportStyles (MarkupOutput out)

Generates the content for the report autostyles selection. Basically it simply it searches for the autostyle bean (as defined by the gridAutoStyleBean formal parameter) and if found, just calls transform() on it.

Parameters
out the MarkupOutput where the content is generated.

public void renderRowCount (MarkupOutput out)

Generates a message with the reports row count.

Parameters
out the MarkupOutput where the content is generated.

public void renderRowIncrementalFetch (MarkupOutput mo)

public void renderShowPivotButtons (MarkupOutput out)

Generates a link that will toggle the pivot buttons on/off

Parameters
out the MarkupOutput where the content is generated.

public void renderShowSortButtons (MarkupOutput out)

Generates a link that toggles the sort buttons on/off

Parameters
out the MarkupOutput where the content is generated.

public void transformForRequestSuccessful (MarkupOutput out)

Transform when the status is "Successful".

Parameters
out output by this transform

Protected Methods

protected WebEvent getTogglePivotButtonsEvent ()

Returns
  • the WebEvent used to toggle the pivot buttons on/off

protected WebEvent getToggleSortButtonsEvent ()

Returns
  • the WebEvent used to toggle the sort buttons on/off

protected boolean isShowingPivotButtons ()

Returns
  • boolean true if pivot buttons are currently on

protected boolean isShowingSortButtons ()

Returns
  • boolean true if sort buttons are currently on