public class

FolderSmallIconTransform

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

Class Overview

This class displays the content of a FolderBean as a list of small icons.
The output of this Transform generates well-formed XHTML, and it's designed to use external css files for all formatting.

Summary

Constants
String FP_FOLDER_JS Name for the formal parameter: folderJS
String FP_OBJECT_CLICK_JS Name for the formal parameter: objectClickJS
[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 folderJS Formal parameter: The javascript function to execute when you click on the folder links
public FormalParameter objectClickJS Formal parameter: The javascript function to execute when you click on a folder's subitem
[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
FolderSmallIconTransform()
Default no-argument constructor.
Public Methods
Map getContainerAttributes()
Returns a Map containing any attribute that must be added to the list's container.
String getDescription()
Return the description for this Transform
Map getObjectAttributes(WebObjectInfo object)
Returns a Map object containing the attributes the object's main container will have
void renderLayeredIconInfo(MarkupOutput out, WebObjectInfo object)
generate a SPAN tag which host background image and an inner SPAN for the layering effect in case an additional image has to be included on top of the original (for example, a shortcut arrow, a red error sign, etc).
void renderList(MarkupOutput out, WebDisplayUnits list)
This method is deprecated. please use and customize renderList(MarkupOutput) instead since this method won't be called by future releases.
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: a small icon and the object name's information.
void renderObjectName(MarkupOutput out, WebObjectInfo object)
Renders only the name of the object passed as a parameter
Protected Methods
String getTooltipInfo(WebObjectInfo item)
Returns the tooltip to add to each individual item in the Folder's list.
void postAnchorGenerated(AnchorTag anchor)
void setObjectClickJS(HashMap __result, WebObjectInfo object)
Set the onclick Js event
[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_FOLDER_JS

Name for the formal parameter: folderJS

Constant Value: "folderJS"

public static final String FP_OBJECT_CLICK_JS

Name for the formal parameter: objectClickJS

Constant Value: "objectClickJS"

Fields

public FormalParameter folderJS

Formal parameter: The javascript function to execute when you click on the folder links

public FormalParameter objectClickJS

Formal parameter: The javascript function to execute when you click on a folder's subitem

Public Constructors

public FolderSmallIconTransform ()

Default no-argument constructor. Initializes formal parameters.

Public Methods

public Map getContainerAttributes ()

Returns a Map containing any attribute that must be added to the list's container.

Returns
  • Map key-value pairs of attributes.

public String getDescription ()

Return the description for this Transform

Returns
  • String with the description for the transform.

public Map getObjectAttributes (WebObjectInfo object)

Returns a Map object containing the attributes the object's main container will have

Parameters
object WebObjectInfo to be rendered.
Returns
  • Map

public void renderLayeredIconInfo (MarkupOutput out, WebObjectInfo object)

generate a SPAN tag which host background image and an inner SPAN for the layering effect in case an additional image has to be included on top of the original (for example, a shortcut arrow, a red error sign, etc).

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

public void renderList (MarkupOutput out, WebDisplayUnits list)

This method is deprecated.
please use and customize renderList(MarkupOutput) instead since this method won't be called by future releases.

Renders the list of objects contained in the folder as a list with small icons.

Parameters
out MarkupOutput instance where the HTML output is to be saved.
list WebDisplayUnits instance with the list of objects that will be rendered by this transform, as contents of the folder being analyzed.

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: a small icon and the object name's information.

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

public void renderObjectName (MarkupOutput out, WebObjectInfo object)

Renders only the name of the object passed as a parameter

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

Protected Methods

protected String getTooltipInfo (WebObjectInfo item)

Returns the tooltip to add to each individual item in the Folder's list.

Parameters
item WebObjectInfo the folder's child.
Returns
  • String the tooltip to add to the HTML output.

protected void postAnchorGenerated (AnchorTag anchor)

protected void setObjectClickJS (HashMap __result, WebObjectInfo object)

Set the onclick Js event