public class

ObjectInfoTransform

extends AbstractAppTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.ObjectInfoTransform

Class Overview

This transform renders the list of Narrowcast Subscriptions from a SubscriptionFolderBean.

Summary

Constants
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_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_IMG_DATAMART Constant specifying the name of the formal parameter for defining the datamart report image.
String FP_IMG_DOCUMENT Constant specifying the name of the formal parameter for defining the document image.
String FP_IMG_GRAPH Constant specifying the name of the formal parameter for defining the graph image.
String FP_IMG_GRID Constant specifying the name of the formal parameter for defining the grid report image.
String FP_IMG_GRID_GRAPH Constant specifying the name of the formal parameter for defining the grid-graph report image.
String FP_IMG_RWDOCUMENT Constant specifying the name of the formal parameter for defining the report writing document image.
String FP_LEVEL_FLAG Constant specifying the name of the formal parameter for defining the level flag.
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_DESCRIPTION Allowed value for the levelFlag formal parameter.
int LEVEL_ICON Allowed value for the levelFlag formal parameter.
int LEVEL_MODIFIED Allowed value for the levelFlag formal parameter.
int LEVEL_NAME Allowed value for the levelFlag formal parameter.
int LEVEL_OWNER Allowed value for the levelFlag formal parameter.
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected int _levelFlag Property for holding the value specified to the levelFlag formal parameter
public FormalParameter datamartImage This field is deprecated. The image is now defined by css class name
public FormalParameter documentImage This field is deprecated. The image is now defined by css class name
public FormalParameter filterImage This field is deprecated. The image is now specified by css class name
public FormalParameter folderImage This field is deprecated. The image is now specified by css class name
public FormalParameter graphImage This field is deprecated. The image is now defined by css class name
public FormalParameter gridGraphImage This field is deprecated. The image is now defined by css class name
public FormalParameter gridImage This field is deprecated. The image is now defined by css class name
public FormalParameter imageHeight This field is deprecated. The images are now defined with css class name
public FormalParameter imageWidth This field is deprecated. The images are now defined with css class name.
public FormalParameter levelFlag Indicates the level of information to use when displaying each object.
public FormalParameter rwDocumentImage This field is deprecated. The image is now defined by css class name
public FormalParameter templateImage This field is deprecated. The image is now specified by css class name
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
ObjectInfoTransform()
Default no-arg constructor, initialize formal parameters
Public Methods
String getDescription()
Returns the description to use in the Style catalog.
ObjectBean getObjectBean()
Class getSupportedBeanType()
Returns the supported bean type.
void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.
void renderDescriptionInfo(MarkupOutput out, WebObjectInfo info)
Renders the object's description
void renderDescriptionInfo(MarkupOutput out)
Renders the object's description
void renderIconInfo(MarkupOutput out)
Renders the object's icon
void renderIconInfo(MarkupOutput out, WebObjectInfo info)
Renders the object's icon
void renderLayeredIconInfo(MarkupOutput out)
Renders the object's icon as a layered image
void renderLayeredIconInfo(MarkupOutput out, WebObjectInfo info)
Similar to renderIconInfo(MarkupOutput), but nstead of generating an IMG tag, having a transparent image as its source and a background image assigned via the CSS style, it will now generate a SPAN tag which will have the same css class defined (where the background image is indicated) 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 renderModifiedInfo(MarkupOutput out, WebObjectInfo info)
Renders the object's last modification time.
void renderModifiedInfo(MarkupOutput out)
Renders the object's last modification time.
void renderNameInfo(MarkupOutput out, WebObjectInfo info)
Renders the object's name
void renderNameInfo(MarkupOutput out)
Renders the object's name
void renderObject(MarkupOutput out, WebObjectInfo object)
Renders the ObjectInfo
void renderOwnerInfo(MarkupOutput out, WebObjectInfo info)
Renders the object's owner name.
void renderOwnerInfo(MarkupOutput out)
Renders the object's owner name.
void transformForRequestSuccessful(MarkupOutput out)
Transform when the status is Successful.
Protected Methods
String getCssName(WebObjectInfo object)
Utility method that helps giving the CSS class to use based on the the object type of the WebObjectInfo instance.
[Expand]
Inherited Methods
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.Transform

Constants

public static final String FP_FILTER_IMAGE

Constant specifying the name of the formal parameter for defining the filter image. Value is filterImage.

Constant Value: "filterImage"

public static final String FP_FOLDER_IMAGE

Constant specifying the name of the formal parameter for defining the folder image. Value is folderImage.

Constant Value: "folderImage"

public static final String FP_IMAGE_HEIGTH

Constant specifying the name of the formal parameter for defining the image height. Value is imageHeight.

Constant Value: "imageHeight"

public static final String FP_IMAGE_WIDTH

Constant specifying the name of the formal parameter for defining the image width. Value is imageWidth.

Constant Value: "imageWidth"

public static final String FP_IMG_DATAMART

Constant specifying the name of the formal parameter for defining the datamart report image. Value is datamartImage.

Constant Value: "datamartImage"

public static final String FP_IMG_DOCUMENT

Constant specifying the name of the formal parameter for defining the document image. Value is documentImage.

Constant Value: "documentImage"

public static final String FP_IMG_GRAPH

Constant specifying the name of the formal parameter for defining the graph image. Value is graphImage.

Constant Value: "graphImage"

public static final String FP_IMG_GRID

Constant specifying the name of the formal parameter for defining the grid report image. Value is gridImage.

Constant Value: "gridImage"

public static final String FP_IMG_GRID_GRAPH

Constant specifying the name of the formal parameter for defining the grid-graph report image. Value is gridGraphImage.

Constant Value: "gridGraphImage"

public static final String FP_IMG_RWDOCUMENT

Constant specifying the name of the formal parameter for defining the report writing document image. Value is rwDocumentImage.

Constant Value: "rwDocumentImage"

public static final String FP_LEVEL_FLAG

Constant specifying the name of the formal parameter for defining the level flag. Value is levelFlag.

Constant Value: "levelFlag"

public static final String FP_TEMPLATE_IMAGE

Constant specifying the name of the formal parameter for defining the template image. Value is templateImage.

Constant Value: "templateImage"

public static final int LEVEL_ALL

Allowed value for the levelFlag formal parameter. Convenience flag for selecting all the possible level flag values defined on this class.
Value = LEVEL_ALL

Constant Value: 65535 (0x0000ffff)

public static final int LEVEL_DESCRIPTION

Allowed value for the levelFlag formal parameter. Specifies that the transform will display object's description.
Value = FIELD_DESCRIPTION

Constant Value: 4 (0x00000004)

public static final int LEVEL_ICON

Allowed value for the levelFlag formal parameter. Specifies that the transform will display object's related image icon.
Value = FIELD_ICON

Constant Value: 1 (0x00000001)

public static final int LEVEL_MODIFIED

Allowed value for the levelFlag formal parameter. Specifies that the transform will display object's modification information.
Value = FIELD_MODIFIED

Constant Value: 16 (0x00000010)

public static final int LEVEL_NAME

Allowed value for the levelFlag formal parameter. Specifies that the transform will display object's name.
Value = FIELD_NAME

Constant Value: 2 (0x00000002)

public static final int LEVEL_OWNER

Allowed value for the levelFlag formal parameter. Specifies that the transform will display object's owner information.
Value = FIELD_OWNER

Constant Value: 32 (0x00000020)

Fields

protected int _levelFlag

Property for holding the value specified to the levelFlag formal parameter

public FormalParameter datamartImage

This field is deprecated.
The image is now defined by css class name

Indicates the image to use when displaying a datamart report.
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 documentImage

This field is deprecated.
The image is now defined by css class name

Indicates the image to use when displaying a document.
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 filterImage

This field is deprecated.
The image is now specified by css class name

Indicates the image to use when displaying a filter.
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 folderImage

This field is deprecated.
The image is now specified by css class name

Indicates the image to use when displaying a folder.
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 graphImage

This field is deprecated.
The image is now defined by css class name

Indicates the image to use when displaying a graph.
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 gridGraphImage

This field is deprecated.
The image is now defined by css class name

Indicates the image to use when displaying a grid-graph report.
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 gridImage

This field is deprecated.
The image is now defined by css class name

Indicates the image to use when displaying a grid report.
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 imageHeight

This field is deprecated.
The images are now defined with css class name

Indicates the height of the images to be rendered next to the objects when displayed.
The value indicated will be used for the images of all object types. If the default image formal parameters values are changed, chances are this value will have to be updated as well.

public FormalParameter imageWidth

This field is deprecated.
The images are now defined with css class name.

Indicates the width of the images to be rendered next to the objects when displayed.
The value indicated will be used for the images of all object types. If the default image formal parameters values are changed, chances are this value will have to be updated as well.

public FormalParameter levelFlag

Indicates the level of information to use when displaying each object.
The information may include object name, description and other information. Multiple fields might be rendered at the same time. For indicating which fields to show, the value to assign to this formal parameter should be a bitwise flag combining constants such as LEVEL_NAME, LEVEL_DESCRIPTION, LEVEL_OWNER, etc. For a complete list, refer to ObjectInfoTransform.
Usage: If name, description and owner should be displayed, the value to assign to the formal parameter would be 38 (2 + 4 + 32). Default value is LEVEL_ALL

public FormalParameter rwDocumentImage

This field is deprecated.
The image is now defined by css class name

Indicates the image to use when displaying a report writing document.
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 templateImage

This field is deprecated.
The image is now specified by css class name

Indicates the image to use when displaying a template.
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 Constructors

public ObjectInfoTransform ()

Default no-arg constructor, initialize formal parameters

Public Methods

public String getDescription ()

Returns the description to use in the Style catalog.

Returns
  • Renders the ObjectInfo of an ObjectBean.

public ObjectBean getObjectBean ()

Returns
  • the ObjectBean being transformed.

public Class getSupportedBeanType ()

Returns the supported bean type. This abstract Transform supports all WebComponents

Returns
  • WebComponent.class

public void initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform.

Parameters
data the bean to transform.

public void renderDescriptionInfo (MarkupOutput out, WebObjectInfo info)

Renders the object's description

Parameters
out the transform's output
info the object info

public void renderDescriptionInfo (MarkupOutput out)

Renders the object's description

Parameters
out the transform's output

public void renderIconInfo (MarkupOutput out)

Renders the object's icon

Parameters
out the transform's output

public void renderIconInfo (MarkupOutput out, WebObjectInfo info)

Renders the object's icon

Parameters
out the transform's output
info the object info

public void renderLayeredIconInfo (MarkupOutput out)

Renders the object's icon as a layered image

Parameters
out the transform's output

public void renderLayeredIconInfo (MarkupOutput out, WebObjectInfo info)

Similar to renderIconInfo(MarkupOutput), but nstead of generating an IMG tag, having a transparent image as its source and a background image assigned via the CSS style, it will now generate a SPAN tag which will have the same css class defined (where the background image is indicated) 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 the transform's output
info the object info

public void renderModifiedInfo (MarkupOutput out, WebObjectInfo info)

Renders the object's last modification time.

Parameters
out the transform's output
info the object info

public void renderModifiedInfo (MarkupOutput out)

Renders the object's last modification time.

Parameters
out the transform's output

public void renderNameInfo (MarkupOutput out, WebObjectInfo info)

Renders the object's name

Parameters
out the transform's output
info the object info

public void renderNameInfo (MarkupOutput out)

Renders the object's name

Parameters
out the transform's output

public void renderObject (MarkupOutput out, WebObjectInfo object)

Renders the ObjectInfo

Parameters
out the transform's output
object the object info

public void renderOwnerInfo (MarkupOutput out, WebObjectInfo info)

Renders the object's owner name.

Parameters
out the transform's output
info the object info

public void renderOwnerInfo (MarkupOutput out)

Renders the object's owner name.

Parameters
out the transform's output

public void transformForRequestSuccessful (MarkupOutput out)

Transform when the status is Successful.

Parameters
out output by this transform

Protected Methods

protected String getCssName (WebObjectInfo object)

Utility method that helps giving the CSS class to use based on the the object type of the WebObjectInfo instance.

Parameters
object The WebObjectInfo for which it's image name is required.
Returns
  • a String with the name of the CSS class that should be associated with the WebObjectInfo information to display. If the type specified does not match the predefined list of styles, then it returns an empty string.