public class

ReportPageByInfoTransform

extends AbstractReportTransform
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.ReportPageByInfoTransform

Class Overview

Title: MSTR Web Transform Component: ReportPageByInfoTransform
Description: Provides report bean a pageby transform. Used in ReportTransformPageBy and exporting feature.
Copyright: Copyright (c) 2001
Company: MicroStrategy

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected FormalParameter displayInSingleLine It is used in the transform to specify whether display all the pageby elements in one line or seperate lines.
protected FormalParameter displayWhenNone It is used in the transform to specify whether display when there is no pageby elements.
protected FormalParameter infoTitle It is used in the transform to specify the title for this section.
protected FormalParameter isPlainText It is used in the transform to specify whether display in plain text or html.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractReportTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
ReportPageByInfoTransform()
default no-args constructor
Public Methods
String getDescription()
Return description for this Transform
void initializeCss()
initialize the css information for the transform
void renderShell(MarkupOutput out)

Generates the shell for this Transform.

void transformForRequestSuccessful(MarkupOutput mo)
Transform when the status is "Successful".
Protected Methods
boolean displayInSingleLine()
whether display all the page by information in one line.
boolean displayWhenNone()
whether display some description (like "none") when there is no pageby attribute.
boolean isPlainText()
whether display the information in plaintext, instead of HTML way.
[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.Transform

Fields

protected FormalParameter displayInSingleLine

It is used in the transform to specify whether display all the pageby elements in one line or seperate lines.
Allowed Values: TRUE/FALSE.

protected FormalParameter displayWhenNone

It is used in the transform to specify whether display when there is no pageby elements.
Allowed Values: TRUE/FALSE.

protected FormalParameter infoTitle

It is used in the transform to specify the title for this section.
Allowed Values: any String

protected FormalParameter isPlainText

It is used in the transform to specify whether display in plain text or html.
Allowed Values: TRUE/FALSE.

Public Constructors

public ReportPageByInfoTransform ()

default no-args constructor

Public Methods

public String getDescription ()

Return description for this Transform

Returns
  • description for this Transform

public void initializeCss ()

initialize the css information for the transform

public void renderShell (MarkupOutput out)

Generates the shell for this Transform.

The shell is a <div> tag that automatically surrounds the content generated by the Transform. It's used among other things by the javascript to identify the HTML associated with a bone, and by the iFrame update technology to identify a component in the page.

The attributes to append to this <div> are obtained from the getAttributesShellDiv method; the style from the getStyleShellDiv method.
This method calls renderCssLink and checkStatus to generate the Transform's content.

Parameters
out output by this transform

public void transformForRequestSuccessful (MarkupOutput mo)

Transform when the status is "Successful".

Parameters
mo output by this transform

Protected Methods

protected boolean displayInSingleLine ()

whether display all the page by information in one line.
If it returns false, each attribute will be displayed on seperate line.

Returns
  • whether display all the page by information in one line

protected boolean displayWhenNone ()

whether display some description (like "none") when there is no pageby attribute.

Returns
  • display some description (like "none") when there is no pageby attribute

protected boolean isPlainText ()

whether display the information in plaintext, instead of HTML way.

Returns
  • whether display the information in plaintext