public class

InboxListXHTMLTransform

extends AbstractAppTransform
implements LayoutTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.InboxListXHTMLTransform

Class Overview

Title: InboxListXHTMLTransform. The InboxListXHTMLTransform generates a list content of the user's Inbox. From this list, users can execute the corresponding inbox message, view its details or remove the message from the inbox.
The output of this Transform generates well-formed XHTML, and it's designed to use external css files for all formatting.

Summary

Nested Classes
class InboxListXHTMLTransform.Context Extends AbstractAppTransform.Context by providing a link to the current WebObjectInfo
Constants
String CSS_MESSAGE_CUBE This constant is deprecated. Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform
String CSS_MESSAGE_CUBE_ERROR This constant is deprecated. Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform
String CSS_MESSAGE_CUBE_EXECUTING This constant is deprecated. Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform
String CSS_MESSAGE_CUBE_SCHEDULED This constant is deprecated. Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform
String CSS_MESSAGE_DATAMART This constant is deprecated. Please review the getCssName method output for the CSS classes generated by this transform
String CSS_MESSAGE_DATAMART_ERROR This constant is deprecated. Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform
String CSS_MESSAGE_DATAMART_EXECUTING This constant is deprecated. Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform
String CSS_MESSAGE_DATAMART_SCHEDULED This constant is deprecated. Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform
String CSS_MESSAGE_DOCUMENT This constant is deprecated. Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform
String CSS_MESSAGE_DOCUMENT_ERROR This constant is deprecated. Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform
String CSS_MESSAGE_DOCUMENT_SCHEDULED This constant is deprecated. Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform
String CSS_MESSAGE_DOCUMENT_WAIT This constant is deprecated. Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform
String CSS_MESSAGE_GRAPH This constant is deprecated. Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform
String CSS_MESSAGE_GRAPH_ARCHIVED This constant is deprecated. Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform
String CSS_MESSAGE_GRAPH_ERROR This constant is deprecated. Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform
String CSS_MESSAGE_GRAPH_EXECUTING This constant is deprecated. Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform
String CSS_MESSAGE_GRAPH_SCHEDULED This constant is deprecated. Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform
String CSS_MESSAGE_GRID This constant is deprecated. Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform
String CSS_MESSAGE_GRID_ARCHIVED This constant is deprecated. Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform
String CSS_MESSAGE_GRID_ERROR This constant is deprecated. Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform
String CSS_MESSAGE_GRID_EXECUTING This constant is deprecated. Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform
String CSS_MESSAGE_GRID_GRAPH This constant is deprecated. Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform
String CSS_MESSAGE_GRID_SCHEDULED This constant is deprecated. Please review the getCssName method output for the CSS classes generated by this transform
String CSS_MESSAGE_RW This constant is deprecated. Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform
String CSS_MESSAGE_RW_ERROR This constant is deprecated. Please review the getCssName method output for the CSS classes generated by this transform
String CSS_MESSAGE_RW_SCHEDULED This constant is deprecated. Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform
String CSS_MESSAGE_RW_WAIT This constant is deprecated. Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform
String EXEC_TARGET Constant used as the name for the formal parameter that determines how the user want's to execute the Report/Document object.
int LEVEL_ALL Allowed value for the levelFlag formal parameter.
int LEVEL_CREATION_TIME Allowed value for the levelFlag formal parameter.
int LEVEL_DETAILS Allowed value for the levelFlag formal parameter.
int LEVEL_EXPORT_EXCEL Allowed value for the levelFlag formal parameter.
int LEVEL_EXPORT_PDF Allowed value for the levelFlag formal parameter.
int LEVEL_FOOTER Allowed value for the levelFlag formal parameter.
int LEVEL_HEADER Allowed value for the levelFlag formal parameter.
int LEVEL_ICON Allowed value for the levelFlag formal parameter.
int LEVEL_MODIFICATION_TIME Allowed value for the levelFlag formal parameter.
int LEVEL_NAME Allowed value for the levelFlag formal parameter.
int LEVEL_REMOVE Allowed value for the levelFlag formal parameter.
int LEVEL_SORT_ICONS Allowed value for the levelFlag formal parameter.
int LEVEL_START_TIME Allowed value for the levelFlag formal parameter.
int LEVEL_STATUS Allowed value for the levelFlag formal parameter.
int LEVEL_UNREAD_LINK Allowed value for the levelFlag formal parameter.
[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.
public FormalParameter execTarget Determines how the user want's to execute the Report/Document object.
public FormalParameter levelFlag Specifies what information is displayed for each item in the inbox.
public FormalParameter maxItemCount Specifies the maximum number of objects to be displayed in the history list.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
InboxListXHTMLTransform()
Default constructor.
Public Methods
boolean canExport(WebMessage message)
boolean canMarkUnread(WebMessage message)
boolean canPDF(WebMessage message)
boolean canRemove(WebMessage message)
boolean canRename(WebMessage mesg)
boolean canShowDetails(WebMessage message)
ArrayList getChildMessages(WebMessage message)
Return the child messages for a Inbox message
Map getContextMenuAttributes(WebMessage mesg)
Returns the context-menu specific attributes to assign to the context-menu container
String getDescription()
Returns the descriptor to use in the Style Catalog.
WebEvent getDetailsEvent(WebMessage message)
WebEvent getEditRenameEvent(WebMessage msg)
WebEvent getExportEvent(WebMessage message)
Returns an initialized WebEvent to go to the Export page for an object.
Map getMainTableAttributes()
Return the Summary Attribute to be used in the table for the transform.
WebEvent getMarkUnreadEvent(WebMessage message)
Map getMessageAttributes(WebMessage webMessage)
Return the Summary Attribute to be used in the table for the transform.
ArrayList getMessages()
Return the list of Inbox Messages
WebEvent getPDFExportEvent(WebMessage message)
Returns an initialized WebEvent to go to the PDF Export page for an object.
WebEvent getRemoveEvent(WebMessage message)
WebEvent getRenameEvent()
Class getSupportedBeanType()
Get the class of objects this transform is able to handle.
void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.
boolean isInboxEmpty()
Returns true if there are no messages in Inbox.
void renderCreateTimeInfo(MarkupOutput out, WebMessage message)
Renders the creation time, ie the time that this Inbox Message was created within the Intelligence Server.
void renderDetailsInfo(MarkupOutput out, WebMessage message)
Render an icon with a link for job details
void renderEmptyList(MarkupOutput out)
void renderEmptySpaceIcon(MarkupOutput out)
void renderExpandMessageIcon(MarkupOutput out, WebMessage message)
Renders the image information required for documents to render a list with their children information.
void renderExportInfo(MarkupOutput out, WebMessage message)
Render an icon for exporting the message
void renderFooter(MarkupOutput out)
Renders a status bar message for the history list table
void renderFormEnd(MarkupOutput out)
Renders the FORM tag end information.
void renderFormStart(MarkupOutput out)
Renders the FORM tag start information
void renderIconInfo(MarkupOutput out, WebMessage message)
Write out the image information for a single message.
void renderLayeredIconInfo(MarkupOutput out, WebMessage message)
Similar to renderIconInfo(MarkupOutput, WebMessage), but instead of generating an IMG tag, having a transparent image as its source and a background image assigned via the CSS style, it will now generate a SPAN tag which will have the same css class defined (where the background image is indicated) and an inner SPAN for the layering effect, in case an additional image has to be included, on top of the original (for example, a shortcut arrow, a red error sign, etc).
void renderMarkUnread(MarkupOutput out, WebMessage message)
void renderModificationTimeInfo(MarkupOutput out, WebMessage message)
Renders the message's modification time
void renderNameInfo(MarkupOutput out, WebMessage message)
Write out the name information for a single message.
void renderPDFExportInfo(MarkupOutput out, WebMessage message)
Render an icon for exporting to PDF the message
void renderRemoveButton(MarkupOutput out)
Render the remove button in the inbox page
void renderRemoveInfo(MarkupOutput out, WebMessage message)
Renders a checkbox so the user can remove the message
void renderRenameIcon(MarkupOutput out, WebMessage message)
void renderRenameWidgets(MarkupOutput out, WebMessage message)
void renderSort(MarkupOutput out, int field)
This method is deprecated. the sort can be rendered using renderSortingTitle(MarkupOutput, int, int)
void renderSortingTitle(MarkupOutput out, int name, int field)
function for rendering the title with sorting
void renderStartTimeInfo(MarkupOutput out, WebMessage message)
Renders the start request time, ie the time when the job started executing.
void renderStatusInfo(MarkupOutput out, WebMessage message)
Render the status of the message.
void transformForRequestSuccessful(MarkupOutput out)
Transform when the status is "Successful".
Protected Methods
AnchorTag generateAnchor(WebEvent event)
Overwrites the parent method by setting special attributes if the event is not provided
Tag generateColumnGroup()
Generates a COLGROUP HTML tag with COL tags defined for each one of the columns to be rendered on this transform.
RowTag generateHeadersRow()
Generates a TR HTML tag with TD tags defined for each one of the column headers to be rendered on this transform according to privileges and value assigned to the level formal parameter.
RowTag generateItem(WebMessage message, boolean isParent)
Generates the RowTag instance corresponding to the information of the WebMessage sent in as parameter.
RowTag[] generateItems()
Analyzes all the items available on the inbox to display and generates an array of RowTag instances (corresponding to TR HTML tags) with the information.
TableTag generateTable()
Generates a TABLE HTML tag where all the contents of the inbox will be added as rows of this table.
WebEvent getCancelRenameEvent()
TransformContext getContext()
Extends getContext() by setting to the context object a reference the current WebMessage
ContextMenu getContextMenu(WebMessage mesg)
Return the ContextMenu associated with the object
String getCssName(WebMessage message)
Generate the css name to be associated with the message icon, depending on its request type and its current state.
String getDerivedCssName(WebMessage message)
Generated a css name to be associated with the message, for cases when a report message is child of a document, or when a document has a children list to be collapsed or expanded.
WebEvent getEditRenameEvent()
WebEvent getEventForMessage(WebMessage message)
WebEvent getExecuteEvent(WebMessage message)
Generate the event to use if the current message is to be executed in some way.
int getFieldCount()
String getMessageRowCssName(WebMessage message)
Obtain the css to be associated to the message on the table row (TR tag) to generate for it.
WebEvent getRemoveEvent()
Generate the event to be used for commanding the removal of an element listed on the inbox contents.
WebEvent getSortEvent()
Generate the event to be used for commanding the sort of the information present on the inbox.
TransformContext newContext()
Creates a new instance of a TransformContext.
[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.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Constants

public static final String CSS_MESSAGE_CUBE

This constant is deprecated.
Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform

Constant used as the CSS class for cube messages

Constant Value: "cb"

public static final String CSS_MESSAGE_CUBE_ERROR

This constant is deprecated.
Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform

Constant used as the CSS class for cube messages that end in error

Constant Value: "cbErr"

public static final String CSS_MESSAGE_CUBE_EXECUTING

This constant is deprecated.
Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform

Constant used as the CSS class for datamart messages that are still executing

Constant Value: "cbWai"

public static final String CSS_MESSAGE_CUBE_SCHEDULED

This constant is deprecated.
Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform

Constant used as the CSS class for cube messages originated from a web-schedule

Constant Value: "cbSch"

public static final String CSS_MESSAGE_DATAMART

This constant is deprecated.
Please review the getCssName method output for the CSS classes generated by this transform

Constant used as the CSS class for datamart messages

Constant Value: "dm"

public static final String CSS_MESSAGE_DATAMART_ERROR

This constant is deprecated.
Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform

Constant used as the CSS class for datamart messages that end in error

Constant Value: "dmErr"

public static final String CSS_MESSAGE_DATAMART_EXECUTING

This constant is deprecated.
Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform

Constant used as the CSS class for datamart messages that are still executing

Constant Value: "dmWai"

public static final String CSS_MESSAGE_DATAMART_SCHEDULED

This constant is deprecated.
Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform

Constant used as the CSS class for datamart messages originated from a web-schedule

Constant Value: "dmSch"

public static final String CSS_MESSAGE_DOCUMENT

This constant is deprecated.
Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform

Constant used as the CSS class for html-document messages

Constant Value: "d"

public static final String CSS_MESSAGE_DOCUMENT_ERROR

This constant is deprecated.
Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform

Constant used as the CSS class for html-document messages that ends in error

Constant Value: "dErr"

public static final String CSS_MESSAGE_DOCUMENT_SCHEDULED

This constant is deprecated.
Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform

Constant used as the CSS class for html-document messages that were originated from a web-schedule

Constant Value: "dSch"

public static final String CSS_MESSAGE_DOCUMENT_WAIT

This constant is deprecated.
Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform

Constant used as the CSS class for html-document messages that are still executing

Constant Value: "dWai"

public static final String CSS_MESSAGE_GRAPH

This constant is deprecated.
Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform

Constant used as the CSS class for graph messages

Constant Value: "gp"

public static final String CSS_MESSAGE_GRAPH_ARCHIVED

This constant is deprecated.
Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform

Constant used as the CSS class for graph messages stored in the inbox

Constant Value: "gpSnp"

public static final String CSS_MESSAGE_GRAPH_ERROR

This constant is deprecated.
Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform

Constant used as the CSS class for graph messages that ends in error

Constant Value: "gpErr"

public static final String CSS_MESSAGE_GRAPH_EXECUTING

This constant is deprecated.
Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform

Constant used as the CSS class for graph messages that are still executing

Constant Value: "gpWai"

public static final String CSS_MESSAGE_GRAPH_SCHEDULED

This constant is deprecated.
Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform

Constant used as the CSS class for graph messages that were originated from a web-scheduled

Constant Value: "gpSch"

public static final String CSS_MESSAGE_GRID

This constant is deprecated.
Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform

Constant used as the CSS class for grid messages

Constant Value: "g"

public static final String CSS_MESSAGE_GRID_ARCHIVED

This constant is deprecated.
Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform

Constant used as the CSS class for grid messages stored in the inbox

Constant Value: "gSnp"

public static final String CSS_MESSAGE_GRID_ERROR

This constant is deprecated.
Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform

Constant used as the CSS class for grid messages that end in error

Constant Value: "gErr"

public static final String CSS_MESSAGE_GRID_EXECUTING

This constant is deprecated.
Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform

Constant used as the CSS class for grid messages that are still executing

Constant Value: "gWai"

public static final String CSS_MESSAGE_GRID_GRAPH

This constant is deprecated.
Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform

Constant used as the CSS class for grid-graph messages

Constant Value: "gpgs"

public static final String CSS_MESSAGE_GRID_SCHEDULED

This constant is deprecated.
Please review the getCssName method output for the CSS classes generated by this transform

Constant used as the CSS class for grid messages that were originated from a web-schedule

Constant Value: "gSch"

public static final String CSS_MESSAGE_RW

This constant is deprecated.
Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform

Constant used as the CSS class for document messages

Constant Value: "rw"

public static final String CSS_MESSAGE_RW_ERROR

This constant is deprecated.
Please review the getCssName method output for the CSS classes generated by this transform

Constant used as the CSS class for Document messages that ends in error

Constant Value: "rwErr"

public static final String CSS_MESSAGE_RW_SCHEDULED

This constant is deprecated.
Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform

Constant used as the CSS class for document messages that were originated from a web-schedule

Constant Value: "rwSch"

public static final String CSS_MESSAGE_RW_WAIT

This constant is deprecated.
Please review the getCssName(WebMessage) method output for the CSS classes generated by this transform

Constant used as the CSS class for document messages that are still executing

Constant Value: "rwWai"

public static final String EXEC_TARGET

Constant used as the name for the formal parameter that determines how the user want's to execute the Report/Document object. If set to "_blank" it will open a new window, if empty the link will be executed in the same window.

Constant Value: "execTarget"

public static final int LEVEL_ALL

Allowed value for the levelFlag formal parameter. Convenience flag to indicate all enabled LEVEL values.
Value = 65535

Constant Value: 65535 (0x0000ffff)

public static final int LEVEL_CREATION_TIME

Allowed value for the levelFlag formal parameter. Specifies that the folder transform will display the message's creation time.
Value = 4096

Constant Value: 4096 (0x00001000)

public static final int LEVEL_DETAILS

Allowed value for the levelFlag formal parameter. Specifies that the folder transform will display object's link to details.
Value = 16

Constant Value: 16 (0x00000010)

public static final int LEVEL_EXPORT_EXCEL

Allowed value for the levelFlag formal parameter. Specifies that the folder transform will display object's option to be exported to excel.
Value = 1024

Constant Value: 1024 (0x00000400)

public static final int LEVEL_EXPORT_PDF

Allowed value for the levelFlag formal parameter. Specifies that the folder transform will display object's option to be exported to excel.
Value = 2048

Constant Value: 2048 (0x00000800)

public static final int LEVEL_FOOTER

Allowed value for the levelFlag formal parameter. Specifies that it is requested the folder transform to display the footer.
Value = 256

Constant Value: 256 (0x00000100)

public static final int LEVEL_HEADER

Allowed value for the levelFlag formal parameter. Specifies that it is requested the folder transform to display the header.
Value = 128

Constant Value: 128 (0x00000080)

public static final int LEVEL_ICON

Allowed value for the levelFlag formal parameter. Specifies that the folder transform will display object's icon.
Value = 1

Constant Value: 1 (0x00000001)

public static final int LEVEL_MODIFICATION_TIME

Allowed value for the levelFlag formal parameter. Specifies that the folder transform will display the message's modification time.
Value = 8192

Constant Value: 8192 (0x00002000)

public static final int LEVEL_NAME

Allowed value for the levelFlag formal parameter. Specifies that the folder transform will display object's name.
Value = 2

Constant Value: 2 (0x00000002)

public static final int LEVEL_REMOVE

Allowed value for the levelFlag formal parameter. Specifies that the folder transform will display object's option to be removed.
Value = 32

Constant Value: 32 (0x00000020)

public static final int LEVEL_SORT_ICONS

Allowed value for the levelFlag formal parameter. Specifies that the folder transform will display sort buttons.
Value = 64

Constant Value: 64 (0x00000040)

public static final int LEVEL_START_TIME

Allowed value for the levelFlag formal parameter. Specifies that the folder transform will display object's time information.
Value = 8

Constant Value: 8 (0x00000008)

public static final int LEVEL_STATUS

Allowed value for the levelFlag formal parameter. Specifies that the folder transform will display object's status.
Value = 4

Constant Value: 4 (0x00000004)

public static final int LEVEL_UNREAD_LINK

Allowed value for the levelFlag formal parameter. Specifies that it is requested the folder transform to display the link to mark message as unread.
Value = 512

Constant Value: 512 (0x00000200)

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).

public FormalParameter execTarget

Determines how the user want's to execute the Report/Document object. If set to "_blank" it will open a new window, if empty the link will be executed in the same window.

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_START_TIME, LEVEL_DETAILS LEVEL_REMOVE, LEVEL_SORT_ICONS, LEVEL_HEADER, LEVEL_FOOTER, LEVEL_EXPORT_EXCEL, LEVEL_EXPORT_PDF, LEVEL_UNREAD_LINK, LEVEL_ALL
Usage:
For example, if you want to specify icon and status, then you would specify (1 + 4 = 5)
Default value:
LEVEL_HEADER + LEVEL_SORT_ICONS + LEVEL_FOOTER + LEVEL_ICON + LEVEL_NAME + LEVEL_STATUS + LEVEL_UNREAD_LINK + LEVEL_START_TIME + LEVEL_EXPORT_EXCEL + LEVEL_EXPORT_PDF + LEVEL_DETAILS + LEVEL_REMOVE

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 Constructors

public InboxListXHTMLTransform ()

Default constructor. Initialize all formal parameters

Public Methods

public boolean canExport (WebMessage message)

public boolean canMarkUnread (WebMessage message)

public boolean canPDF (WebMessage message)

public boolean canRemove (WebMessage message)

public boolean canRename (WebMessage mesg)

public boolean canShowDetails (WebMessage message)

public ArrayList getChildMessages (WebMessage message)

Return the child messages for a Inbox message

Parameters
message - message you are interested in
Returns
  • ArrayList of the childMessages

public Map getContextMenuAttributes (WebMessage mesg)

Returns the context-menu specific attributes to assign to the context-menu container

Returns
  • Map

public String getDescription ()

Returns the descriptor to use in the Style Catalog.

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

public WebEvent getDetailsEvent (WebMessage message)

public WebEvent getEditRenameEvent (WebMessage msg)

public WebEvent getExportEvent (WebMessage message)

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

Parameters
message the WebMessage instance which will be exported if the event is called.
Returns

public Map getMainTableAttributes ()

Return the Summary Attribute to be used in the table for the transform.

Returns
  • java.util.Map with the attribute name (as key) and the value.

public WebEvent getMarkUnreadEvent (WebMessage message)

public Map getMessageAttributes (WebMessage webMessage)

Return the Summary Attribute to be used in the table for the transform.

Returns
  • java.util.Map with the attribute name (as key) and the value.

public ArrayList getMessages ()

Return the list of Inbox Messages

Returns
  • an ArrayList containing the top level inbox messages.

public 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

public WebEvent getRemoveEvent (WebMessage message)

public WebEvent getRenameEvent ()

public Class getSupportedBeanType ()

Get the class of objects this transform is able to handle.

Returns
  • a Class instance with the information about the beans this transform is able to manipulate.

public void initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform.

Parameters
data Transformable instance with the bean to be transformed.

public boolean isInboxEmpty ()

Returns true if there are no messages in Inbox.

Returns
  • true if Inbox is empty

public void renderCreateTimeInfo (MarkupOutput out, WebMessage message)

Renders the creation time, ie the time that this Inbox Message was created within the Intelligence Server. An inbox message may be created by starting a new report instance or by duplicating an existing Inbox Message.

Parameters
out MarkupOutput instance where to save the contents to display
message WebMessage instance being rendered

public void renderDetailsInfo (MarkupOutput out, WebMessage message)

Render an icon with a link for job details

Parameters
out MarkupOutput instance where to save the contents to display
message WebMessage instance being rendered

public void renderEmptyList (MarkupOutput out)

public void renderEmptySpaceIcon (MarkupOutput out)

public void renderExpandMessageIcon (MarkupOutput out, WebMessage message)

Renders the image information required for documents to render a list with their children information.

Parameters
out MarkupOutput instance where the transform's output will be saved.
message WebMessage instance being rendered

public void renderExportInfo (MarkupOutput out, WebMessage message)

Render an icon for exporting the message

Parameters
out MarkupOutput instance where to save the contents to display
message WebMessage instance being rendered

public void renderFooter (MarkupOutput out)

Renders a status bar message for the history list table

Parameters
out MarkupOutput instance where to save the contents to display

public void renderFormEnd (MarkupOutput out)

Renders the FORM tag end information.

Parameters
out MarkupOutput instance where the transform's output will be saved.

public void renderFormStart (MarkupOutput out)

Renders the FORM tag start information

Parameters
out MarkupOutput instance where the transform's output will be saved.

public void renderIconInfo (MarkupOutput out, WebMessage message)

Write out the image information for a single message. The css class of the image (which defines the GIF to use) is determined by the message type. The image will be rendered as a link if the event according to the object type, provided by the getExecuteEvent() method, is available and gives access to it.
The image is provided in a CSS file and set on the ImageTag tag so it gets rendered.

Parameters
out MarkupOutput instance where to save the contents to display
message WebMessage instance being rendered

public void renderLayeredIconInfo (MarkupOutput out, WebMessage message)

Similar to renderIconInfo(MarkupOutput, WebMessage), but instead of generating an IMG tag, having a transparent image as its source and a background image assigned via the CSS style, it will now generate a SPAN tag which will have the same css class defined (where the background image is indicated) and an inner SPAN for the layering effect, in case an additional image has to be included, on top of the original (for example, a shortcut arrow, a red error sign, etc).

Parameters
out MarkupOutput instance where to save the contents to display
message WebMessage instance being rendered

public void renderMarkUnread (MarkupOutput out, WebMessage message)

public void renderModificationTimeInfo (MarkupOutput out, WebMessage message)

Renders the message's modification time

Parameters
out MarkupOutput instance where to save the contents to display
message WebMessage instance being rendered

public void renderNameInfo (MarkupOutput out, WebMessage message)

Write out the name information for a single message. The name will be rendered as a link if the event according to the object type, provided by the getExecuteEvent() method, is available and gives access to it.
The link is built using the generateAnchor() method, using the event obtained from the getExecuteEvent() method as an attribute. Once this is done, the title for the message is simply appended to the contents of the tag.

Parameters
out MarkupOutput instance where to save the contents to display
message WebMessage instance being rendered

public void renderPDFExportInfo (MarkupOutput out, WebMessage message)

Render an icon for exporting to PDF the message

Parameters
out MarkupOutput instance where to save the contents to display
message WebMessage instance being rendered

public void renderRemoveButton (MarkupOutput out)

Render the remove button in the inbox page

Parameters
out - the MarkupOutput instace to append the information

public void renderRemoveInfo (MarkupOutput out, WebMessage message)

Renders a checkbox so the user can remove the message

Parameters
out MarkupOutput instance where to save the contents to display
message WebMessage instance being rendered

public void renderRenameIcon (MarkupOutput out, WebMessage message)

public void renderRenameWidgets (MarkupOutput out, WebMessage message)

public void renderSort (MarkupOutput out, int field)

This method is deprecated.
the sort can be rendered using renderSortingTitle(MarkupOutput, int, int)

Utility method for rendering a sort button linked to the event that triggers it.

Parameters
out MarkupOutput instance where the contents of this transform will be saved.
field integer value that defines the type of sort to be executed if requested

public void renderSortingTitle (MarkupOutput out, int name, int field)

function for rendering the title with sorting

Parameters
out MarkupOutput instance where the contents of this transform will be saved.
name Integer value that defines the name of title to be executed
field Integer value that defines the type of sort to be executed if requested

public void renderStartTimeInfo (MarkupOutput out, WebMessage message)

Renders the start request time, ie the time when the job started executing. This is the column used by Microstrategy Web out of the box with title "Message Creation Time".

Parameters
out MarkupOutput instance where to save the contents to display
message WebMessage instance being rendered

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 MarkupOutput instance where to save the contents to display
message WebMessage instance being rendered

public void transformForRequestSuccessful (MarkupOutput out)

Transform when the status is "Successful".

Parameters
out MarkupOutput instance where the transform's output will be saved.

Protected Methods

protected AnchorTag generateAnchor (WebEvent event)

Overwrites the parent method by setting special attributes if the event is not provided

Parameters
event WebEvent
Returns
  • AnchorTag

protected Tag generateColumnGroup ()

Generates a COLGROUP HTML tag with COL tags defined for each one of the columns to be rendered on this transform. For example, the content might look like this:

   <colgroup>
     <col class=typ />
     <col class=nam />
     <col class=sta />
     <col class=mct />
   </colgroup>
 

Returns
  • Tag instance corresponding to the COLGROUP HTML tag.

protected RowTag generateHeadersRow ()

Generates a TR HTML tag with TD tags defined for each one of the column headers to be rendered on this transform according to privileges and value assigned to the level formal parameter. For example, the content might look like this:

   <tr>
     <td> </td>
     <td>Name</td>
     <td>Status</td>
     <td>Last Execution Time</td>
   </tr>
 

Returns
  • RowTag instance corresponding to the TR HTML tag where the headers were defined.

protected RowTag generateItem (WebMessage message, boolean isParent)

Generates the RowTag instance corresponding to the information of the WebMessage sent in as parameter.

Parameters
message WebMessage message to render.
Returns
  • a RowTag (TR HTML tag) with the information about the WebMessage instance requested contained on CellTag child instances. For example, icon image, name, status, etc.

protected RowTag[] generateItems ()

Analyzes all the items available on the inbox to display and generates an array of RowTag instances (corresponding to TR HTML tags) with the information.

Returns
  • RowTag[] an array of RowTag instances, each one with the information of one message on the inbox being transformed. If no message is found to render, returns a simple row indicating so.

protected TableTag generateTable ()

Generates a TABLE HTML tag where all the contents of the inbox will be added as rows of this table. Basic HTML attributes are defined to it, such as class.

Returns
  • a TableTag instance defined, by default no rows or other information are added to it. Methods like generateHeadersRow and generateItems should be called for obtaining the information that shall be added to it.

protected WebEvent getCancelRenameEvent ()

protected TransformContext getContext ()

Extends getContext() by setting to the context object a reference the current WebMessage

protected ContextMenu getContextMenu (WebMessage mesg)

Return the ContextMenu associated with the object

Parameters
mesg WebMessage
Returns

protected String getCssName (WebMessage message)

Generate the css name to be associated with the message icon, depending on its request type and its current state.

Parameters
message WebMessage instance being analyzed
Returns
  • String value with the css name to use for the image of the message being rendered.

protected String getDerivedCssName (WebMessage message)

Generated a css name to be associated with the message, for cases when a report message is child of a document, or when a document has a children list to be collapsed or expanded.

Parameters
message WebMessage instance being analyzed
Returns
  • String value with the css to be used for a secondary image associated with the message being analyzed. It may return an empty string if none is needed.

protected WebEvent getEditRenameEvent ()

protected WebEvent getEventForMessage (WebMessage message)

protected WebEvent getExecuteEvent (WebMessage message)

Generate the event to use if the current message is to be executed in some way.

Parameters
message WebMessage instance being analyzed
Returns

protected int getFieldCount ()

Returns
  • the number fields this transform is displaying, this will depend on the fields that are enabled through the levelFlags formal parameter

protected String getMessageRowCssName (WebMessage message)

Obtain the css to be associated to the message on the table row (TR tag) to generate for it.

Parameters
message WebMessage instance being analyzed
Returns
  • String value with the css name to use on the TR tag where this message is being displayed. May return an empty string if no special css is needed for the it.

protected WebEvent getRemoveEvent ()

Generate the event to be used for commanding the removal of an element listed on the inbox contents.

Returns

protected WebEvent getSortEvent ()

Generate the event to be used for commanding the sort of the information present on the inbox.

Returns

protected TransformContext newContext ()

Creates a new instance of a TransformContext. It's used by the getContext method the first time is invoked. Transforms who require to include extra information in the context should create their own TransformContext implementation (possibly a subclass of AppTransformContext) and returns a new instance in this method.