public class

InboxClearTransform

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

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

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
InboxClearTransform()
Default constructor.
Public Methods
WebEvent getCancelEvent()
Generate the event to be used for cancelling the clearing of all the messages from the History List.
WebEvent getClearInboxEvent()
Generate the event to be used for clearing all the messages from the History List.
String getDescription()
Returns the description to use in the Style Catalog.
WebEvent getReturnToEvent()
After this page gets executed for the second time, and after the inbox has been cleared, we want to return to a previous page.
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.
void renderButtonBar(MarkupOutput out)
Renders the buttons that will execute the action
void renderConfirmDelete(MarkupOutput out)
Generate the HTML for the Confirm Delete dialog rendered by this transform.
void renderConfirmationMessage(MarkupOutput out)
Renders a confirmation message warning user about the action
void renderRemoveTitle(MarkupOutput out)
Renders the HTML content for the title of the dialog to be shown by this transform
void transformForRequestSuccessful(MarkupOutput out)
Transforms the assosciated WebBean when its status is WebBeanRequestSuccessful.
[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

Public Constructors

public InboxClearTransform ()

Default constructor. Initialize all formal parameters

Public Methods

public WebEvent getCancelEvent ()

Generate the event to be used for cancelling the clearing of all the messages from the History List.

Returns
  • a WebEvent initialized instance with the event for cancelling the removal of all the messages from the Inbox, returns null if not supported by the application. By default, the event generated is WebEventOpenHistoryList

public WebEvent getClearInboxEvent ()

Generate the event to be used for clearing all the messages from the History List.

Returns
  • a WebEvent initialized instance with the event for removing all the messages from the Inbox, returns null if not supported by the application. By default, the event generated is INBOX_EVENT_REMOVE_ALL_MESSAGES

public String getDescription ()

Returns the description to use in the Style Catalog.

Returns
  • "This implements the transform to confirm clear all inbox messages."

public WebEvent getReturnToEvent ()

After this page gets executed for the second time, and after the inbox has been cleared, we want to return to a previous page. This returns the event to go back to the previous page.

Returns
  • a WebEvent initialized instance with the event for returning to the previous page. Returns null if not supported by the application. By default, the event generated is WebEventOpenHistoryList

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 void renderButtonBar (MarkupOutput out)

Renders the buttons that will execute the action

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderConfirmDelete (MarkupOutput out)

Generate the HTML for the Confirm Delete dialog rendered by this transform.

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderConfirmationMessage (MarkupOutput out)

Renders a confirmation message warning user about the action

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderRemoveTitle (MarkupOutput out)

Renders the HTML content for the title of the dialog to be shown by this transform

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void transformForRequestSuccessful (MarkupOutput out)

Transforms the assosciated WebBean when its status is WebBeanRequestSuccessful.

Parameters
out MarkupOutput instance where the contents of this transform will be saved.