public class

FolderIconTransform

extends AbstractFolderTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
           ↳ com.microstrategy.web.app.transforms.AbstractFolderTransform
             ↳ com.microstrategy.web.app.transforms.FolderIconTransform
Known Direct Subclasses

Class Overview

This class displays the content of a FolderBean as a list of icons organized in columns.

Summary

Constants
String FP_COLUMNS_NUMBER Constant specifying the name of the formal parameter for defining the number of columns.
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractFolderTransform
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public FormalParameter columnsNumber Indicates the number of columns with information to be used when displaying the contents of the transform.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractFolderTransform
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
FolderIconTransform()
Default no-argument constructor.
Public Methods
String getDescription()
Return the description for this Transform
WebEvent getExportEvent(WebObjectInfo object)
Overwrites the parent method by assigning a target to the event, by default a new window will be opened when exporting.
WebEvent getPDFExportEvent(WebObjectInfo object)
Overwrites the parent method by assigning a target to the event, by default a new window will be opened when exporting to PDF.
void renderDeleteInfo(MarkupOutput out, WebObjectInfo object)
Write out delete information for a single object, consisting on a text link if the event provided by the getDeleteEvent(WebObjectInfo) method is available and the user has the required privileges.
void renderDescriptionInfo(MarkupOutput out, WebObjectInfo object)
Write out description information for a single object.
void renderEditInfo(MarkupOutput out, WebObjectInfo object)
Write out edit information for a single object, consisting on a text link if the event provided by the getEditEvent(WebObjectInfo) method is available and the user has the required privileges.
void renderExport(MarkupOutput out, WebObjectInfo object)
Write out information for exporting a single object, consisting on a text link if the event provided by the getExportEvent(WebObjectInfo) method is available and the user has the required privileges.
void renderIconInfo(MarkupOutput out, WebObjectInfo object)
Write out the image information for a single object.
void renderItems(MarkupOutput out)
Renders the contents of the folder as an HTML TABLE with the required rows and columns (as requested on the columnsNumber formal parameter).
void renderList(MarkupOutput out, WebDisplayUnits list)
This method is deprecated. please use and customize renderList(MarkupOutput) instead since this method will not be called on future releases.
void renderModifiedInfo(MarkupOutput out, WebObjectInfo object)
Write out modified time information for a single object.
void renderNameInfo(MarkupOutput out, WebObjectInfo object)
Write out name information for a single object.
void renderObject(MarkupOutput out, WebObjectInfo object)
Renders the WebObjectInfo object requested according to the specifications of this transform.
void renderOwnerInfo(MarkupOutput out, WebObjectInfo object)
Write out owner information for a single object.
void renderPDFExport(MarkupOutput out, WebObjectInfo object)
Write out information for exporting to PDF a single object, consisting on a text link if the event provided by the getPDFExportEvent(WebObjectInfo) method is available and the user has the required privileges.
void renderSendNowInfo(MarkupOutput out, WebObjectInfo object)
Write out Narrowcast Send Now information for a single object, consisting on a text link if the event provided by the getSendNowEvent(WebObjectInfo) method is available and the user has the required privileges.
void renderSubscriptionInfo(MarkupOutput out, WebObjectInfo object)
Write out subscription information for a single object, consisting on a text link if the event provided by the getSubscriptionsEvent(WebObjectInfo) method is available and the user has the required privileges.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractFolderTransform
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.transform.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Constants

public static final String FP_COLUMNS_NUMBER

Constant specifying the name of the formal parameter for defining the number of columns. Value is columnsNumber.

Constant Value: "columnsNumber"

Fields

public FormalParameter columnsNumber

Indicates the number of columns with information to be used when displaying the contents of the transform.
The value indicates how the HTML table will be generated. By default, the number of columns it will have is 2.

Public Constructors

public FolderIconTransform ()

Default no-argument constructor. Initializes formal parameters.

Public Methods

public String getDescription ()

Return the description for this Transform

Returns
  • String with the description for the transform.

public WebEvent getExportEvent (WebObjectInfo object)

Overwrites the parent method by assigning a target to the event, by default a new window will be opened when exporting.

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

public WebEvent getPDFExportEvent (WebObjectInfo object)

Overwrites the parent method by assigning a target to the event, by default a new window will be opened when exporting to PDF.

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

public void renderDeleteInfo (MarkupOutput out, WebObjectInfo object)

Write out delete information for a single object, consisting on a text link if the event provided by the getDeleteEvent(WebObjectInfo) method is available and the user has the required privileges.

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

public void renderDescriptionInfo (MarkupOutput out, WebObjectInfo object)

Write out description information for a single object.

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

public void renderEditInfo (MarkupOutput out, WebObjectInfo object)

Write out edit information for a single object, consisting on a text link if the event provided by the getEditEvent(WebObjectInfo) method is available and the user has the required privileges.

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

public void renderExport (MarkupOutput out, WebObjectInfo object)

Write out information for exporting a single object, consisting on a text link if the event provided by the getExportEvent(WebObjectInfo) method is available and the user has the required privileges.

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

public void renderIconInfo (MarkupOutput out, WebObjectInfo object)

Write out the image information for a single object. The source of the image is determined by the object type and the image formal parameters the user defined for this transform. The image will be rendered as a link if the event according to the object type, provided by the getEvent(WebObjectInfo) method, is available.

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

public void renderItems (MarkupOutput out)

Renders the contents of the folder as an HTML TABLE with the required rows and columns (as requested on the columnsNumber formal parameter).

Parameters
out MarkupOutput instance where the HTML content to display will be saved.

public void renderList (MarkupOutput out, WebDisplayUnits list)

This method is deprecated.
please use and customize renderList(MarkupOutput) instead since this method will not be called on future releases.

Unless a specific layout has been defined, this method renders the list of objects contained in the folder as an HTML TABLE with the required rows and as many cells as columns indicated by the user on the columnsNumber formal parameter, plus smaller empty columns in between these for separating the contents.

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

public void renderModifiedInfo (MarkupOutput out, WebObjectInfo object)

Write out modified time information for a single object.

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

public void renderNameInfo (MarkupOutput out, WebObjectInfo object)

Write out name information for a single object. The string will be rendered as a link if the event according to the object type, provided by the getEvent(WebObjectInfo) method, is available.

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

public void renderObject (MarkupOutput out, WebObjectInfo object)

Renders the WebObjectInfo object requested according to the specifications of this transform.
The HTML contents generated by this method are inside of up to two HTML TD tags: one for the image and another for the rest of the object information. The levelFlag formal parameters indicate which fields are to be displayed. It is required that the parent TR and TABLE should be opened beforehand. By default, the renderItems(MarkupOutput) method takes care of that.

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

public void renderOwnerInfo (MarkupOutput out, WebObjectInfo object)

Write out owner information for a single object.

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

public void renderPDFExport (MarkupOutput out, WebObjectInfo object)

Write out information for exporting to PDF a single object, consisting on a text link if the event provided by the getPDFExportEvent(WebObjectInfo) method is available and the user has the required privileges.

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

public void renderSendNowInfo (MarkupOutput out, WebObjectInfo object)

Write out Narrowcast Send Now information for a single object, consisting on a text link if the event provided by the getSendNowEvent(WebObjectInfo) method is available and the user has the required privileges.

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

public void renderSubscriptionInfo (MarkupOutput out, WebObjectInfo object)

Write out subscription information for a single object, consisting on a text link if the event provided by the getSubscriptionsEvent(WebObjectInfo) method is available and the user has the required privileges.

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