Package com.microstrategy.web.app.transforms

Class AbstractFolderTransform

    • Field Detail

      • LEVEL_NAME

        public static final int LEVEL_NAME
        Allowed value for the levelFlag formal parameter. Specifies that the folder transform will display object's name.
        Value = 1
        See Also:
        Constant Field Values

      • LEVEL_DESCRIPTION

        public static final int LEVEL_DESCRIPTION
        Allowed value for the levelFlag formal parameter. Specifies that the folder transform will display object's description.
        Value = 2
        See Also:
        Constant Field Values

      • LEVEL_OWNER

        public static final int LEVEL_OWNER
        Allowed value for the levelFlag formal parameter. Specifies that the folder transform will display object's owner.
        Value = 4
        See Also:
        Constant Field Values

      • LEVEL_MODIFIED

        public static final int LEVEL_MODIFIED
        Allowed value for the com.microstrategy.web.objects.rw.*; import com.microstrategy.web.tags.*; import com.microstrategy.web.transform.*; er. Specifies that the folder transform will display object's modified time.
        Value = 8
        See Also:
        Constant Field Values

      • LEVEL_DELETE

        public static final int LEVEL_DELETE
        Allowed value for the levelFlag formal parameter. Specifies that the folder transform will display a link for deleting the object.
        Value = 16
        See Also:
        Constant Field Values

      • LEVEL_SUBSCRIPTION

        public static final int LEVEL_SUBSCRIPTION
        Allowed value for the levelFlag formal parameter. Specifies that the folder transform will display the link for creating subscriptions to the object.
        Value = 32
        See Also:
        Constant Field Values

      • LEVEL_EDIT

        public static final int LEVEL_EDIT
        Allowed value for the levelFlag formal parameter. Specifies that the folder transform will display the link for editing the object.
        Value = 64
        See Also:
        Constant Field Values

      • LEVEL_LOCATION

        public static final int LEVEL_LOCATION
        Allowed value for the levelFlag formal parameter. Specifies that the folder transform will display the object's location (folder path).
        Value = 128
        See Also:
        Constant Field Values

      • LEVEL_EMPTY_FOLDER_MESSAGE

        public static final int LEVEL_EMPTY_FOLDER_MESSAGE
        Allowed value for the levelFlag formal parameter. Specifies that if the folder is empty, a message should be displayed about it
        Value = 256
        See Also:
        Constant Field Values

      • LEVEL_CONFIRM_DELETE

        public static final int LEVEL_CONFIRM_DELETE
        Allowed value for the levelFlag formal parameter. Specifies whether the delete link should use a confirm delete event, or the delete event directly
        Value = 512
        See Also:
        Constant Field Values

      • LEVEL_INCREMENTAL_FETCH

        public static final int LEVEL_INCREMENTAL_FETCH
        Allowed value for the levelFlag formal parameter. Specifies that the folder transform includes incremental fetch arrows
        Value = 4096
        See Also:
        Constant Field Values

      • LEVEL_SEND_NOW

        public static final int LEVEL_SEND_NOW
        Allowed value for the levelFlag formal parameter. Specifies that the folder transform will display the link for performing Narrowcast Send Now action on the object.
        Value = 8192
        See Also:
        Constant Field Values

      • LEVEL_EXPORT_PDF

        public static final int LEVEL_EXPORT_PDF
        Allowed value for the levelFlag formal parameter. Specifies that the folder transform will display the link for performing PDF exporting action on the object.
        Value = 16384
        See Also:
        Constant Field Values

      • LEVEL_EXPORT_EXCEL

        public static final int LEVEL_EXPORT_EXCEL
        Allowed value for the levelFlag formal parameter. Specifies that the folder transform will display the link for performing Excel exporting action on the object.
        Value = 32768
        See Also:
        Constant Field Values

      • LEVEL_DISPLAY_HEADERS

        public static final int LEVEL_DISPLAY_HEADERS
        Allowed value for the levelFlag formal parameter. Specifies that the folder transform will display its header before rendering the different columns with information about the contents of the folder. If the transform does not include a header, then this flag has no effect on the final result. Value = 65536
        See Also:
        Constant Field Values

      • LEVEL_FOLDER_INFORMATION

        public static final int LEVEL_FOLDER_INFORMATION
        Allowed value for the levelFlag formal parameter. Specifies that the folder information (such as its description) will be displayed. Value = 131072
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • LEVEL_ALL

        public static final int LEVEL_ALL
        Allowed value for the levelFlag formal parameter. Convenience flag that includes all possible LEVEL values.
        Value = 16777215
        See Also:
        Constant Field Values

      • levelFlag

        public FormalParameter levelFlag
        Indicates the level of information to use when displaying each folder item.
        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 AbstractFolderTransform.
        Please note that if a layout XML definition is being used for rendering the transform's output, the levelFlag formal parameter value will be ignored. Usage: If name, description and owner should be displayed, the value to assign to the formal parameter would be 7 (1 + 2 + 4). Default value is LEVEL_ALL

      • maxObjectTypeCount

        public FormalParameter maxObjectTypeCount
        Indicates any object count limit based on the object type.
        With this formal parameter, it can be specified how many objects of which types will be displayed with this transform. The value to assign should have the following format: objectType1:objectCount1;objectType2:objectCount2 where objectType is the numeric type of the object (EnumDSSXMLObjectTypes), and objectCount is how many of these objects will be displayed.
        Usage: If only up to five reports should be displayed, the value to assign to the formal parameter would be "3:5;-1:0", where 3 is the numberic object type for reports (EnumDSSXMLObjectTypes.DssXmlTypeReportDefinition) and 5 indicates how many should be displayed as maximum. If a limit wants to be defined for all objects, regardless of their type, -1 can be used as object type, On the example it's value is zero, so it indicates no other types will be considered but Report Definition, For unlimited display, "-1" can be used as object count. By default no limit is set to any object type.

      • folderImage

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

      • graphImage

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

      • gridGraphImage

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

      • reportImage

        public FormalParameter reportImage
        Indicates the image to use when displaying a 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

        public FormalParameter datamartImage
        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.

      • documentImage

        public FormalParameter documentImage
        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

        public FormalParameter rwDocumentImage
        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

      • filterImage

        public FormalParameter filterImage
        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

        public FormalParameter templateImage
        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

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

      • _imgWidth

        protected int _imgWidth
        Property for holding the value specified to the imgWidth formal parameter

      • imageHeight

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

      • _imgHeight

        protected int _imgHeight
        Property for holding the value specified to the imgHeight formal parameter

      • tableId

        public FormalParameter tableId
        Indicates the identifier to use when building up the HTML table to be rendered with the contents of the folder. By default, the string to use for the ID and NAME attributes of the <TABLE> HTML tag is empty.

      • sortAscending

        public FormalParameter sortAscending
        Indicates the order to use while sorting the folder contents.
        By default, the value of this parameter is true, which means that the folder contents will be sorted ascending.
        Since:
        MicroStrategy Web 7.5.0

      • execTarget

        public FormalParameter execTarget
        Determines how the user want's to execute the Report/Document object. If set to "_blank" it will open a new window, if empty the link will be executed in the same window.

      • 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

      • FP_MAX_OBJECT_TYPE_COUNT

        public static final java.lang.String FP_MAX_OBJECT_TYPE_COUNT
        Constant specifying the name of the formal parameter for defining the maximum object type count. Value is maxObjectTypeCount.
        See Also:
        Constant Field Values

      • FP_TABLE_ID

        public static final java.lang.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. Value is tableId.
        See Also:
        Constant Field Values

      • 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_GRAPH_IMAGE

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

      • FP_GRID_GRAPH_IMAGE

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

      • FP_REPORT_IMAGE

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

      • FP_DATAMART_IMAGE

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

      • FP_DOCUMENT_IMAGE

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

      • FP_RW_DOCUMENT_IMAGE

        public static final java.lang.String FP_RW_DOCUMENT_IMAGE
        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_SORT_ASCENDING

        public static final java.lang.String FP_SORT_ASCENDING
        Constant specifying the name of the formal parameter for defining the sort order of the folder contents. Value is sortAscending.
        Since:
        MicroStrategy Web 7.5.0
        See Also:
        Constant Field Values

      • FP_SORT_FIELD

        public static final java.lang.String FP_SORT_FIELD
        Constant specifying the name of the formal parameter for defining the field from which the folder contents will be sorted. Value is sortField.
        Since:
        MicroStrategy Web 7.5.0
        See Also:
        Constant Field Values

      • FP_CREATE_REPORT_DISPLAY_SECTION

        public static final java.lang.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. Value is displaySection.
        Since:
        MicroStrategy Web 7.5.1
        See Also:
        Constant Field Values

      • FP_EXEC_TARGET

        public static final java.lang.String FP_EXEC_TARGET
        Determines how the user want's to execute the Report/Document object. If set to "_blank" it will open a new window, if empty the link will be executed in the same window.
        See Also:
        Constant Field Values

      • _sortedChildUnits

        protected WebDisplayUnits _sortedChildUnits
        Since:
        MicroStrategy Web 8.0.1

      • _bandingIndex

        protected int _bandingIndex
        Since:
        MicroStrategy Web 9.0.0

    • Constructor Detail

      • AbstractFolderTransform

        public AbstractFolderTransform()
        Default no-argument constructor. Initializes formal parameters.

    • Method Detail

      • initializeImages

        public void initializeImages()
        Initializes the name of the images to use on this transform's output. For each one of the images defined to be displayed, the resource folder information is added to its path and file name as specified on the formal parameters for the images.
        Overrides:
        initializeImages in class AbstractObjectInfoListTransform

      • initializeCss

        public void initializeCss()
        Initializes the Css classes to use. For each one of the css classes to use, the prefix indicated on the formal parameter is added to the name of the class to use.
        Overrides:
        initializeCss in class AbstractAppTransform

      • isFeatureAvailable

        public boolean isFeatureAvailable​(java.lang.String feature)
        Extends isFeatureAvailable by maintaining a cache of the features to use. Since we ask for the same feature for all objects, it's faster to keep it on a cache than calculate it each time.
        Overrides:
        isFeatureAvailable in class AbstractAppTransform
        Parameters:
        feature - the feature to check for.
        Returns:
        True if the feature is available, otherwise returns False.

      • getSortedList

        public java.util.List getSortedList()
        Specified by:
        getSortedList in class AbstractObjectInfoListTransform
        Returns:
        a List instance with all the elements from the bean to be rendered by this transform. The contents will already be sorted if required.
        Since:
        MicroStrategy Web 9.0.0

      • getListComparator

        protected java.util.Comparator getListComparator()
        Returns:
        Comparator instance to be used to sort the children of the underlying folder to be rendered
        Since:
        MicroStrategy Web 9.0.0

      • isFolderEmpty

        public boolean isFolderEmpty()
        Deprecated.
        please use isEmptyList() instead
        Since:
        MicroStrategy Web 8.0.1

      • isEmptyList

        public boolean isEmptyList()
        Returns true if the list of elements from this folder available for display (getSortedList()) is empty or not.
        Specified by:
        isEmptyList in class AbstractObjectInfoListTransform
        Returns:
        true if the underlying object list is empty.
        Since:
        MicroStrategy Web 9.0.0

      • renderEmptyList

        public void renderEmptyList​(MarkupOutput out,
                            WebFolder folder)
        Deprecated.
        please use renderEmptyList(MarkupOutput) instead. The folder to access will be the available for this transform.
        Renders the folder when it has no children. The HTML to render for this case includes only a SPAN HTML tag, with the empty-list corresponding style, displaying the localized descriptor for This folder is empty.
        Parameters:
        out - MarkupOutput instance where the transform's output will be saved.
        folder - the WebFolder instance from the FolderBean being transformed.

      • renderEmptyList

        public void renderEmptyList​(MarkupOutput out)
        Renders the folder when it has no children. The HTML to render for this case includes only a SPAN HTML tag, with the empty-list corresponding style, displaying the localized descriptor for This folder is empty.
        Overrides:
        renderEmptyList in class AbstractObjectInfoListTransform
        Parameters:
        out - MarkupOutput instance where the transform's output will be saved.
        Since:
        MicroStrategy Web 8.0.1

      • renderImage

        public void renderImage​(MarkupOutput out,
                        java.lang.String image)
        Renders a transform's image. If the image to display is one of the defined with the formal parameters, then the imageWidth and imageHeight formal parameter values will be applied to them.
        Overrides:
        renderImage in class AbstractAppTransform
        Parameters:
        out - MarkupOutput instance where to write the output of the method.
        image - String with the image name to display

      • getGoToEvent

        public WebEvent getGoToEvent()
        Specified by:
        getGoToEvent in class AbstractObjectInfoListTransform
        Returns:
        WebEvent instance with the information for handling incremental fetch requests on the list of objects being rendered by this transform. If not supported, it will return null
        Since:
        MicroStrategy Web 9.0.0

      • getBlockPosition

        protected int getBlockPosition()
        Specified by:
        getBlockPosition in class AbstractObjectInfoListTransform
        Returns:
        value of the property indicating the index of the first element currently being viewed as part of the list output. Used for incremental fetch purposes.
        Since:
        MicroStrategy Web 9.0.0

      • getBlockSize

        protected int getBlockSize()
        Specified by:
        getBlockSize in class AbstractObjectInfoListTransform
        Returns:
        value of the property indicating the number of elements included on a single 'page' of the list output. Used for incremental fetch purposes.
        Since:
        MicroStrategy Web 9.0.0

      • getChildCount

        protected int getChildCount()
        Specified by:
        getChildCount in class AbstractObjectInfoListTransform
        Returns:
        the total number of elements that are included on the list that could be rendered by this transform. Used for incremental fetch purposes.
        Since:
        MicroStrategy Web 9.0.0

      • getOringalChildCount

        protected int getOringalChildCount()
        Return child count in the folde, including those shortcuts objects filtered out based on type restrictions
        Since:
        MicroStrategy Web 9.3.0

      • renderObjectCount

        public void renderObjectCount​(MarkupOutput out)
        This method render the section that displays the number of objects found. Used for the report - all objects tab of the object browser
        Parameters:
        out - MarkupOutput
        Since:
        MicroStrategy Web 8.0.1

      • getFolderChildCount

        protected int getFolderChildCount​(WebFolder folder)
        Since:
        MicroStrategy Web 9.0.0

      • renderList

        public abstract void renderList​(MarkupOutput out,
                                WebDisplayUnits children)
        Deprecated.
        please note that this method will later on be replaced by using renderList(MarkupOutput out) 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 out) 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.
        children - WebDisplayUnits instance with the list of objects that will be rendered by this transform, as contents of the folder being analyzed.

      • canCreateSubscription

        public boolean canCreateSubscription​(WebObjectInfo object)
        Checks if all privileges and access control are enabled to create an iServer subscription for this object.
        Parameters:
        object - the corresponding WebObjectInfo
        Since:
        MicroStrategy Web 8.0.1

      • canExecute

        public boolean canExecute​(WebObjectInfo object)
        Since:
        MicroStrategy Web 8.0.2

      • canExport

        public boolean canExport​(WebObjectInfo object)
        Checks if all privileges and access control are enabled to export this object.
        Parameters:
        object - the corresponding WebObjectInfo
        Since:
        MicroStrategy Web 8.0.1

      • canExportToPDF

        public boolean canExportToPDF​(WebObjectInfo object)
        Checks if all privileges and access control are enabled to export to PDF this object.
        Parameters:
        object - the corresponding WebObjectInfo
        Since:
        MicroStrategy Web 8.0.1

      • canSendNow

        public boolean canSendNow​(WebObjectInfo object)
        Checks if all privileges and access control are enabled to create a send-now subscription for this object.
        Parameters:
        object - the corresponding WebObjectInfo
        Since:
        MicroStrategy Web 8.0.1

      • canDelete

        public boolean canDelete​(WebObjectInfo object)
        Checks if all privileges and access control are enabled to delete this object.
        Parameters:
        object - the corresponding WebObjectInfo
        Since:
        MicroStrategy Web 8.0.1

      • isObjectRunableinPauseMode

        protected boolean isObjectRunableinPauseMode​(WebObjectInfo object)

      • canEdit

        public boolean canEdit​(WebObjectInfo object)
        Checks if all privileges and access control are enabled to edit this object.
        Parameters:
        object - the corresponding WebObjectInfo
        Since:
        MicroStrategy Web 8.0.1

      • getSubscriptionsEvent

        public WebEvent getSubscriptionsEvent​(WebObjectInfo object)
        Returns (if possible) an initialized WebEvent to go to the subscriptions of an object
        Parameters:
        object - the WebObjectInfo of the object to see its subscriptions
        Returns:
        the WebEvent initialized if possible, null if the application doesn't support it.

      • getMstrExportEvent

        public WebEvent getMstrExportEvent​(WebObjectInfo object)
        Returns web event to export VI Dashboard to .mstr format
        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.
        Since:
        MicroStrategy Web 9.5

      • getHtmlExportEvent

        public WebEvent getHtmlExportEvent​(WebObjectInfo object)
        Since:
        MicroStrategy Web 9.0.0

      • isViewableReport

        protected boolean isViewableReport​(WebObjectInfo object)
        A report is viewable if its subtype is not EnumDSSXMLObjectSubTypes.DssXmlSubTypeReportDatamart, EnumDSSXMLObjectSubTypes.DssXmlSubTypeReportNonInteractive or EnumDSSXMLObjectSubTypes.DssXmlSubTypeReportCube
        Parameters:
        object -
        Returns:
        whether the report is viewable
        Since:
        MicroStrategy Web 9.0.0

      • getSendNowEvent

        public WebEvent getSendNowEvent​(WebObjectInfo object)
        Returns a WebEvent to send an object through email
        Parameters:
        object - the WebObjectInfo of the object to send
        Returns:
        the WebEvent instance if possible otherwise, null if the application doesn't support it.

      • getDeleteEvent

        public WebEvent getDeleteEvent​(WebObjectInfo object)
        Returns an initialized WebEvent to delete an object.
        Parameters:
        object - the WebObjectInfo instance of the object to delete.
        Returns:
        the WebEvent instance initialized if possible, null if the application doesn't support it.

      • getDeleteEvent

        public WebEvent getDeleteEvent​(WebObjectInfo object,
                               boolean confirmFirst)
        Returns an initialized WebEvent to delete an object.
        Parameters:
        object - the WebObjectInfo instance of the object to delete.
        Returns:
        the WebEvent instance initialized if possible, null if the application doesn't support it.
        Since:
        MicroStrategy Web 8.0.1

      • getEditEvent

        public WebEvent getEditEvent​(WebObjectInfo object)
        Returns an initialized WebEvent to edit an object.
        Parameters:
        object - the WebObjectInfo instance of the object to edit.
        Returns:
        the WebEvent instance initialized if possible, null if the application doesn't support it.

      • getViewMediaRWEvent

        public WebEvent getViewMediaRWEvent​(WebObjectInfo object,
                                    int viewMedia)
        Since:
        MicroStrategy Web 9.0.0

      • getViewMediaReportEvent

        public WebEvent getViewMediaReportEvent​(WebObjectInfo object,
                                        int viewMedia)
        Since:
        MicroStrategy Web 9.0.0

      • getFolderBean

        protected FolderBean getFolderBean()
        Get the folderBean target of this transform
        Returns:
        the FolderBean instance used with this transform

      • getImageName

        protected java.lang.String getImageName​(WebObjectInfo object)
        Utility method that helps giving the image name to use - based on the information available on the formal parameters and on the the object type of the WebObjectInfo instance.
        Overrides:
        getImageName in class AbstractObjectInfoListTransform
        Parameters:
        object - The WebObjectInfo for which it's image name is required.
        Returns:
        a String with the name of the image associated with the WebObjectInfo. If the type specified does not match the predefined list of styles, then it returns the file name and path for the blank (transparent) image.

      • getImageSrc

        protected java.lang.String getImageSrc​(WebObjectInfo object)
        Utility method that helps giving the source attribute for the image to use based on the object type of the WebObjectInfo instance. This method is used only when the user has turned on the Accessibility preference.
        Parameters:
        object - The WebObjectInfo for which it's image name is required.
        Returns:
        a String with the image path 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 a blank image.
        Since:
        MicroStrategy Web 8.1.1

      • isObjectVisible

        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

      • isObjectSelected

        protected boolean isObjectSelected​(WebObjectInfo object)
        Utility method that checks if the WebObjectInfo is among the selected list, based on its ID. This is controled by the objectID request parameter value specified.
        Parameters:
        object - WebObjectInfo with the object to check for.
        Returns:
        True if the object is selected, otherwise returns False

      • initializeSelectedItemsList

        protected void initializeSelectedItemsList()
        Initialize selected items list, based on the objectID request paramter. Each element is separated by ;

      • getContextMenuAttributes

        public java.util.Map getContextMenuAttributes​(WebObjectInfo object)
        Returns the context-menu specific attributes to assign to the context-menu container
        Parameters:
        object - WebObjectInfo
        Returns:
        Map
        Since:
        MicroStrategy Web 8.0.1

      • newContext

        protected TransformContext newContext()
        Description copied from class: AbstractAppTransform
        Creates a new instance of a TransformContext. It's used by the getContext method the first time is invoked. Transforms who require to include extra information in the context should create their own TransformContext implementation (possibly a subclass of AppTransformContext) and returns a new instance in this method.
        Overrides:
        newContext in class AbstractAppTransform
        Since:
        MicroStrategy Web 8.0.1

      • addScriptDependency

        public void addScriptDependency​(java.lang.String filename,
                                java.lang.String loadCondition)
        Add javascript dependence

      • renderJavaScript

        public void renderJavaScript()