public class

DataExplorerFolderWidgetTransform

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

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public final 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.
public final 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.
public final 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.
public FormalParameter attForms Indicate whether and how to include the forms information for attribute object in the folder.
public FormalParameter includeOwnerInfo Indicates the identifier to use to determine whether the owner information of folder item should be included in folder widget.
public FormalParameter includeTimeInfo Indicates the identifier to use to determine whether the time information of folder item should be included in folder widget.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
DataExplorerFolderWidgetTransform()
Public Methods
List getAttForms(WebAttribute att)
returns the attribute forms for the attribute
int getBlockBegin()
int getBlockCount()
String getCssName(WebObjectInfo object)
Utility method that helps giving the CSS class to use based on the the object type of the WebObjectInfo instance.
String getDescription()
int getFolderSize()
Returns the size of the folder, regardless of the incremental fetch settings.
Block getFolderWidget(String styleName)
List getItemsList()
boolean getSearchMatchCase()
Class getSupportedBeanType()
Returns the supported bean type.
boolean includeOwnerInfo()
boolean includeTimeInfo()
void initializeTransform(Transformable data)
Initialize the transform.
boolean isShowObjectTags()
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractAppWidgetTransform
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.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Fields

public final 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.

Constant Value: "attForms"

public final 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.

Constant Value: "includeOwnerInfo"

public final 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.

Constant Value: "includeTimeInfo"

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.

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.

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.

Public Constructors

public DataExplorerFolderWidgetTransform ()

Public Methods

public List getAttForms (WebAttribute att)

returns the attribute forms for the attribute

public int getBlockBegin ()

public int getBlockCount ()

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

public String getDescription ()

public int getFolderSize ()

Returns the size of the folder, regardless of the incremental fetch settings.

Returns
  • The total number of children in this folder.

public Block getFolderWidget (String styleName)

public List getItemsList ()

public boolean getSearchMatchCase ()

public Class getSupportedBeanType ()

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;
    }

 }
 

Returns
  • a root class/interface supported by this transform.

public boolean includeOwnerInfo ()

public boolean includeTimeInfo ()

public void initializeTransform (Transformable data)

Initialize the transform.

Parameters
data The Transformable object associated with this transform.

public boolean isShowObjectTags ()