public class

FolderListTransform

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

This class is deprecated.
Use FolderViewTransform instead

Class Overview

This Transform renders the content of a folder a detailed list of objects. Each object is rendered on it's own row.

Summary

Constants
String FP_FIRST_ARROW_DISABLED_IMAGE This constant is deprecated. No replacement.
String FP_FIRST_ARROW_IMAGE This constant is deprecated. No replacement.
String FP_LAST_ARROW_DISABLED_IMAGE This constant is deprecated. No replacement.
String FP_LAST_ARROW_IMAGE This constant is deprecated. No replacement.
String FP_LEFT_ARROW_DISABLED_IMAGE This constant is deprecated. No replacement.
String FP_LEFT_ARROW_IMAGE This constant is deprecated. No replacement.
String FP_RIGHT_ARROW_DISABLED_IMAGE This constant is deprecated. No replacement.
String FP_RIGHT_ARROW_IMAGE This constant is deprecated. No replacement.
String FP_SELECT_IMAGE Constant specifying the name of the formal parameter for defining the select image.
String FP_TABLE_WIDTH_IN_PIXELS Constant specifying the name of the formal parameter for defining the width in pixels of the table where the folder contents will be displayed.
[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 imgFirstArrow This field is deprecated. No replacement.
public FormalParameter imgFirstArrowDisabled This field is deprecated. No replacement.
public FormalParameter imgLastArrow This field is deprecated. No replacement.
public FormalParameter imgLastArrowDisabled This field is deprecated. No replacement.
public FormalParameter imgLeftArrow This field is deprecated. No replacement.
public FormalParameter imgLeftArrowDisabled This field is deprecated. No replacement.
public FormalParameter imgRightArrow This field is deprecated. No replacement.
public FormalParameter imgRightArrowDisabled This field is deprecated. No replacement.
public FormalParameter selectImage Indicates the image to use when displaying a select box, for options like subscriptions and edit.
public FormalParameter tableWidthInPixels Indicates the width in pixels the table to render with the folder contents will have.
[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
FolderListTransform()
Default no-argument constructor.
Public Methods
String getDescription()
Return description for this Transform.
WebEvent getExportEvent(WebObjectInfo object)
Overwrites the parent method by assigning a target to the event, corresponding to the user preference on where the export result should be displayed
WebEvent getPDFExportEvent(WebObjectInfo object)
Overwrites the parent method by assigning a target to the event, corresponding to the user preference on where the export result should be displayed
void initializeImages()
Initializes the name of the images to use on this transform's output.
void renderDeleteInfo(MarkupOutput out, WebObjectInfo object)
Write out delete information for a single object, as a link based on the event generated by the getDeleteEvent() method and the user privileges, in a form of an image which source is specified by the user in the FP_SELECT_IMAGE formal parameter.
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, as a link based on the event generated by the getEditEvent() method and the user privileges, in a form of an image which source is specified by the user in the FP_SELECT_IMAGE formal parameter.
void renderExport(MarkupOutput out, WebObjectInfo object)
Write out information for exporting a single object, as a link based on the event generated by the getExportEvent() method and the user privileges, in a form of an image which source is specified by the user in the FP_SELECT_IMAGE formal parameter.
void renderHeaders(MarkupOutput out)
Writes the table header for the list view display if they have been requested by the user when specifying the levelFlag formal parameter.
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
void renderList(MarkupOutput out, WebDisplayUnits list, String summary)
Renders the list of objects contained in the folder as an HTML TABLE.
void renderList(MarkupOutput out, WebDisplayUnits list)
This method is deprecated. please note that this method will later on be replaced by using renderList(MarkupOutput) directly, having the list of children to be rendered there will come from the getSortedList() method. Please consider then overwriting the code from renderList(MarkupOutput) instead of from this method.
void renderLocationInfo(MarkupOutput out, WebObjectInfo object)
Write out the location information for a single object, by using the ObjectPathTransform transform, including the ancestors of the specified object.
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)
Write out information for a single object, depending on the levelFlag formal parameter which specifies which details are to be rendered.
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, as a link based on the event generated by the getPDFExportEvent() method and the user privileges, in a form of an image which source is specified by the user in the FP_SELECT_IMAGE formal parameter.
void renderSendNowInfo(MarkupOutput out, WebObjectInfo object)
Write out narrocast send now information for a single object, as a link based on the event generated by the getSendNowEvent() method, in a form of an image which source is specified by the user in the FP_SELECT_IMAGE formal parameter.
void renderSubscriptionInfo(MarkupOutput out, WebObjectInfo object)
Write out subscription information for a single object, as a link based on the event generated by the getSubscriptionsEvent() method and the user privileges, in a form of an image which source is specified by the user in the FP_SELECT_IMAGE formal parameter.
[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_FIRST_ARROW_DISABLED_IMAGE

This constant is deprecated.
No replacement.

Constant specifying the name of the formal parameter for defining the disabled first arrow image. Value is imgFirstArrowDisabled.

Constant Value: "imgFirstArrowDisabled"

public static final String FP_FIRST_ARROW_IMAGE

This constant is deprecated.
No replacement.

Constant specifying the name of the formal parameter for defining the first arrow image. Value is imgFirstArrow.

Constant Value: "imgFirstArrow"

public static final String FP_LAST_ARROW_DISABLED_IMAGE

This constant is deprecated.
No replacement.

Constant specifying the name of the formal parameter for defining the disabled last arrow image. Value is imgLastArrowDisabled.

Constant Value: "imgLastArrowDisabled"

public static final String FP_LAST_ARROW_IMAGE

This constant is deprecated.
No replacement.

Constant specifying the name of the formal parameter for defining the last arrow image. Value is imgLastArrow.

Constant Value: "imgLastArrow"

public static final String FP_LEFT_ARROW_DISABLED_IMAGE

This constant is deprecated.
No replacement.

Constant specifying the name of the formal parameter for defining the disabled left arrow image. Value is imgLeftArrowDisabled.

Constant Value: "imgLeftArrowDisabled"

public static final String FP_LEFT_ARROW_IMAGE

This constant is deprecated.
No replacement.

Constant specifying the name of the formal parameter for defining the left arrow image. Value is imgLeftArrow.

Constant Value: "imgLeftArrow"

public static final String FP_RIGHT_ARROW_DISABLED_IMAGE

This constant is deprecated.
No replacement.

Constant specifying the name of the formal parameter for defining the disabled right arrow image. Value is imgRightArrowDisabled.

Constant Value: "imgRightArrowDisabled"

public static final String FP_RIGHT_ARROW_IMAGE

This constant is deprecated.
No replacement.

Constant specifying the name of the formal parameter for defining the rigth arrow image. Value is imgRightArrow.

Constant Value: "imgRightArrow"

public static final String FP_SELECT_IMAGE

Constant specifying the name of the formal parameter for defining the select image. Value is selectImage.

Constant Value: "selectImage"

public static final String FP_TABLE_WIDTH_IN_PIXELS

Constant specifying the name of the formal parameter for defining the width in pixels of the table where the folder contents will be displayed. Value is tableWidthInPixes.

Constant Value: "tableWidthInPixels"

Fields

public FormalParameter imgFirstArrow

This field is deprecated.
No replacement.

Indicates the image to use when displaying the incremental fetch arrow for going to the first set of pages.
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.

public FormalParameter imgFirstArrowDisabled

This field is deprecated.
No replacement.

Indicates the image to use when displaying the disabled incremental fetch arrow for going to the first set of pages.
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.

public FormalParameter imgLastArrow

This field is deprecated.
No replacement.

Indicates the image to use when displaying the incremental fetch arrow for going to the last set of pages.
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.

public FormalParameter imgLastArrowDisabled

This field is deprecated.
No replacement.

Indicates the image to use when displaying the disabled incremental fetch arrow for going to the last set of pages.
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.

public FormalParameter imgLeftArrow

This field is deprecated.
No replacement.

Indicates the image to use when displaying the incremental fetch arrow for going to the previous set of pages.
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.

public FormalParameter imgLeftArrowDisabled

This field is deprecated.
No replacement.

Indicates the image to use when displaying the disabled incremental fetch arrow for going to the previous set of pages.
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.

public FormalParameter imgRightArrow

This field is deprecated.
No replacement.

Indicates the image to use when displaying the incremental fetch arrow for going to the next set of pages.
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.

public FormalParameter imgRightArrowDisabled

This field is deprecated.
No replacement.

Indicates the image to use when displaying the disabled incremental fetch arrow for going to the next set of pages.
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.

public FormalParameter selectImage

Indicates the image to use when displaying a select box, for options like subscriptions and edit.
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.

public FormalParameter tableWidthInPixels

Indicates the width in pixels the table to render with the folder contents will have.
If no value is specified, or if the default value 0 is assigned, the width will be relative to the context where the table is inserted.

Public Constructors

public FolderListTransform ()

Default no-argument constructor. Initializes formal parameters.

Public Methods

public String getDescription ()

Return 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, corresponding to the user preference on where the export result should be displayed

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, corresponding to the user preference on where the export result should be displayed

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 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 renderDeleteInfo (MarkupOutput out, WebObjectInfo object)

Write out delete information for a single object, as a link based on the event generated by the getDeleteEvent() method and the user privileges, in a form of an image which source is specified by the user in the FP_SELECT_IMAGE formal parameter.
The HTML contents this method generates are inside an HTML TD tag, therefore it is required that the corresponding TABLE and TR parents are opened first. By default, renderList() and renderObject() take care of it.

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.
The HTML contents this method generates are inside an HTML TD tag, therefore it is required that the corresponding TABLE and TR parents are opened first. By default, renderList() and renderObject() take care of it.

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, as a link based on the event generated by the getEditEvent() method and the user privileges, in a form of an image which source is specified by the user in the FP_SELECT_IMAGE formal parameter.
The HTML contents this method generates are inside an HTML TD tag, therefore it is required that the corresponding TABLE and TR parents are opened first. By default, renderList() and renderObject() take care of it.

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, as a link based on the event generated by the getExportEvent() method and the user privileges, in a form of an image which source is specified by the user in the FP_SELECT_IMAGE formal parameter.
The HTML contents this method generates are inside an HTML TD tag, therefore it is required that the corresponding TABLE and TR parents are opened first. By default, renderList() and renderObject() take care of it.

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

public void renderHeaders (MarkupOutput out)

Writes the table header for the list view display if they have been requested by the user when specifying the levelFlag formal parameter. The contents will be inside an HTML TR tag created by this method, and it will add the required cells depending on the headers indicated on the formal parameter.
This method requires an HTML TABLE tag to be opened beforehand. By default, the renderList() method takes care of this.

Parameters
out MarkupOutput instance which includes the HTML for the header of the table to be used on the transform

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() method, is available.
The HTML contents this method generates are inside an HTML TD tag, therefore it is required that the corresponding TABLE and TR parents are opened first. By default, renderList() and renderObject() take care of it.

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

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

public void renderList (MarkupOutput out, WebDisplayUnits list, String summary)

Renders the list of objects contained in the folder as an HTML TABLE. The header and each one of the objects inside the folder will be displayed as a row of the main table.

Parameters
out MarkupOutput instance with the output by this transoform
list WebDisplayUnits list with the objects to render
summary a String with a custom Summary attribute to add to the HTML table to generate

public void renderList (MarkupOutput out, WebDisplayUnits list)

This method is deprecated.
please note that this method will later on be replaced by using renderList(MarkupOutput) directly, having the list of children to be rendered there will come from the getSortedList() method. Please consider then overwriting the code from renderList(MarkupOutput) instead of from this method.

Renders the list of objects contained in the folder as an HTML TABLE. The header and each one of the objects inside the folder will be displayed as a row of the main table.
No Summary attribute will be added to the main table unless the user has selected Accessibility Mode from Preferences, in which case the localized string for This table displays the requested folder contents will be used by default.

Parameters
out MarkupOutput instance with the output by this transform
list WebDisplayUnits list with the objects to render

public void renderLocationInfo (MarkupOutput out, WebObjectInfo object)

Write out the location information for a single object, by using the ObjectPathTransform transform, including the ancestors of the specified object.
The HTML contents this method generates are inside an HTML TD tag, therefore it is required that the corresponding TABLE and TR parents are opened first. By default, renderList() and renderObject() take care of it.

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

public void renderModifiedInfo (MarkupOutput out, WebObjectInfo object)

Write out modified time information for a single object.
The HTML contents this method generates are inside an HTML TD tag, therefore it is required that the corresponding TABLE and TR parents are opened first. By default, renderList() and renderObject() take care of it.

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 HTML contents this method generates are inside an HTML TD tag, therefore it is required that the corresponding TABLE and TR parents are opened first. By default, renderList() and renderObject() take care of it.

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

public void renderObject (MarkupOutput out, WebObjectInfo object)

Write out information for a single object, depending on the levelFlag formal parameter which specifies which details are to be rendered.
This method renders its contents as part of an HTML TR tag, therefore it is required that the parent TABLE is opened first. By default, the renderList() 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.
The HTML contents this method generates are inside an HTML TD tag, therefore it is required that the corresponding TABLE and TR parents are opened first. By default, renderList() and renderObject() take care of it.

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, as a link based on the event generated by the getPDFExportEvent() method and the user privileges, in a form of an image which source is specified by the user in the FP_SELECT_IMAGE formal parameter.
The HTML contents this method generates are inside an HTML TD tag, therefore it is required that the corresponding TABLE and TR parents are opened first. By default, renderList() and renderObject() take care of it.

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 narrocast send now information for a single object, as a link based on the event generated by the getSendNowEvent() method, in a form of an image which source is specified by the user in the FP_SELECT_IMAGE formal parameter.
The HTML contents this method generates are inside an HTML TD tag, therefore it is required that the corresponding TABLE and TR parents are opened first. By default, renderList() and renderObject() take care of it.

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, as a link based on the event generated by the getSubscriptionsEvent() method and the user privileges, in a form of an image which source is specified by the user in the FP_SELECT_IMAGE formal parameter.
The HTML contents this method generates are inside an HTML TD tag, therefore it is required that the corresponding TABLE and TR parents are opened first. By default, renderList() and renderObject() take care of it.

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