public class

FolderBulletRWTransform

extends FolderBulletTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
           ↳ com.microstrategy.web.app.transforms.AbstractFolderTransform
             ↳ com.microstrategy.web.app.transforms.FolderBulletTransform
               ↳ com.microstrategy.web.app.transforms.FolderBulletRWTransform

Class Overview

This Transform extends FolderBulletTransform by filtering the "blank" document. This document is the one from the "Create Document" folder, which is empty. This document should not be displayed as part of the Related Reports section.

Summary

Constants
String FP_BLANK_DOCUMENT_ID Constant specifying the name of the formal parameter for defining the ID of the blank report.
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.FolderBulletTransform
From class com.microstrategy.web.app.transforms.AbstractFolderTransform
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public FormalParameter blankDocumentId Indicates the object ID of the Blank Document.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.FolderBulletTransform
From class com.microstrategy.web.app.transforms.AbstractFolderTransform
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
FolderBulletRWTransform()
Default no-argument constructor.
Public Methods
WebEvent getEvent(WebObjectInfo object)
Overrides the parent method by checking if the current folder is the Document Templates folder, and the object type is a document, instead of the normal event, we'll use the edit event available with the getEditEvent(WebObjectInfo) method; the result is that objects in the template folder will be edited instead of executed.
void initializeTransform(Transformable data)
Extends the parent method by detecting if the current folder is the Document Templates folder.
boolean isObjectVisible(WebObjectInfo object)
Extends the parent method by testing if the object should be displayed or not, based on the ID provided on the blankDocumentId formal parameter.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.FolderBulletTransform
From class com.microstrategy.web.app.transforms.AbstractFolderTransform
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
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

Constants

public static final String FP_BLANK_DOCUMENT_ID

Constant specifying the name of the formal parameter for defining the ID of the blank report. Value is blankDocumentId.

Constant Value: "blankDocumentId"

Fields

public FormalParameter blankDocumentId

Indicates the object ID of the Blank Document.
The object with this ID will not be shown as part of the folder contents.

Public Constructors

public FolderBulletRWTransform ()

Default no-argument constructor. Initializes formal parameters.

Public Methods

public WebEvent getEvent (WebObjectInfo object)

Overrides the parent method by checking if the current folder is the Document Templates folder, and the object type is a document, instead of the normal event, we'll use the edit event available with the getEditEvent(WebObjectInfo) method; the result is that objects in the template folder will be edited instead of executed.

Parameters
object WebObjectInfo to render.
Returns
  • the WebEvent to use to execute the object, null if the application does not support it.

public void initializeTransform (Transformable data)

Extends the parent method by detecting if the current folder is the Document Templates folder.

Parameters
data Transformable instance with the bean to be transformed.

public boolean isObjectVisible (WebObjectInfo object)

Extends the parent method by testing if the object should be displayed or not, based on the ID provided on the blankDocumentId formal parameter.

Parameters
object WebObjectInfo with the object to check for.
Returns
  • True if the object should be displayed, otherwise returns False