public class

InboxListTransform

extends AbstractAppTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.InboxListTransform

This class is deprecated.
Use InboxListXHTMLTransform instead.

Class Overview

Title: InboxListTransform.

Description: This implements a simple Inbox Transform. It shows all the elements from the history list of the current user.

Summary

Constants
int LEVEL_ALL
int LEVEL_DETAILS
int LEVEL_EXPORT_EXCEL
int LEVEL_EXPORT_PDF
int LEVEL_ICON
int LEVEL_NAME
int LEVEL_REMOVE
int LEVEL_SORT_ICONS
int LEVEL_STATUS
int LEVEL_STATUS_WITHOUT_UNREAD
int LEVEL_TIME
int LEVEL_WITHOUT_FOOTER
int LEVEL_WITHOUT_HEADER
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public FormalParameter allowDocumentExecutionOnDetails Specifies whether the user will be able to execute documents from the document details page.
public FormalParameter allowReportExecutionOnDetails Specifies whether the user will be able to execute reports from the report details page.
protected String cssChildMessage
protected String cssChildReadMessage
protected String cssHeader
protected String cssHighlight
protected String cssMessage
protected String cssReadMessage
protected String cssSeparator
protected String cssStatus
public FormalParameter deleteTarget Specifies the delete target page.
public FormalParameter imgActiveSortAscending Specifies the image file name used by the transform to display the active sort ascending icon.
public FormalParameter imgActiveSortDescending Specifies the image file name used by the transform to display the active sort descending icon.
public FormalParameter imgChild Specifies the image file name used by the transform to display the document's children reports.
public FormalParameter imgCollapse Specifies the image file name used by the transform to display a collapsable object.
public FormalParameter imgDatamart Specifies the image file name used by the transform to display the datamart report icon.
public FormalParameter imgDatamartError Specifies the image file name used by the transform to represent errors in a datamart object.
public FormalParameter imgDatamartScheduled Specifies the image file name used by the transform to represent scheduled datamart objects.
public FormalParameter imgDatamartWait Specifies the image file name used by the transform to display the running datamart icon.
public FormalParameter imgDocument Specifies the image file name used by the transform to display the document icon.
public FormalParameter imgDocumentError Specifies the image file name used by the transform to represent errors in a document object.
public FormalParameter imgDocumentScheduled Specifies the image file name used by the transform to represent scheduled document objects.
public FormalParameter imgDocumentWait Specifies the image file name used by the transform to display the ruuning document icon.
public FormalParameter imgExpand Specifies the image file name used by the transform to display an expandable object.
public FormalParameter imgGraph Specifies the image file name used by the transform to display the graph icon.
public FormalParameter imgGraphError Specifies the image file name used by the transform to represent errors in a graph report.
public FormalParameter imgGraphScheduled Specifies the image file name used by the transform to represent scheduled graph reports.
public FormalParameter imgGraphSnapshot Specifies the image file name used by the transform to display the snapshot graph icon.
public FormalParameter imgGraphWait Specifies the image file name used by the transform to display the running graph icon.
public FormalParameter imgGridGraph Specifies the image file name used by the transform to display the grid-graph icon.
public FormalParameter imgInfo Specifies the image file name used by the transform to display the info icon.
public FormalParameter imgRWDocument Specifies the image file name used by the transform to display the report writing document icon.
public FormalParameter imgRWDocumentError Specifies the image file name used by the transform to represent errors in a report writing document object.
public FormalParameter imgRWDocumentScheduled Specifies the image file name used by the transform to represent scheduled report writing document objects.
public FormalParameter imgRWDocumentWait Specifies the image file name used by the transform to display the running report writing document icon.
public FormalParameter imgReport Specifies the image file name used by the transform to display the grid icon.
public FormalParameter imgReportError Specifies the image file name used by the transform to represent errors in a grid report.
public FormalParameter imgReportScheduled Specifies the image file name used by the transform to represent scheduled grid reports.
public FormalParameter imgReportSnapshot Specifies the image file name used by the transform to display the snapshot grid icon.
public FormalParameter imgReportWait Specifies the image file name used by the transform to display the running grid icon.
public FormalParameter imgSelect Specifies the image file name used by the transform to display options like export or PDF.
public FormalParameter imgSortAscending Specifies the image file name used by the transform to display the sort ascending icon.
public FormalParameter imgSortDescending Specifies the image file name used by the transform to display the sort descending icon.
public FormalParameter levelFlag Specifies what information is displayed for each item in the inbox.
protected int levelFlagCache
public FormalParameter maxItemCount Specifies the maximum number of objects to be displayed in the history list.
public FormalParameter showDeleteForm Specifies whether the transform will show the delete form.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
InboxListTransform()
Default constructor.
Public Methods
String getDescription()
Returns the descriptor to use in the Style Catalog.
Class getSupportedBeanType()
Returns the supported bean type.
void initializeCss()
Initializes the Css Class Strings.
void initializeImages()
Initialize the images to be used by this transform.
void initializeTransform(Transformable data)

This method initialize the private and protected fields of the transform, such as width and height.

void renderDetailsInfo(MarkupOutput out, WebMessage message)
Render an icon with a link for job details
void renderDocumentIconInfo(MarkupOutput out, WebDocumentMessage message)
Render a document's icon
void renderDocumentMessage(MarkupOutput out, WebDocumentMessage message)
Renders a document message and if expanded, all the submessages, that is, the messages of its children.
void renderEmtpyInbox(MarkupOutput out)
Invoked when there are no messages in the History List to display a "hisotyr list is empty" message
void renderExecutionTimeHeader(MarkupOutput out, String header, boolean centered, WebEvent sortEvent)
Writes a last execution time header:
void renderExportInfo(MarkupOutput out, WebMessage message)
Render an icon for exporting the report
void renderHeader(MarkupOutput out, String header, boolean centered)
Writes a single header:
void renderHighlighted(MarkupOutput out, String message)
renders a highlighted (bold) message:
void renderImage(MarkupOutput out, String image, WebMessage message)
Renders a transform's image
void renderImage(MarkupOutput out, String image, WebMessage message, String title)
void renderInboxFooter(MarkupOutput out)
Renders a status bar message for the history list table
void renderInboxHeaders(MarkupOutput out)
Writers the header of the history list
void renderMessages(MarkupOutput out)
Renders the available user messages
void renderNameHeader(MarkupOutput out, String header, boolean centered, WebEvent sortEvent)
Writes a name header:
void renderNameInfo(MarkupOutput out, WebMessage message)
Render the name (title) of the message
void renderPDFExportInfo(MarkupOutput out, WebMessage message)
Render an icon for exporting to PDF the report
void renderRWIconInfo(MarkupOutput out, RWMessage message)
Render a document's icon
void renderRWMessage(MarkupOutput out, RWMessage message)
Renders a document message and if expanded, all the submessages, that is, the messages of its children.
void renderRemoveInfo(MarkupOutput out, WebMessage message)
Renders a checkbox so the user can remove the message
void renderReportIconInfo(MarkupOutput out, WebMessage message)
Render a report icon
void renderReportMessage(MarkupOutput out, WebMessage message)
Render a report message
void renderSeparator(MarkupOutput out)
renders a message separator line
void renderStatusHeader(MarkupOutput out, String header, boolean centered, WebEvent sortEvent)
Writes a status header:
void renderStatusInfo(MarkupOutput out, WebMessage message)
Render the status of the message.
void renderTimeInfo(MarkupOutput out, WebMessage message)
Renders the last modification time
void transformForRequestSuccessful(MarkupOutput out)
Transform when the status is "Successful".
Protected Methods
void generateDeleteForm(MarkupOutput transOut)
Generate the delete confirmation form.
WebEvent getDeleteEvent()
Returns the event used to remove messages from inbox
WebEvent getExecuteEvent(WebMessage message)
WebEvent getExportEvent(WebMessage message)
Returns an initialized WebEvent to go to the Export page for an object.
WebEvent getPDFExportEvent(WebMessage message)
Returns an initialized WebEvent to go to the PDF Export page for an object.
void renderExpandMessageIcon(MarkupOutput out, WebMessage message)
[Expand]
Inherited Methods
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

Constants

public static final int LEVEL_ALL

Constant Value: 3199 (0x00000c7f)

public static final int LEVEL_DETAILS

Constant Value: 16 (0x00000010)

public static final int LEVEL_EXPORT_EXCEL

Constant Value: 1024 (0x00000400)

public static final int LEVEL_EXPORT_PDF

Constant Value: 2048 (0x00000800)

public static final int LEVEL_ICON

Constant Value: 1 (0x00000001)

public static final int LEVEL_NAME

Constant Value: 2 (0x00000002)

public static final int LEVEL_REMOVE

Constant Value: 32 (0x00000020)

public static final int LEVEL_SORT_ICONS

Constant Value: 64 (0x00000040)

public static final int LEVEL_STATUS

Constant Value: 4 (0x00000004)

public static final int LEVEL_STATUS_WITHOUT_UNREAD

Constant Value: 516 (0x00000204)

public static final int LEVEL_TIME

Constant Value: 8 (0x00000008)

public static final int LEVEL_WITHOUT_FOOTER

Constant Value: 256 (0x00000100)

public static final int LEVEL_WITHOUT_HEADER

Constant Value: 128 (0x00000080)

Fields

public FormalParameter allowDocumentExecutionOnDetails

Specifies whether the user will be able to execute documents from the document details page.
Allowed values:

  • true
  • false

Usage:
For example, if you allow to execute documents from the details page, then you would specify (true).

public FormalParameter allowReportExecutionOnDetails

Specifies whether the user will be able to execute reports from the report details page.
Allowed values:

  • true
  • false

Usage:
For example, if you allow to execute reports from the details page, then you would specify (true).

protected String cssChildMessage

protected String cssChildReadMessage

protected String cssHeader

protected String cssHighlight

protected String cssMessage

protected String cssReadMessage

protected String cssSeparator

protected String cssStatus

public FormalParameter deleteTarget

Specifies the delete target page.
Usage:
For example, if you want to go to a specific target page when deleting an object,
then you would need to specify the name in this formal parameter.

public FormalParameter imgActiveSortAscending

Specifies the image file name used by the transform to display the active sort ascending icon.
It is used to indicate that the history list has been sorted ascending by the current column header.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the active sort ascending, you would need to copy it to the images folder and then specify its name in this formal parameter.

public FormalParameter imgActiveSortDescending

Specifies the image file name used by the transform to display the active sort descending icon.
It is used to indicate that the history list has been sorted descending by the current column header.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the active sort descending, you would need to copy it to the images folder and then specify its name in this formal parameter.

public FormalParameter imgChild

Specifies the image file name used by the transform to display the document's children reports.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image for this icon, you would need
to copy it to the images folder and then specify its name in this formal parameter.

public FormalParameter imgCollapse

Specifies the image file name used by the transform to display a collapsable object.
It is used to collapse the contents of the document object when its children reports are displayed.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the collapsable object, you would need to copy it to the images folder and then specify its name in this formal parameter.

public FormalParameter imgDatamart

Specifies the image file name used by the transform to display the datamart report icon.
It is used to represent datamart reports.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to datamart report, you would need to copy it to the images folder and then specify its name in this formal parameter.

public FormalParameter imgDatamartError

Specifies the image file name used by the transform to represent errors in a datamart object.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the errors in a datamart object, you would need to copy it to the images folder and then specify its name in this formal parameter.

public FormalParameter imgDatamartScheduled

Specifies the image file name used by the transform to represent scheduled datamart objects.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the scheduled datamart, you would need to copy it to the images folder and then specify its name in this formal parameter.

public FormalParameter imgDatamartWait

Specifies the image file name used by the transform to display the running datamart icon.
This image will appear when the datamart is still running in the I-Server.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the datamart icon, you would need to copy it to the images folder and then specify its name in this formal parameter.

public FormalParameter imgDocument

Specifies the image file name used by the transform to display the document icon.
It is used to represent document objects.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the document icon, you would need to copy it to the images folder and then specify its name in this formal parameter.

public FormalParameter imgDocumentError

Specifies the image file name used by the transform to represent errors in a document object.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the errors in a document object, you would need to copy it to the images folder and then specify its name in this formal parameter.

public FormalParameter imgDocumentScheduled

Specifies the image file name used by the transform to represent scheduled document objects.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the scheduled document reports, you would need to copy it to the images folder and then specify its name in this formal parameter.

public FormalParameter imgDocumentWait

Specifies the image file name used by the transform to display the ruuning document icon.
This image will appear when the document object is still running in the I-Server.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the document icon, you would need to copy it to the images folder and then specify its name in this formal parameter.

public FormalParameter imgExpand

Specifies the image file name used by the transform to display an expandable object.
It is used to expand the contents of the document object by showing its children reports..
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the expandable object, you would need to copy it to the images folder and then specify its name in this formal parameter.

public FormalParameter imgGraph

Specifies the image file name used by the transform to display the graph icon.
It is used to represent graph reports.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the graph icon, you would need to copy it to the images folder and then specify its name in this formal parameter.

public FormalParameter imgGraphError

Specifies the image file name used by the transform to represent errors in a graph report.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the errors in a graph report, you would need to copy it to the images folder and then specify its name in this formal parameter.

public FormalParameter imgGraphScheduled

Specifies the image file name used by the transform to represent scheduled graph reports.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the scheduled graph reports, you would need to copy it to the images folder and then specify its name in this formal parameter.

public FormalParameter imgGraphSnapshot

Specifies the image file name used by the transform to display the snapshot graph icon.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the snapshot graph icon, you would need to copy it to the images folder and then specify its name in this formal parameter.

public FormalParameter imgGraphWait

Specifies the image file name used by the transform to display the running graph icon.
This image will appear when the graph report is still running in the I-Server.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the running graphs icon, you would need to copy it to the images folder and then specify its name in this formal parameter.

public FormalParameter imgGridGraph

Specifies the image file name used by the transform to display the grid-graph icon.
It is used to represent grid-graph reports.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the grid-graph icon, you would need to copy it to the images folder and then specify its name in this formal parameter.

public FormalParameter imgInfo

Specifies the image file name used by the transform to display the info icon.
It is used to show the details of the report or document objects contained in the history list.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the info icon, you would need to copy it to the images folder and then specify its name in this formal parameter.

public FormalParameter imgRWDocument

Specifies the image file name used by the transform to display the report writing document icon.
It is used to represent document objects.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the report writing document icon, you would need to copy it to the images folder and then specify its name in this formal parameter.

public FormalParameter imgRWDocumentError

Specifies the image file name used by the transform to represent errors in a report writing document object.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the errors in a report writing document object, you would need to copy it to the images folder and then specify its name in this formal parameter.

public FormalParameter imgRWDocumentScheduled

Specifies the image file name used by the transform to represent scheduled report writing document objects.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the scheduled report writing document reports, you would need to copy it to the images folder and then specify its name in this formal parameter.

public FormalParameter imgRWDocumentWait

Specifies the image file name used by the transform to display the running report writing document icon.
This image will appear when the document object is still running in the I-Server.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the report writing document icon, you would need to copy it to the images folder and then specify its name in this formal parameter.

public FormalParameter imgReport

Specifies the image file name used by the transform to display the grid icon.
It is used to represent grid reports.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the grid icon, you would need to copy it to the images folder and then specify its name in this formal parameter.

public FormalParameter imgReportError

Specifies the image file name used by the transform to represent errors in a grid report.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the errors in a grid report, you would need to copy it to the images folder and then specify its name in this formal parameter.

public FormalParameter imgReportScheduled

Specifies the image file name used by the transform to represent scheduled grid reports.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the scheduled grid reports, you would need to copy it to the images folder and then specify its name in this formal parameter.

public FormalParameter imgReportSnapshot

Specifies the image file name used by the transform to display the snapshot grid icon.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the snapshot grid icon, you would need to copy it to the images folder and then specify its name in this formal parameter.

public FormalParameter imgReportWait

Specifies the image file name used by the transform to display the running grid icon.
This image will appear when the grid report is still running in the I-Server.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the running grid icon, you would need to copy it to the images folder and then specify its name in this formal parameter.

public FormalParameter imgSelect

Specifies the image file name used by the transform to display options like export or PDF.
It is used to indicate that certain options are available for the objects contained in the history list.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the options available, you would need to copy it to the images folder and then specify its name in this formal parameter.

public FormalParameter imgSortAscending

Specifies the image file name used by the transform to display the sort ascending icon.
It is used to indicate that the history list can be sorted ascending by the current column header.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the sort ascending, you would need to copy it to the images folder and then specify its name in this formal parameter.

public FormalParameter imgSortDescending

Specifies the image file name used by the transform to display the sort descending icon.
It is used to indicate that the history list can be sorted descinding by the current column header.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the sort descending, you would need to copy it to the images folder and then specify its name in this formal parameter.

public FormalParameter levelFlag

Specifies what information is displayed for each item in the inbox.
The information may include object icon, name, status and other information. Multiple fields may be displayed at the same time.
Which fields to show is indicated by a bitwise flag. This specifies fields like icon, name, status etc. This flag is used as a bit-wise flag.
Allowed Values:

  • Icon = 1
  • Name = 2
  • Status = 4

For complete list, see LEVEL_ICON, LEVEL_STATUS, LEVEL_TIME, LEVEL_DETAILS LEVEL_REMOVE, LEVEL_SORT_ICONS, LEVEL_WITHOUT_HEADER, LEVEL_WITHOUT_FOOTER, LEVEL_EXPORT_EXCEL, LEVEL_EXPORT_PDF, LEVEL_STATUS_WITHOUT_UNREAD, LEVEL_ALL
Usage:
For example, if you want to specify icon and status, then you would specify (1 + 4 = 5)

protected int levelFlagCache

public FormalParameter maxItemCount

Specifies the maximum number of objects to be displayed in the history list.
The default value is -1, which indicates that all the objects will be rendered.
Usage:
For example, if you want to show only 5 objects in the history list, you would need to set (5) in this formal parameter.

public FormalParameter showDeleteForm

Specifies whether the transform will show the delete form.
Allowed values:

  • true
  • false

Usage:
For example, if you want to show the delete form, then you would specify (true).

Public Constructors

public InboxListTransform ()

Default constructor. Initialize all formal parameters

Public Methods

public String getDescription ()

Returns the descriptor to use in the Style Catalog.

Returns
  • "This implements the transform for an Inbox Bean"

public Class getSupportedBeanType ()

Returns the supported bean type. This abstract Transform supports all WebComponents so every sub-class should override this method to return the class of the Bean the Transform is expecting, for example:

 public class CustomReportClass extends AbstractAppTransform {

    public Class getSupportedBeanType() {
        //This Transform is expected to work only with a ReportBean,
        //therefore this method needs to return this class:
        return ReportBean.class;
    }

 }
 

Returns
  • a root class/interface supported by this transform.

public void initializeCss ()

Initializes the Css Class Strings.

public void initializeImages ()

Initialize the images to be used by this transform.

public void initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform, such as width and height. It also invokes the initializeWebComponent, initializeImages and initializeCss methods.

This method is automatically called from the transform method. Transforms which would like to invoke other methods in this instance directly (for example, to invoke some render methods), need first to call this method to guarantee that the Transform is ready to generate output.

Parameters
data the bean to transform.

public void renderDetailsInfo (MarkupOutput out, WebMessage message)

Render an icon with a link for job details

Parameters
out the output
message the message to display

public void renderDocumentIconInfo (MarkupOutput out, WebDocumentMessage message)

Render a document's icon

Parameters
out the output
message the message to display

public void renderDocumentMessage (MarkupOutput out, WebDocumentMessage message)

Renders a document message and if expanded, all the submessages, that is, the messages of its children.

Parameters
out the output
message the message to display

public void renderEmtpyInbox (MarkupOutput out)

Invoked when there are no messages in the History List to display a "hisotyr list is empty" message

Parameters
out the output

public void renderExecutionTimeHeader (MarkupOutput out, String header, boolean centered, WebEvent sortEvent)

Writes a last execution time header:

Parameters
out the output
header the header to display
centered whether this header is centered or not.
sortEvent the sort event.

public void renderExportInfo (MarkupOutput out, WebMessage message)

Render an icon for exporting the report

Parameters
out the output
message the message to display

public void renderHeader (MarkupOutput out, String header, boolean centered)

Writes a single header:

Parameters
out the output
header the header to display
centered whether this header is centered or not.

public void renderHighlighted (MarkupOutput out, String message)

renders a highlighted (bold) message:

Parameters
out output by this transform
message message to display highlighted

public void renderImage (MarkupOutput out, String image, WebMessage message)

Renders a transform's image

Parameters
out where to write the output of the method.
image the image name

public void renderImage (MarkupOutput out, String image, WebMessage message, String title)

public void renderInboxFooter (MarkupOutput out)

Renders a status bar message for the history list table

Parameters
out the output

public void renderInboxHeaders (MarkupOutput out)

Writers the header of the history list

Parameters
out the output

public void renderMessages (MarkupOutput out)

Renders the available user messages

Parameters
out MarkupOutput instance where the HTML contents to render will be saved.

public void renderNameHeader (MarkupOutput out, String header, boolean centered, WebEvent sortEvent)

Writes a name header:

Parameters
out the output
header the header to display
centered whether this header is centered or not.
sortEvent the sort event.

public void renderNameInfo (MarkupOutput out, WebMessage message)

Render the name (title) of the message

Parameters
out the output
message the message to display

public void renderPDFExportInfo (MarkupOutput out, WebMessage message)

Render an icon for exporting to PDF the report

Parameters
out the output
message the message to display

public void renderRWIconInfo (MarkupOutput out, RWMessage message)

Render a document's icon

Parameters
out the output
message the message to display

public void renderRWMessage (MarkupOutput out, RWMessage message)

Renders a document message and if expanded, all the submessages, that is, the messages of its children.

Parameters
out the output
message the message to display

public void renderRemoveInfo (MarkupOutput out, WebMessage message)

Renders a checkbox so the user can remove the message

Parameters
out the output
message the message to display

public void renderReportIconInfo (MarkupOutput out, WebMessage message)

Render a report icon

Parameters
out the output
message the message to display

public void renderReportMessage (MarkupOutput out, WebMessage message)

Render a report message

Parameters
out the output
message the message to display

public void renderSeparator (MarkupOutput out)

renders a message separator line

Parameters
out output by this transform

public void renderStatusHeader (MarkupOutput out, String header, boolean centered, WebEvent sortEvent)

Writes a status header:

Parameters
out the output
header the header to display
centered whether this header is centered or not.
sortEvent the sort event.

public void renderStatusInfo (MarkupOutput out, WebMessage message)

Render the status of the message. If status is "read" then it also renders a link to mark as unread.

Parameters
out the output
message the message to display

public void renderTimeInfo (MarkupOutput out, WebMessage message)

Renders the last modification time

Parameters
out the output
message the message to display

public void transformForRequestSuccessful (MarkupOutput out)

Transform when the status is "Successful".

Parameters
out output by this transform

Protected Methods

protected void generateDeleteForm (MarkupOutput transOut)

Generate the delete confirmation form.

protected WebEvent getDeleteEvent ()

Returns the event used to remove messages from inbox

Returns
  • EnumInboxBeanEvents.INBOX_EVENT_REMOVE_ALL_MESSAGES WebEvent.

protected WebEvent getExecuteEvent (WebMessage message)

Parameters
message the message to display
Returns
  • a WebEvent to execute the message (i.e., runReports)

protected WebEvent getExportEvent (WebMessage message)

Returns an initialized WebEvent to go to the Export page for an object. Currently this method handles only report objects.

Parameters
message the WebMessage instance which will be exported if the event is called.
Returns
  • an initialized WebEvent object if the application supports it. Otherwise, will return null

protected WebEvent getPDFExportEvent (WebMessage message)

Returns an initialized WebEvent to go to the PDF Export page for an object. Currently this method handles only report objects.

Parameters
message the WebMessage instance which will be exported if the event is called.
Returns
  • an initialized WebEvent object if the application supports it. Otherwise, will return null

protected void renderExpandMessageIcon (MarkupOutput out, WebMessage message)