public class

FolderCreateReportTransform

extends FolderRadioButtonTransform
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.FolderRadioButtonTransform
               ↳ com.microstrategy.web.app.transforms.FolderCreateReportTransform

This class is deprecated.
Use FolderCreateReportXHTMLTransform instead.

Class Overview

This class extends the FolderRadioButtonTransform by specializing in showing the new Reports folder content. It has two sections, showing the blank report on top, and on the bottom the rest of the items on the folder.

Summary

Constants
String FP_BLANK_REPORT_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.AbstractFolderTransform
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public String _blankObjectDesc
public String _blankObjectHeaderDesc
public String _blankObjectName
public String _templateHeaderDesc
public FormalParameter blankObjectId Indicates the object ID of the Blank Report.
public FormalParameter displaySection Specifies which sections are to be displayed in the Create Report page (Create Report, Other Reports).
public FormalParameter promptCreateStyle Specifies the name of prompt style to use for transforming selected prompted template in Design Mode.
public FormalParameter promptExecuteStyle Specifies the name of prompt style to use for transforming selected prompted template in View Mode.
public FormalParameter promptStyle Specifies the name of prompt style to use for transforming selected prompted template in Create Repor page.
[Expand]
Inherited Fields
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
FolderCreateReportTransform()
Default no-argument constructor.
Public Methods
boolean hasCreateBlankObjectPrivileges()
void initializeTransform(Transformable data)
Extends initializeTransform() method by searching for the blank report within the content of the folder, as specified on the blankObjectId formal parameter.
boolean isEmptyList(WebDisplayUnits list)
Indicates whether or not given list is empty.
boolean isObjectVisible(WebObjectInfo object)
Extends isObjectVisible() by returning false if the object is the blank report.
void renderBlankObject(MarkupOutput out)
Renders the first part of the transform, that is the part where the user might pick a "blank" report to start working.
void renderList(MarkupOutput out, WebDisplayUnits list)
This method is deprecated. please note that this method will later on be replaced by using renderList(MarkupOutput) directly, having the list of children to be rendered there will come from the getSortedList() method. Please consider then overwriting the code from renderList(MarkupOutput) instead of from this method.
void renderNextButton(MarkupOutput out)
Extends renderNextButton() method by adding a checkbox to indicate if the user wants to run the report in design mode.
void renderObject(MarkupOutput out, WebObjectInfo object)
Renders the WebObjectInfo object requested according to the specifications of this transform.
void renderSubFolder(MarkupOutput out, WebObjectInfo object)
Writes out information for a single subfolder object.
void renderSubFolderDescription(MarkupOutput out, WebObjectInfo object)
Write out folder description for a single object.
void renderSubFolderIconInfo(MarkupOutput out, WebObjectInfo object)
Write out the image information for a single object.
void renderSubFolderNameInfo(MarkupOutput out, WebObjectInfo object)
Write out name information for a single object.
void renderTemplateList(MarkupOutput out, WebDisplayUnits list)
Renders the list of templates in this folder.
void renderTemplateList(MarkupOutput out)
Renders the list of templates in this folder.
void renderTemplateListContent(MarkupOutput out, WebDisplayUnits list)
Renders the folder contents in a radio list button format.
Protected Methods
WebEvent getOpenObjectEvent()
Overwrites the original method for returning the WebEventEditReport event instead.
void renderBlankObjectFormInputInfo(MarkupOutput out, WebEvent createEvent, WebObjectInfo object)
Render any hidden input information that has to be added while displaying the contents for the method that takes care of the blank report (renderBlankObject), according with the WebEvent specified.
void renderDesignModeOption(MarkupOutput out, WebEvent createEvent, boolean checked)
Render a check box giving the option to have the report selected run in design mode.
void renderRadioButtonForObject(MarkupOutput out, WebEvent openEvent, WebObjectInfo object, boolean selected)
Render the radio button for the WebObjectInfo specified, according with the WebEvent specified.
void renderTemplateListInputInfo(MarkupOutput out, WebEvent openEvent)
Render any hidden input information that has to be added while displaying the contents for the method that takes care of the list of templates.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.FolderRadioButtonTransform
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_REPORT_ID

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

Constant Value: "blankObjectId"

Fields

public String _blankObjectDesc

public String _blankObjectHeaderDesc

public String _blankObjectName

public String _templateHeaderDesc

public FormalParameter blankObjectId

Indicates the object ID of the Blank Report.
If found, it will display it inside its own box while rendering the contents of the folder.

public FormalParameter displaySection

Specifies which sections are to be displayed in the Create Report page (Create Report, Other Reports).
This formal parameters will denote a number to be used as a flag for the two sections of this page.

public FormalParameter promptCreateStyle

Specifies the name of prompt style to use for transforming selected prompted template in Design Mode.
This formal parameters will denote a text to be used as the name of the prompt style that tells to display 'Save' button in prompted report or Document.

public FormalParameter promptExecuteStyle

Specifies the name of prompt style to use for transforming selected prompted template in View Mode.
This formal parameters will denote a text to be used as the name of the prompt style that tells to display 'Save' button in prompted report or Document.

public FormalParameter promptStyle

Specifies the name of prompt style to use for transforming selected prompted template in Create Repor page.
This formal parameters will denote a text to be used as the name of the prompt style. This value will be passed as an event argument for EnumPageEvents.WebEventEditReport event which will be set in getOpenObjectEvent method.
that tells to display 'Save' button in prompted report or Document.

Public Constructors

public FolderCreateReportTransform ()

Default no-argument constructor. Initializes formal parameters.

Public Methods

public boolean hasCreateBlankObjectPrivileges ()

Returns
  • boolean

public void initializeTransform (Transformable data)

Extends initializeTransform() method by searching for the blank report within the content of the folder, as specified on the blankObjectId formal parameter.

Parameters
data Transformable instance with the bean to be transformed.

public boolean isEmptyList (WebDisplayUnits list)

Indicates whether or not given list is empty.
Checks that at least there's one instance of a Report or a sub Folder.

Parameters
list collection of units
Returns
  • boolean true if empty list.

public boolean isObjectVisible (WebObjectInfo object)

Extends isObjectVisible() by returning false if the object is the blank report. We don't want to display this object as part of the template list since it has already been rendered by its own.

Parameters
object WebObjectInfo instance to check for.
Returns
  • True if object requested is visible, otherwise returns False

public void renderBlankObject (MarkupOutput out)

Renders the first part of the transform, that is the part where the user might pick a "blank" report to start working.
The contents are inside an HTML TABLE, and each one of the objects to display are divided in a table row, with two cells: one for the radio button and another one for the name and description of the object (if available).

Parameters
out MarkupOutput instance to modify with the transform's output. be rendered by this transform, as contents of the folder being analyzed.

public void renderList (MarkupOutput out, WebDisplayUnits list)

This method is deprecated.
please note that this method will later on be replaced by using renderList(MarkupOutput) directly, having the list of children to be rendered there will come from the getSortedList() method. Please consider then overwriting the code from renderList(MarkupOutput) instead of from this method.

Extends the original method by splitting it in two: renderBlankObject() and renderTemplateList()

Parameters
out MarkupOutput instance to modify with the transform's output.
list WebDisplayUnits instance with the list of objects that will be rendered by this transform, as contents of the folder being analyzed.

public void renderNextButton (MarkupOutput out)

Extends renderNextButton() method by adding a checkbox to indicate if the user wants to run the report in design mode.
The HTML contents generated by this method are inside an HTML TR tag, therefore the main TABLE tag where this row will exist has to be created beforehand. By default, the renderList() method takes care of it.

Parameters
out MarkupOutput instance to modify with the transform's output.

public void renderObject (MarkupOutput out, WebObjectInfo object)

Renders the WebObjectInfo object requested according to the specifications of this transform.
The HTML contents generated by this method are inside a TR tag with two cells (one for the radio button, another for the object name and description), therefore the parent TABLE needs to be opened beforehand. By default, the renderList() method takes care of that.

Parameters
out MarkupOutput instance where to save the contents to display
object WebObjectInfo to be rendered.

public void renderSubFolder (MarkupOutput out, WebObjectInfo object)

Writes out information for a single subfolder object.

Parameters
out MarkupOutput instance where to save the contents to display
object WebObjectInfo to be rendered.

public void renderSubFolderDescription (MarkupOutput out, WebObjectInfo object)

Write out folder description for a single object.

Parameters
out MarkupOutput instance where to save the contents to display
object WebObjectInfo to be rendered.

public void renderSubFolderIconInfo (MarkupOutput out, WebObjectInfo object)

Write out the image information for a single object.

Parameters
out MarkupOutput instance where to save the contents to display
object WebObjectInfo to be rendered.

public void renderSubFolderNameInfo (MarkupOutput out, WebObjectInfo object)

Write out name information for a single object.

Parameters
out MarkupOutput instance where to save the contents to display
object WebObjectInfo to be rendered.

public void renderTemplateList (MarkupOutput out, WebDisplayUnits list)

Renders the list of templates in this folder. Basically just adds a message on the top and calls the parent renderList() method.

Parameters
out MarkupOutput instance to modify with the transform's output.
list WebDisplayUnits instance with the list of objects that will be rendered by this transform, as contents of the folder being analyzed.

public void renderTemplateList (MarkupOutput out)

Renders the list of templates in this folder. Basically just adds a message on the top and calls the parent renderList() method.

Parameters
out MarkupOutput instance to modify with the transform's output. be rendered by this transform, as contents of the folder being analyzed.
Throws
WebBeanException if an error happens while rendering the information
WebObjectsException if an error happens while rendering the information

public void renderTemplateListContent (MarkupOutput out, WebDisplayUnits list)

Renders the folder contents in a radio list button format.

Parameters
out MarkupOutput instance to modify with the transform's output.
list WebDisplayUnits instance with the list of objects that will be rendered by this transform, as contents of the folder being analyzed.

Protected Methods

protected WebEvent getOpenObjectEvent ()

Overwrites the original method for returning the WebEventEditReport event instead.

Returns
  • a WebEvent instance intialized if the application supports it. Otherwise, returns null

protected void renderBlankObjectFormInputInfo (MarkupOutput out, WebEvent createEvent, WebObjectInfo object)

Render any hidden input information that has to be added while displaying the contents for the method that takes care of the blank report (renderBlankObject), according with the WebEvent specified. If the event has been customized, then this method should also be overwritten for the event argument identifiers to be correct.

Parameters
out MarkupOutput where the HTML output will be saved
createEvent WebEvent representing the action to do with the given object
object WebObjectInfo currently being processed

protected void renderDesignModeOption (MarkupOutput out, WebEvent createEvent, boolean checked)

Render a check box giving the option to have the report selected run in design mode. If the event has been customized, then this method should also be overwritten for the event argument identifiers to be correct.

Parameters
out MarkupOutput where the HTML output will be saved
createEvent WebEvent representing the action to do with the given object
checked boolean indicating if the check box to generate should be checked or not.

protected void renderRadioButtonForObject (MarkupOutput out, WebEvent openEvent, WebObjectInfo object, boolean selected)

Render the radio button for the WebObjectInfo specified, according with the WebEvent specified. Since the parent event has been customized, this should be too.

Parameters
out MarkupOutput where the HTML output will be saved
openEvent WebEvent representing the action to do with the given object
object WebObjectInfo currently being processed
selected boolean indicating if the radio button should be selected or not

protected void renderTemplateListInputInfo (MarkupOutput out, WebEvent openEvent)

Render any hidden input information that has to be added while displaying the contents for the method that takes care of the list of templates. If the event has been customized, then this method should also be overwritten for the event argument identifiers to be correct.

Parameters
out MarkupOutput where the HTML output will be saved
openEvent WebEvent representing the action to do with the given object