public class

InboxExtrasTransform

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.InboxExtrasTransform
Known Direct Subclasses

Class Overview

Title: InboxExtrasTransform.

Description: This implements the inbox extras options on the toolbar.

Summary

Constants
String FP_BULLET_IMAGE Constant specifying the name of the formal parameter for defining the bullet image.
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected InboxBean _inboxBean
protected WebMessages _messages
public FormalParameter imgBullet Specifies the image file name used by the transform to display the bullet icon.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
InboxExtrasTransform()
Default no-argument constructor.
Public Methods
String getDescription()
Returns the description of this Transform.
Class getSupportedBeanType()
Get the class of objects this transform is able to handle.
void initializeImages()
Initializes the name of the images to use on this transform's output.
void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.
void renderClearHistoryList(MarkupOutput out)
Renders the option to clear the history list.
void renderExpandMessages(MarkupOutput out)
Renders the option to expand the document messages information (if applicable) on the history list.
void renderRefreshHistoryList(MarkupOutput out)
Renders the option to refresh the history list.
void transformForRequestSuccessful(MarkupOutput out)
Transforms the assosciated WebBean when its status is WebBeanRequestSuccessful.
Protected Methods
AnchorTag generateAnchor(WebEvent event)
Overwrites the parent method by setting special attributes to the anchor as required by the caller.
WebEvent getClearEvent()
Returns an initialized WebEvent to clear the contents of the history list.
int getDocumentCount()
Utility method
WebEvent getExpandMessagesEvent()
Returns an initialized WebEvent to expand the document messages information on the history list.
WebEvent getRefreshEvent()
Returns an initialized WebEvent to refresh the contents of the history list.
int getSelectedDocumentCount()
Utility method
String getSelectedMessageIDFromRequest()
Utility method for returning the selected message information if available on the request
[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 String FP_BULLET_IMAGE

Constant specifying the name of the formal parameter for defining the bullet image. Value is imgBullet.

Constant Value: "imgBullet"

Fields

protected InboxBean _inboxBean

protected WebMessages _messages

public FormalParameter imgBullet

Specifies the image file name used by the transform to display the bullet icon.
This image should be contained in the images folder of the application.
Usage:
For example, if you want to specify a different image to display the bullet icon, you would need to copy it to the images folder and then specify its name in this formal parameter.

Public Constructors

public InboxExtrasTransform ()

Default no-argument constructor. Initializes formal parameters.

Public Methods

public String getDescription ()

Returns the description of this Transform.

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

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 initializeImages ()

Initializes the name of the images to use on this transform's output. For each one of the images defined to be displayed, the resource folder information is added to its path and file name as specified on the formal parameters for the images.

public void initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform. Extends initializeTransform by initializing the cache of this transform's Formal parameters.

Parameters
data Transformable instance with the bean to be transformed.

public void renderClearHistoryList (MarkupOutput out)

Renders the option to clear the history list.

Parameters
out MarkupOutput instance where to write the output of the method.

public void renderExpandMessages (MarkupOutput out)

Renders the option to expand the document messages information (if applicable) on the history list.

Parameters
out MarkupOutput instance where to write the output of the method.

public void renderRefreshHistoryList (MarkupOutput out)

Renders the option to refresh the history list.

Parameters
out MarkupOutput instance where to write the output of the method.

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.

Protected Methods

protected AnchorTag generateAnchor (WebEvent event)

Overwrites the parent method by setting special attributes to the anchor as required by the caller.

Parameters
event WebEvent instance from where the anchor will be constructed
Returns
  • AnchorTag initialized instance with the information as provided by the arguments.

protected WebEvent getClearEvent ()

Returns an initialized WebEvent to clear the contents of the history list.

Returns
  • the WebEvent instance initialized if possible, null if the application doesn't support it.

protected int getDocumentCount ()

Utility method

Returns
  • the number of documents available on the inbox

protected WebEvent getExpandMessagesEvent ()

Returns an initialized WebEvent to expand the document messages information on the history list.

Returns
  • the WebEvent instance initialized if possible, null if the application doesn't support it.

protected WebEvent getRefreshEvent ()

Returns an initialized WebEvent to refresh the contents of the history list.

Returns
  • the WebEvent instance initialized if possible, null if the application doesn't support it.

protected int getSelectedDocumentCount ()

Utility method

Returns
  • the number of documents available on the inbox that have been selected by the user

protected String getSelectedMessageIDFromRequest ()

Utility method for returning the selected message information if available on the request

Returns
  • an empty String value if nothing was found, otherwise it will return the value of the argument found on the request.