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

FolderSaveAsTransform, FolderSummaryTransform

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

String	FP_CREATE_REPORT_DISPLAY_SECTION	Constant specifying the name of the formal parameter for defining which sections will be displayed in the Create Report page.
String	FP_DATAMART_IMAGE	Constant specifying the name of the formal parameter for defining the datamart image.
String	FP_DOCUMENT_IMAGE	Constant specifying the name of the formal parameter for defining the document image.
String	FP_EXEC_TARGET	Determines how the user want's to execute the Report/Document object.
String	FP_FILTER_IMAGE	Constant specifying the name of the formal parameter for defining the filter image.
String	FP_FOLDER_IMAGE	Constant specifying the name of the formal parameter for defining the folder image.
String	FP_GRAPH_IMAGE	Constant specifying the name of the formal parameter for defining the graph image.
String	FP_GRID_GRAPH_IMAGE	Constant specifying the name of the formal parameter for defining the gridGraph image.
String	FP_IMAGE_HEIGTH	Constant specifying the name of the formal parameter for defining the image height.
String	FP_IMAGE_WIDTH	Constant specifying the name of the formal parameter for defining the image width.
String	FP_LEVEL_FLAG	Constant specifying the name of the formal parameter for defining the level flag.
String	FP_MAX_OBJECT_TYPE_COUNT	Constant specifying the name of the formal parameter for defining the maximum object type count.
String	FP_REPORT_IMAGE	Constant specifying the name of the formal parameter for defining the report image.
String	FP_RW_DOCUMENT_IMAGE	Constant specifying the name of the formal parameter for defining the report writing document image.
String	FP_SORT_ASCENDING	Constant specifying the name of the formal parameter for defining the sort order of the folder contents.
String	FP_SORT_FIELD	Constant specifying the name of the formal parameter for defining the field from which the folder contents will be sorted.
String	FP_TABLE_ID	Constant specifying the name of the formal parameter for defining the table ID and NAME attributes of the HTML table to render.
String	FP_TEMPLATE_IMAGE	Constant specifying the name of the formal parameter for defining the template image.
int	LEVEL_ALL	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_CONFIRM_DELETE	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_DELETE	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_DESCRIPTION	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_DISPLAY_HEADERS	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_EDIT	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_EMPTY_FOLDER_MESSAGE	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_EXPORT_EXCEL	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_EXPORT_PDF	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_FOLDER_INFORMATION	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_INCREMENTAL_FETCH	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_LOCATION	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_MODIFIED	Allowed value for the {@link #leveimport com.microstrategy.web.objects.rw.; import com.microstrategy.web.tags.; import com.microstrategy.web.transform.*; er.
int	LEVEL_NAME	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_OWNER	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_SEND_NOW	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_SUBSCRIPTION	Allowed value for the `levelFlag` formal parameter.

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

protected final String	CLASS_INPUT	This field is deprecated. This property is not used anymore by the transform.
protected final String	CLASS_MESSAGE	This field is deprecated. This property is not used anymore by the transform.
protected WebComponent	_bean	Instance of `WebComponent` being transformed.
protected ComponentBlock	_componentBlock
protected String	_cssPrefix	Property corresponding to the value of the `cssPrefix` formal parameter
protected String	_imgBlank	Field that containts the URL location of a blank image (used as the source of most <IMG> tags as the real URL is specified through css).
protected String	_imgWait	This field is deprecated. This value is not used anymore by the Transform as the wait image is included using css.
protected MarkupOutput	_selfOutput	This field is deprecated. this field is no longer used since partial update blocks are now generated via `ComponentBlock`
protected MarkupOutput	_subOutput	This field is deprecated. this field is no longer used since partial update blocks are now generated via `ComponentBlock`
public FormalParameter	appliesTo	This parameter informs the javascript the id of the bone the actions of this component applies to.
public FormalParameter	contextMenus	This formal parameter is used by the Transform to identify the context-menus definition.
public FormalParameter	cssFile	CSS file that includes the style definition.
public FormalParameter	cssPrefix	Prefix to append to all css class names.
public FormalParameter	debugErrorFlags	Indicates which extra debug information to include in case of an error.
public FormalParameter	debugFlags	Indicates which debug information to include.
public FormalParameter	dragMode	Indicates the drag mode that the component to render will have.
public FormalParameter	extraInput	Indicates any extra inputs to be included in the forms generated by the transform.
public FormalParameter	extraUrl	Indicates any extra parameters to be included in the links generated by the transform.
public FormalParameter	globalCssErrorMessage	This field is deprecated. The css class to use cannot be controlled through a formal parameter anymore.
public FormalParameter	globalCssErrorTitle	This field is deprecated. The css class to use cannot be controlled through a formal parameter anymore.
public FormalParameter	height	Indicates the default height of the component.
public FormalParameter	iframeEnabled	Indicates whether the transform supports iframe manipulations.
public FormalParameter	imgWait	This field is deprecated. This value is not used anymore by the Transform as the wait image is included using css.
protected int	indent	This field is deprecated. Indentation is not appended by Transforms anymore. Although it provided a somewhat better looking HTML source, it also affected performance by increasing the HTML size.
public FormalParameter	initialIndent	This field is deprecated. Indentation is not appended by Transforms anymore. Although it provided a somewhat better looking HTML source, it also affected performance by increasing the HTML size.
protected boolean	isDHTML	This field is deprecated. Use `isDhtml()`.
public FormalParameter	orientation	Indicates the orientation the dialog to render will have.
public FormalParameter	orientationsAllowed	Indicates the orientation modes allowed for the dialog to render.
public FormalParameter	partialIframeUpdate	This formal parameter specifies whether we should replace the whole contentst of the div shell (outerHTML) or the just the inner contents (innerHTML) of that shell div for the transform when the iframe update is going on.
public FormalParameter	processingButtonsFlags	Indicates which buttons to include on the wait page.
public FormalParameter	processingInfoFlags	Indicates which information to include on the wait page.
public FormalParameter	resizeLevel	Indicates whether the component can be resized vertically/horizontally or both or none.
public FormalParameter	scriptClass	Holds the name of the javaScript class (if any) to be associated with the component.
protected static final ScriptVariableJSONEncoder	scriptEndTagEncoder	reference to encoder that deals with tag encoding
public FormalParameter	type	This parameter is used when the output of this Transform generates a corresponding Microstrategy bone in the page, and it informs the javascript the type of bone it is.
public FormalParameter	useDHTML	Indicates whether to use DHTML on the output.
public FormalParameter	width	Indicates the default width of the component.

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

void	addFormalParam(FormalParameterImpl formal) This method is used to add a `FormalParameterImpl` object to the transform.
boolean	canTransform(Transformable data) Checks that the transform supports specified data object and that object is in the state supported by this transform.
static List<Integer>	getEvents(RequestKeys rkeys) Determines event(s) triggered from the request keys.
FormalParameters	getFormalParams() Returns the collection of formal parameters associated with this transform.
String	getID() Returns the unique name of the component to be used as the ID for its shell
MarkupOutput	getPreview() Produces a preview output for this transform.
boolean	isPreviewAvailable() Returns true if this transform supports preview functionality, false otherwise.
boolean	isResolved() Returns whether each required formal parameter has a value associated with it.
FormalParameterImpl	removeFormalParam(String name) Removes the formal parameter with the given name from the formal parameters collection.
void	setAnnotation(FormalParameter fp, FormalParameterAnnotation fpa) Used for internal housekeeping.
void	setDeprecated(FormalParameter fp, String desc) Used for internal housekeeping.
boolean	supports(Class type) Returns true if the transform supports objects of specified type.
boolean	supports(Transformable data) Returns true if the transform supports the specified data object.

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

abstract boolean	canTransform(Transformable data) Checks that the transform supports specified data object and that object is in the state supported by this transform.
abstract String	getDescription() Returns a textual description of the transform.
abstract FormalParameters	getFormalParams() Returns the collection of formal parameters associated with this transform.
abstract String	getID() Returns the unique name of the component to be used as the ID for its shell
abstract MarkupOutput	getPreview() This method is deprecated. This feature is not used
abstract Class	getSupportedBeanType() Returns a root class/interface supported by this transform.
abstract boolean	isPreviewAvailable() This method is deprecated. This feature is not used
abstract boolean	isResolved() Returns whether each required formal parameter has a value associated with it.
abstract boolean	supports(Class beanClass) Returns true if the transform supports objects of specified type.
abstract boolean	supports(Transformable data) Returns true if the transform supports the specified data object.
abstract void	transform(Transformable data, MarkupOutput transOut) Transforms the data object and appends result to the transOut.

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.

Interfaces

Classes

FolderIconTransform

Class Overview

Summary

Constants

public static final String FP_COLUMNS_NUMBER

Fields

public FormalParameter columnsNumber

Public Constructors

public FolderIconTransform ()

Public Methods

public String getDescription ()

Returns

public WebEvent getExportEvent (WebObjectInfo object)

Parameters

Returns

public WebEvent getPDFExportEvent (WebObjectInfo object)

Parameters

Returns

public void renderDeleteInfo (MarkupOutput out, WebObjectInfo object)

Parameters

public void renderDescriptionInfo (MarkupOutput out, WebObjectInfo object)

Parameters

public void renderEditInfo (MarkupOutput out, WebObjectInfo object)

Parameters

public void renderExport (MarkupOutput out, WebObjectInfo object)

Parameters

public void renderIconInfo (MarkupOutput out, WebObjectInfo object)

Parameters

public void renderItems (MarkupOutput out)

Parameters

public void renderList (MarkupOutput out, WebDisplayUnits list)

Parameters

public void renderModifiedInfo (MarkupOutput out, WebObjectInfo object)

Parameters

public void renderNameInfo (MarkupOutput out, WebObjectInfo object)

Parameters

public void renderObject (MarkupOutput out, WebObjectInfo object)

Parameters

public void renderOwnerInfo (MarkupOutput out, WebObjectInfo object)

Parameters

public void renderPDFExport (MarkupOutput out, WebObjectInfo object)

Parameters

public void renderSendNowInfo (MarkupOutput out, WebObjectInfo object)

Parameters

public void renderSubscriptionInfo (MarkupOutput out, WebObjectInfo object)

Parameters