public class

FolderViewWidgetTransform

extends FolderViewTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
           ↳ com.microstrategy.web.app.transforms.AbstractFolderTransform
             ↳ com.microstrategy.web.app.transforms.FolderViewTransform
               ↳ com.microstrategy.web.app.transforms.FolderViewWidgetTransform

Class Overview

This class provides additional methods related to folder browsing used to populate a Folder Browsing service. Many of these methods will disappear once the layout file enhancements are implemented.

Summary

Nested Classes
class FolderViewWidgetTransform.Tree  
Constants
String FP_SHOW_OBJECT_TAGS
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.FolderViewTransform
From class com.microstrategy.web.app.transforms.AbstractFolderTransform
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public final String FP_ATT_FORMS Constant specifying the name of the formal parameter for how to include the forms information for the attribute object in the folder.
public final String FP_INCLUDE_ANCESTOR_INFO Constant specifying the name of the formal parameter for defining the folder widget to include ancestor information for this folder.
public final String FP_INCLUDE_FOLDER_INFO Constant specifying the name of the formal parameter for defining the folder widget to include 'folder' property for in this 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 final String FP_SORTED_ITEMS Constant specifying the name of the formal parameter for whether to render the items in a sorted manner or not
public final String FP_TREE_STRUCTURE
public FormalParameter attForms Indicate whether and how to include the forms information for attribute object in the folder.
public FormalParameter inTreeStructure Indicates whether to render the items in tree structures.
public FormalParameter includeAncestorInfo Indicates the identifier to use to determine whether the ancestor information of folder should be included in folder widget.
public FormalParameter includeFolderInfo Indicates the identifier to use to determine whether the time information of folder item should be included in folder widget.
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.
public FormalParameter sortedItems Indicates whether to render the items in a sorted order or not If the value is true, then the items will be rendered as sorted; if false then unsorted.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.FolderViewTransform
From class com.microstrategy.web.app.transforms.AbstractFolderTransform
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
FolderViewWidgetTransform()
Public Methods
static FolderViewWidgetTransform.Tree buildAncestorTree(FolderBean fBean, WebFolder searchRoot)
Build Ancestor tree for a given folder
void buildRelatedLinkItems()
List getAncestors()
Returns a flattened enumeration of ancestors.
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.
int getFolderSize()
Returns the size of the folder, regardless of the incremental fetch settings.
Block getFolderWidget(String styleName)
List getItemsList()
WebFolder getMainFolder()
String getMainFolderTreeLocation()
String getSearchDataSources()
String getSearchFlags()
boolean getSearchMatchCase()
String getSearchTypes()
String getSearchXML()
Object getSelf(Object obj)
Returns the input argument as return value.
boolean hasAncestor()
boolean inTreeStructure()
boolean includeAncestorInfo()
boolean includeFolderInfo()
boolean includeOwnerInfo()
boolean includeTimeInfo()
void initializeTransform(Transformable data)
Initialize the transform.
boolean isNull(Object obj)
Returns whether the input argument is null.
boolean isShowObjectTags()
void renderShell(MarkupOutput out)
Overrides the default "shell" created when the transform is invoked.
String setObjectTagList(WebObjectInfo oi)
static void trimAncetors(SimpleList ancestors)
Protected Methods
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
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.FolderViewTransform
From class com.microstrategy.web.app.transforms.AbstractFolderTransform
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
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

Constants

public static final String FP_SHOW_OBJECT_TAGS

Constant Value: "showObjectTags"

Fields

public final String FP_ATT_FORMS

Constant specifying the name of the formal parameter for how to include the forms information for the attribute object in the folder. refer to EnumWebDisplayedForms. When the value is -1, that means no forms to include.

Constant Value: "attForms"

public final String FP_INCLUDE_ANCESTOR_INFO

Constant specifying the name of the formal parameter for defining the folder widget to include ancestor information for this folder. true means to include. false means to exlude.

Constant Value: "includeAncestorInfo"

public final String FP_INCLUDE_FOLDER_INFO

Constant specifying the name of the formal parameter for defining the folder widget to include 'folder' property for in this folder. true means to include. false means to exlude.

Constant Value: "includeFolderInfo"

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 final String FP_SORTED_ITEMS

Constant specifying the name of the formal parameter for whether to render the items in a sorted manner or not

Constant Value: "sortedItems"

public final String FP_TREE_STRUCTURE

Constant Value: "treeStructure"

public FormalParameter attForms

Indicate whether and how to include the forms information for attribute object in the folder. This string normally contains only one integer. The value should be in enumeration EnumWebDisplayedForms. If the value is WebDisplayedFormsCustom, then it should followed by comma separated form IDs.

public FormalParameter inTreeStructure

Indicates whether to render the items in tree structures.

public FormalParameter includeAncestorInfo

Indicates the identifier to use to determine whether the ancestor information of folder should be included in folder widget. The default value is true.

public FormalParameter includeFolderInfo

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 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 FormalParameter sortedItems

Indicates whether to render the items in a sorted order or not If the value is true, then the items will be rendered as sorted; if false then unsorted.

Public Constructors

public FolderViewWidgetTransform ()

Public Methods

public static FolderViewWidgetTransform.Tree buildAncestorTree (FolderBean fBean, WebFolder searchRoot)

Build Ancestor tree for a given folder

Parameters
fBean The bean to represent the folder, which this method will try to generate its ancestor tree
searchRoot The root folder of the search object, if the folder represented by fBean is a search result. This parameter will be null, if fBean is not a search result.
Returns

public void buildRelatedLinkItems ()

Throws
IllegalArgumentException
WebObjectsException

public List getAncestors ()

Returns a flattened enumeration of ancestors.

Returns

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 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 WebFolder getMainFolder ()

Throws
WebObjectsException

public String getMainFolderTreeLocation ()

public String getSearchDataSources ()

public String getSearchFlags ()

public boolean getSearchMatchCase ()

public String getSearchTypes ()

public String getSearchXML ()

public Object getSelf (Object obj)

Returns the input argument as return value. This method is used in layout when one base value needs to assign to another base value. For example, we have base "obj", then when the type of "obj" is a certain value, we would like base "obj2" equals to "obj". Then in layout we can have . After this, obj2 points to the same object as "obj" points to.

Parameters
obj object to return
Returns
  • Returns the input argument.

public boolean hasAncestor ()

public boolean inTreeStructure ()

public boolean includeAncestorInfo ()

public boolean includeFolderInfo ()

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 isNull (Object obj)

Returns whether the input argument is null.

Parameters
obj The object to check again null
Returns
  • true if the input is null, otherwise false is returned.

public boolean isShowObjectTags ()

public void renderShell (MarkupOutput out)

Overrides the default "shell" created when the transform is invoked. Ideally, it would be better if we could initialize this transform with a field that indicates whether the HTML shell is created or not. In this way, subclasses can merely override this property (perhaps in their constructor) and affect how the renderShell method is invoked. Alternatively, the renderShell can be structured as a Template method to allow subclasses to easily override those methods that they do not want called.

Parameters
out The MarkupOutput representing the generated content.

public String setObjectTagList (WebObjectInfo oi)

Throws
IllegalArgumentException
WebObjectsException

public static void trimAncetors (SimpleList ancestors)

Protected Methods

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