public class

ReportPageByTransform

extends AbstractReportGridTransform
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.AbstractReportDataTransform
               ↳ com.microstrategy.web.app.transforms.AbstractReportGridTransform
                 ↳ com.microstrategy.web.app.transforms.ReportPageByTransform

This class is deprecated.
Use PageByTransform instead.

Class Overview

Description: Provides report bean a pageby transform.
This Transform is not longer in use by Microstrategy Web and it's usage has been deprecated. Users are encouraged to use the PageByBean and its associated Transforms.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractReportDataTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected FormalParameter automaticPageBy This is the flag used in the transform to specify whether the dropdown lists will submit form immediately when user changes it.
protected FormalParameter imgApply This is the image name for apply image used in the transform.
protected FormalParameter showPageByDetails This is the flag used in the transform to specify whether to show or hide the page by details section.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractReportGridTransform
From class com.microstrategy.web.app.transforms.AbstractReportDataTransform
From class com.microstrategy.web.app.transforms.AbstractReportTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
ReportPageByTransform()
default no-args constructor
Public Methods
String getDescription()
Return description for this Transform
boolean hasBottom()
This method is deprecated. This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.
boolean hasCenter()
This method is deprecated. This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.
boolean hasLeft()
This method is deprecated. This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.
boolean hasRight()
This method is deprecated. This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.
boolean hasTop()
This method is deprecated. This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.
void initializeCss()
initialize the css information for the transform
void initializeProperties()
initialize some properties for the transform
void renderCenter(MarkupOutput out, ReportBean rb)
void renderData(MarkupOutput out, ReportBean rb)
void renderEmptyCase(MarkupOutput out, ReportBean rb)
void renderLayout(MarkupOutput out, ReportBean rb)
void transformForRequestSuccessful(MarkupOutput mo)
Transform when the status is "Successful".
Protected Methods
ContextMenuManager getContextMenuManager()
get the ContextMenuManager object.
boolean isDesignMode()
This methods allows the transform to identify if concrete subclasses are designed to work in design mode, or in execute mode.
boolean isOpen()
Defines whether this Transform is currently visible to the end user.
boolean isPageByEmpty(ReportBean rb)
return whether the report doesn't have any page by attribute
boolean showPageByDetails()
whether display page by details from formal parameter "showPageByDetails".
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractReportGridTransform
From class com.microstrategy.web.app.transforms.AbstractReportDataTransform
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.app.transforms.ReportDataTransform
From interface com.microstrategy.web.transform.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Fields

protected FormalParameter automaticPageBy

This is the flag used in the transform to specify whether the dropdown lists will submit form immediately when user changes it.
Allowed Values: TRUE/FALSE.

protected FormalParameter imgApply

This is the image name for apply 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 showPageByDetails

This is the flag used in the transform to specify whether to show or hide the page by details section.
The details section contains the dropdown boxeds where user can change pageby elements.
In the application out-of-box, we map the browser setting value for EnumWebBrowserSettings.WebBrowserSettingPageBySection to this formal parameter.
Allowed Values: TRUE/FALSE.

Public Constructors

public ReportPageByTransform ()

default no-args constructor

Public Methods

public String getDescription ()

Return description for this Transform

Returns
  • description for this Transform

public boolean hasBottom ()

This method is deprecated.
This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.

Whether the transform has the bottom area. Out of box, if the formal parameter indicates that we need to display incremental fetch links for row on the bottom of the data, it returns true, or else, it returns false.

Returns
  • Whether the transform has the bottom area

public boolean hasCenter ()

This method is deprecated.
This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.

Whether the transform has the center area. Out of box, it returns true.

Returns
  • Whether the transform has the center area

public boolean hasLeft ()

This method is deprecated.
This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.

Whether the transform has the left area. Out of box, if the formal parameter indicates that we need to display incremental fetch links for column and there are data to the left of the current data, it returns true, or else, it returns false.

Returns
  • Whether the transform has the right area

public boolean hasRight ()

This method is deprecated.
This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.

Whether the transform has the right area. Out of box, if the formal parameter indicates that we need to display incremental fetch links for column and there are data to the right of the current data, it returns true, or else, it returns false.

Returns
  • Whether the transform has the right area

public boolean hasTop ()

This method is deprecated.
This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.

Whether the transform has the top area. Out of box, if the formal parameter indicates that we need to display incremental fetch links for row on the top of the data, it returns true, or else, it returns false.

Returns
  • Whether the transform has the top area

public void initializeCss ()

initialize the css information for the transform

public void initializeProperties ()

initialize some properties for the transform

public void renderCenter (MarkupOutput out, ReportBean rb)

public void renderData (MarkupOutput out, ReportBean rb)

public void renderEmptyCase (MarkupOutput out, ReportBean rb)

public void renderLayout (MarkupOutput out, ReportBean rb)

public void transformForRequestSuccessful (MarkupOutput mo)

Transform when the status is "Successful".

Parameters
mo output by this transform

Protected Methods

protected ContextMenuManager getContextMenuManager ()

get the ContextMenuManager object.

Returns

protected boolean isDesignMode ()

This methods allows the transform to identify if concrete subclasses are designed to work in design mode, or in execute mode.

Returns
  • false by default. Any inherting class should override to implement its own version.

protected boolean isOpen ()

Defines whether this Transform is currently visible to the end user.

Returns
  • true if the bean is visible

protected boolean isPageByEmpty (ReportBean rb)

return whether the report doesn't have any page by attribute

Parameters
rb the ReportBean object
Returns
  • whether the report doesn't have any page by attribute

protected boolean showPageByDetails ()

whether display page by details from formal parameter "showPageByDetails".

Returns
  • whether display page by details