Package com.microstrategy.web.app.transforms

Class DataExplorerFolderWidgetTransform

    • Field Detail

      • FP_INCLUDE_OWNER_INFO

        public final java.lang.String FP_INCLUDE_OWNER_INFO
        Constant specifying the name of the formal parameter for defining the folder widget to include owner information for the item in this folder. true means to include. false means to exlude.
        See Also:
        Constant Field Values

      • includeOwnerInfo

        public FormalParameter includeOwnerInfo
        Indicates the identifier to use to determine whether the owner information of folder item should be included in folder widget. The default value is true.

      • FP_INCLUDE_TIME_INFO

        public final java.lang.String FP_INCLUDE_TIME_INFO
        Constant specifying the name of the formal parameter for defining the folder widget to include time information for the item in this folder. true means to include. false means to exlude.
        See Also:
        Constant Field Values

      • includeTimeInfo

        public FormalParameter includeTimeInfo
        Indicates the identifier to use to determine whether the time information of folder item should be included in folder widget. The default value is true.

      • FP_ATT_FORMS

        public final java.lang.String FP_ATT_FORMS
        Constant specifying the name of hte formal parameter for how to include the forms information for the attribute object in the folder. refere to EnumWebDisplayedForms. When the value is -1, that means no forms to include.
        See Also:
        Constant Field Values

      • attForms

        public FormalParameter attForms
        Indicate whether and how to include the forms information for attribute object in the folder. When the value is "-1" that means no form to include. Otherwise the value should be in enumeration EnumWebDisplayedForms.

    • Constructor Detail

      • DataExplorerFolderWidgetTransform

        public DataExplorerFolderWidgetTransform()

    • Method Detail

      • getSupportedBeanType

        public java.lang.Class getSupportedBeanType()
        Description copied from class: AbstractAppTransform
        Returns the supported bean type. This abstract Transform supports all WebComponents so every sub-class should override this method to return the class of the Bean the Transform is expecting, for example: 
         public class CustomReportClass extends AbstractAppTransform {

    public Class getSupportedBeanType() {
        //This Transform is expected to work only with a ReportBean,
        //therefore this method needs to return this class:
        return ReportBean.class;
    }

 }
        Specified by:
        getSupportedBeanType in interface Transform
        Overrides:
        getSupportedBeanType in class AbstractAppTransform
        Returns:
        a root class/interface supported by this transform.

      • getFolderSize

        public int getFolderSize()
        Returns the size of the folder, regardless of the incremental fetch settings.
        Returns:
        The total number of children in this folder.

      • getItemsList

        public java.util.List getItemsList()

      • getBlockBegin

        public int getBlockBegin()

      • getBlockCount

        public int getBlockCount()

      • getSearchMatchCase

        public boolean getSearchMatchCase()

      • getFolderWidget

        public Block getFolderWidget​(java.lang.String styleName)

      • getAttForms

        public java.util.List getAttForms​(WebAttribute att)
        returns the attribute forms for the attribute
        Parameters:
        att -

      • getDescription

        public java.lang.String getDescription()
        Description copied from interface: Transform
        Returns a textual description of the transform.
        Returns:
        The textual description of the transform.

      • getCssName

        public 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.
        Overrides:
        getCssName in class AbstractAppWidgetTransform
        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.