Package com.microstrategy.web.app.transforms

Class ObjectInfoTransform

  • All Implemented Interfaces:
    AppTransform, Transform
    public class ObjectInfoTransform
extends AbstractAppTransform
    This transform renders the list of Narrowcast Subscriptions from a SubscriptionFolderBean.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Field Detail

      • LEVEL_ALL

        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 = ObjectInfoWidget.LEVEL_ALL
        See Also:
        Constant Field Values

      • graphImage

        @Deprecated
public FormalParameter graphImage
        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.

      • gridImage

        @Deprecated
public FormalParameter gridImage
        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.

      • datamartImage

        @Deprecated
public FormalParameter datamartImage
        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.
        Since:
        MicroStrategy Web 7.5.0

      • gridGraphImage

        @Deprecated
public FormalParameter gridGraphImage
        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.

      • documentImage

        @Deprecated
public FormalParameter documentImage
        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.

      • rwDocumentImage

        @Deprecated
public FormalParameter rwDocumentImage
        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.
        Since:
        MicroStrategy Web 7.5.0

      • folderImage

        @Deprecated
public FormalParameter folderImage
        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.

      • filterImage

        @Deprecated
public FormalParameter filterImage
        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.

      • templateImage

        @Deprecated
public FormalParameter templateImage
        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.

      • imageWidth

        @Deprecated
public FormalParameter imageWidth
        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.

      • imageHeight

        @Deprecated
public FormalParameter imageHeight
        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.

      • levelFlag

        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

      • _levelFlag

        protected int _levelFlag
        Property for holding the value specified to the levelFlag formal parameter

      • FP_FOLDER_IMAGE

        public static final java.lang.String FP_FOLDER_IMAGE
        Constant specifying the name of the formal parameter for defining the folder image. Value is folderImage.
        See Also:
        Constant Field Values

      • FP_IMG_GRAPH

        public static final java.lang.String FP_IMG_GRAPH
        Constant specifying the name of the formal parameter for defining the graph image. Value is graphImage.
        See Also:
        Constant Field Values

      • FP_IMG_GRID

        public static final java.lang.String FP_IMG_GRID
        Constant specifying the name of the formal parameter for defining the grid report image. Value is gridImage.
        See Also:
        Constant Field Values

      • FP_IMG_DATAMART

        public static final java.lang.String FP_IMG_DATAMART
        Constant specifying the name of the formal parameter for defining the datamart report image. Value is datamartImage.
        Since:
        MicroStrategy Web 7.5.0
        See Also:
        Constant Field Values

      • FP_IMG_GRID_GRAPH

        public static final java.lang.String FP_IMG_GRID_GRAPH
        Constant specifying the name of the formal parameter for defining the grid-graph report image. Value is gridGraphImage.
        See Also:
        Constant Field Values

      • FP_IMG_DOCUMENT

        public static final java.lang.String FP_IMG_DOCUMENT
        Constant specifying the name of the formal parameter for defining the document image. Value is documentImage.
        See Also:
        Constant Field Values

      • FP_IMG_RWDOCUMENT

        public static final java.lang.String FP_IMG_RWDOCUMENT
        Constant specifying the name of the formal parameter for defining the report writing document image. Value is rwDocumentImage.
        Since:
        MicroStrategy Web 7.5.0
        See Also:
        Constant Field Values

      • FP_FILTER_IMAGE

        public static final java.lang.String FP_FILTER_IMAGE
        Constant specifying the name of the formal parameter for defining the filter image. Value is filterImage.
        See Also:
        Constant Field Values

      • FP_TEMPLATE_IMAGE

        public static final java.lang.String FP_TEMPLATE_IMAGE
        Constant specifying the name of the formal parameter for defining the template image. Value is templateImage.
        See Also:
        Constant Field Values

      • FP_IMAGE_WIDTH

        public static final java.lang.String FP_IMAGE_WIDTH
        Constant specifying the name of the formal parameter for defining the image width. Value is imageWidth.
        See Also:
        Constant Field Values

      • FP_IMAGE_HEIGTH

        public static final java.lang.String FP_IMAGE_HEIGTH
        Constant specifying the name of the formal parameter for defining the image height. Value is imageHeight.
        See Also:
        Constant Field Values

      • FP_LEVEL_FLAG

        public static final java.lang.String FP_LEVEL_FLAG
        Constant specifying the name of the formal parameter for defining the level flag. Value is levelFlag.
        See Also:
        Constant Field Values

    • Constructor Detail

      • ObjectInfoTransform

        public ObjectInfoTransform()
        Default no-arg constructor, initialize formal parameters

    • Method Detail

      • getDescription

        public java.lang.String getDescription()
        Returns the description to use in the Style catalog.
        Returns:
        Renders the ObjectInfo of an ObjectBean.

      • getCssName

        protected java.lang.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.
        Since:
        MicroStrategy Web 8.0.0

      • renderObject

        public void renderObject​(MarkupOutput out,
                         WebObjectInfo object)
        Renders the ObjectInfo
        Parameters:
        out - the transform's output
        object - the object info

      • renderIconInfo

        public void renderIconInfo​(MarkupOutput out)
        Renders the object's icon
        Parameters:
        out - the transform's output
        Since:
        MicroStrategy Web 8.0.0

      • renderLayeredIconInfo

        public void renderLayeredIconInfo​(MarkupOutput out)
        Renders the object's icon as a layered image
        Parameters:
        out - the transform's output
        Since:
        MicroStrategy Web 9.0.0

      • renderIconInfo

        public void renderIconInfo​(MarkupOutput out,
                           WebObjectInfo info)
        Renders the object's icon
        Parameters:
        out - the transform's output
        info - the object info

      • renderLayeredIconInfo

        public void renderLayeredIconInfo​(MarkupOutput out,
                                  WebObjectInfo info)
        Similar to renderIconInfo(com.microstrategy.web.beans.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
        Since:
        MicroStrategy Web 9.0.0

      • renderNameInfo

        public void renderNameInfo​(MarkupOutput out)
        Renders the object's name
        Parameters:
        out - the transform's output
        Since:
        MicroStrategy Web 8.0.0

      • renderNameInfo

        public void renderNameInfo​(MarkupOutput out,
                           WebObjectInfo info)
        Renders the object's name
        Parameters:
        out - the transform's output
        info - the object info

      • renderDescriptionInfo

        public void renderDescriptionInfo​(MarkupOutput out)
        Renders the object's description
        Parameters:
        out - the transform's output
        Since:
        MicroStrategy Web 8.0.0

      • renderDescriptionInfo

        public void renderDescriptionInfo​(MarkupOutput out,
                                  WebObjectInfo info)
        Renders the object's description
        Parameters:
        out - the transform's output
        info - the object info

      • renderOwnerInfo

        public void renderOwnerInfo​(MarkupOutput out)
        Renders the object's owner name.
        Parameters:
        out - the transform's output
        Since:
        MicroStrategy Web 8.0.0

      • renderOwnerInfo

        public void renderOwnerInfo​(MarkupOutput out,
                            WebObjectInfo info)
        Renders the object's owner name.
        Parameters:
        out - the transform's output
        info - the object info

      • renderModifiedInfo

        public void renderModifiedInfo​(MarkupOutput out)
        Renders the object's last modification time.
        Parameters:
        out - the transform's output
        Since:
        MicroStrategy Web 8.0.0

      • renderModifiedInfo

        public void renderModifiedInfo​(MarkupOutput out,
                               WebObjectInfo info)
        Renders the object's last modification time.
        Parameters:
        out - the transform's output
        info - the object info

      • getObjectBean

        public ObjectBean getObjectBean()
        Returns:
        the ObjectBean being transformed.