public class

FolderBulletTransform

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

Class Overview

This class renders the folders content as a bulleted list

Summary

Constants
String FP_APPEND_BEAN_STATE Constant specifying the name of the formal parameter for defining if the state of the beans should be appended or not.
String FP_BULLET_IMAGE Constant specifying the name of the formal parameter for defining the image to be used as bullet.
String FP_BULLET_STYLE Indicates whether to use layered icon or regular bullet image for bullet item.
[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 appendBeanState Indicates if the state of all the beans should be appended to the links to generate or not.
public FormalParameter bulletImage Indicates the image to be used as bullet before every item displayed.
public FormalParameter useLayeredIcon Indicates whether to use layered icon or regular bullet image for bullet item.
[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
FolderBulletTransform()
Default no-argument constructor.
Public Methods
String getDescription()
Returns this transform's description
void renderBulletList(MarkupOutput out)
This method is deprecated. please use renderList(MarkupOutput) instead. The list of children to be rendered there will come from the getSortedList() method.
void renderBulletList(MarkupOutput out, WebDisplayUnits list)
This method is deprecated. please use renderList(MarkupOutput) instead. The list of children to be rendered there can be obtained from the getSortedList() method.
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 renderObject(MarkupOutput out, WebObjectInfo object)
Renders the WebObjectInfo object requested according to the specifications of this transform.
Protected Methods
AnchorTag generateAnchor(WebEvent event)
Overwrites parent method by removing the children state according to the formal parameter values for the transform
boolean isObjectVisible(WebObjectInfo object)
Utility method that checks if the object should be displayed or not, based on the information provided on the maxObjectTypeCount formal parameter and the current number of objects of that type that have been rendered already
[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_APPEND_BEAN_STATE

Constant specifying the name of the formal parameter for defining if the state of the beans should be appended or not. Value is appendBeanState.

Constant Value: "appendBeanState"

public static final String FP_BULLET_IMAGE

Constant specifying the name of the formal parameter for defining the image to be used as bullet. Value is bulletImage.

Constant Value: "bulletImage"

public static final String FP_BULLET_STYLE

Indicates whether to use layered icon or regular bullet image for bullet item. Value is useLayeredIcon.

Constant Value: "useLayeredIcon"

Fields

public FormalParameter appendBeanState

Indicates if the state of all the beans should be appended to the links to generate or not.

public FormalParameter bulletImage

Indicates the image to be used as bullet before every item displayed.
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 useLayeredIcon

Indicates whether to use layered icon or regular bullet image for bullet item.

Public Constructors

public FolderBulletTransform ()

Default no-argument constructor. Initializes formal parameters.

Public Methods

public String getDescription ()

Returns this transform's description

Returns
  • String with the description for the transform

public void renderBulletList (MarkupOutput out)

This method is deprecated.
please use renderList(MarkupOutput) instead. The list of children to be rendered there will come from the getSortedList() method.

Renders the folder contents as a list with bullets. Obtains the list of children to display from the getSortedChildUnits() method.

Parameters
out MarkupOutput instance to modify with the transform's output. be rendered by this transform, as contents of the folder being analyzed.
Throws
WebBeanException if an error happens while obtaining the output of this transform
WebObjectsException if an error happens while obtaining the output of this transform

public void renderBulletList (MarkupOutput out, WebDisplayUnits list)

This method is deprecated.
please use renderList(MarkupOutput) instead. The list of children to be rendered there can be obtained from the getSortedList() method.

Renders the folder contents as a list with bullets.

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 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 folder contents when it does have children.

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 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 a TR tag, where one of its cells is used for rendering the image specified on the bulletImage formal parameter, and another cell for displaying the object's name. It is required that the parent TABLE tag is already opened. By default, the renderList() takes care of it.

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

Protected Methods

protected AnchorTag generateAnchor (WebEvent event)

Overwrites parent method by removing the children state according to the formal parameter values for the transform

Parameters
event WebEvent instance with the information to include on the link
Returns
  • AnchorTag instance for the HTML anchor generated.

protected boolean isObjectVisible (WebObjectInfo object)

Utility method that checks if the object should be displayed or not, based on the information provided on the maxObjectTypeCount formal parameter and the current number of objects of that type that have been rendered already

Parameters
object WebObjectInfo with the object to check for.
Returns
  • True if the object should be displayed, otherwise returns False