public abstract class

AbstractFolderTransform

extends AbstractObjectInfoListTransform
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
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

AbstractFolderTransform is an abstract class that takes care of rendering folder-related information. All functional folder transform classes, such as FolderIconTransform and FolderViewTransform and others extend from it.

Summary

Nested Classes
class AbstractFolderTransform.Context Extends AbstractAppTransform.Context by providing a link to the current WebObjectInfo
Constants
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.
String FP_DATAMART_IMAGE Constant specifying the name of the formal parameter for defining the datamart image.
String FP_DOCUMENT_IMAGE Constant specifying the name of the formal parameter for defining the document image.
String FP_EXEC_TARGET Determines how the user want's to execute the Report/Document object.
String FP_FILTER_IMAGE Constant specifying the name of the formal parameter for defining the filter image.
String FP_FOLDER_IMAGE Constant specifying the name of the formal parameter for defining the folder image.
String FP_GRAPH_IMAGE Constant specifying the name of the formal parameter for defining the graph image.
String FP_GRID_GRAPH_IMAGE Constant specifying the name of the formal parameter for defining the gridGraph image.
String FP_IMAGE_HEIGTH Constant specifying the name of the formal parameter for defining the image height.
String FP_IMAGE_WIDTH Constant specifying the name of the formal parameter for defining the image width.
String FP_LEVEL_FLAG Constant specifying the name of the formal parameter for defining the level flag.
String FP_MAX_OBJECT_TYPE_COUNT Constant specifying the name of the formal parameter for defining the maximum object type count.
String FP_REPORT_IMAGE Constant specifying the name of the formal parameter for defining the report image.
String FP_RW_DOCUMENT_IMAGE Constant specifying the name of the formal parameter for defining the report writing document image.
String FP_SORT_ASCENDING Constant specifying the name of the formal parameter for defining the sort order of the folder contents.
String FP_SORT_FIELD Constant specifying the name of the formal parameter for defining the field from which the folder contents will be sorted.
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.
String FP_TEMPLATE_IMAGE Constant specifying the name of the formal parameter for defining the template image.
int LEVEL_ALL Allowed value for the levelFlag formal parameter.
int LEVEL_CONFIRM_DELETE Allowed value for the levelFlag formal parameter.
int LEVEL_DELETE Allowed value for the levelFlag formal parameter.
int LEVEL_DESCRIPTION Allowed value for the levelFlag formal parameter.
int LEVEL_DISPLAY_HEADERS Allowed value for the levelFlag formal parameter.
int LEVEL_EDIT Allowed value for the levelFlag formal parameter.
int LEVEL_EMPTY_FOLDER_MESSAGE Allowed value for the levelFlag formal parameter.
int LEVEL_EXPORT_EXCEL Allowed value for the levelFlag formal parameter.
int LEVEL_EXPORT_PDF Allowed value for the levelFlag formal parameter.
int LEVEL_FOLDER_INFORMATION Allowed value for the levelFlag formal parameter.
int LEVEL_INCREMENTAL_FETCH Allowed value for the levelFlag formal parameter.
int LEVEL_LOCATION Allowed value for the levelFlag formal parameter.
int LEVEL_MODIFIED Allowed value for the {@link #leveimport com.microstrategy.web.objects.rw.*; import com.microstrategy.web.tags.*; import com.microstrategy.web.transform.*; er.
int LEVEL_NAME Allowed value for the levelFlag formal parameter.
int LEVEL_OWNER Allowed value for the levelFlag formal parameter.
int LEVEL_SEND_NOW Allowed value for the levelFlag formal parameter.
int LEVEL_SUBSCRIPTION Allowed value for the levelFlag formal parameter.
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected int _bandingIndex
protected int _imgHeight Property for holding the value specified to the imgHeight formal parameter
protected int _imgWidth Property for holding the value specified to the imgWidth formal parameter
protected WebDisplayUnits _sortedChildUnits
public FormalParameter datamartImage Indicates the image to use when displaying a datamart report.
public FormalParameter documentImage Indicates the image to use when displaying a document.
public FormalParameter execTarget Determines how the user want's to execute the Report/Document object.
public FormalParameter filterImage Indicates the image to use when displaying a filter.
public FormalParameter folderImage Indicates the image to use when displaying a folder.
public FormalParameter graphImage Indicates the image to use when displaying a graph.
public FormalParameter gridGraphImage Indicates the image to use when displaying a grid-graph report.
public FormalParameter imageHeight Indicates the height of the images to be rendered next to the objects when displayed.
public FormalParameter imageWidth Indicates the width of the images to be rendered next to the objects when displayed.
public FormalParameter levelFlag Indicates the level of information to use when displaying each folder item.
public FormalParameter maxObjectTypeCount Indicates any object count limit based on the object type.
public FormalParameter reportImage Indicates the image to use when displaying a report.
public FormalParameter rwDocumentImage Indicates the image to use when displaying a report writing document.
public FormalParameter sortAscending Indicates the order to use while sorting the folder contents.
public FormalParameter sortField Indicates the field to use while sorting the folder contents.
public FormalParameter tableId Indicates the identifier to use when building up the HTML table to be rendered with the contents of the folder.
public FormalParameter templateImage Indicates the image to use when displaying a template.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
AbstractFolderTransform()
Default no-argument constructor.
Public Methods
void addScriptDependency(String filename, String loadCondition)
Add javascript dependence
boolean canCreateSubscription(WebObjectInfo object)
Checks if all privileges and access control are enabled to create an iServer subscription for this object.
boolean canDelete(WebObjectInfo object)
Checks if all privileges and access control are enabled to delete this object.
boolean canEdit(WebObjectInfo object)
Checks if all privileges and access control are enabled to edit this object.
boolean canExecute(WebObjectInfo object)
boolean canExport(WebObjectInfo object)
Checks if all privileges and access control are enabled to export this object.
boolean canExportToPDF(WebObjectInfo object)
Checks if all privileges and access control are enabled to export to PDF this object.
boolean canSendNow(WebObjectInfo object)
Checks if all privileges and access control are enabled to create a send-now subscription for this object.
Map getContextMenuAttributes(WebObjectInfo object)
Returns the context-menu specific attributes to assign to the context-menu container
WebEvent getDeleteEvent(WebObjectInfo object)
Returns an initialized WebEvent to delete an object.
WebEvent getDeleteEvent(WebObjectInfo object, boolean confirmFirst)
Returns an initialized WebEvent to delete an object.
WebEvent getEditEvent(WebObjectInfo object)
Returns an initialized WebEvent to edit an object.
WebEvent getEvent(WebObjectInfo object)
Based on the object type on the WebObjectInfo sent as parameter, it creates and initializes the corresponding WebEvent for having the object opened or run.
WebEvent getExportEvent(WebObjectInfo object)
Returns an initialized WebEvent to go to the Export page for an object.
WebEvent getExportEvent(WebObjectInfo object, boolean fastLink)
This method is deprecated. use getExportEvent(WebObjectInfo)
WebEvent getFlashExportEvent(WebObjectInfo object)
Returns an initialized WebEvent to go to the FlashExport page for an object.
int getGoToArgument()
WebEvent getGoToEvent()
WebEvent getHtmlExportEvent(WebObjectInfo object)
WebEvent getMstrExportEvent(WebObjectInfo object)
Returns web event to export VI Dashboard to .mstr format
WebEvent getPDFExportEvent(WebObjectInfo object)
Returns an initialized WebEvent to go to the PDF Export page for an object.
WebEvent getSendNowEvent(WebObjectInfo object)
Returns a WebEvent to send an object through email
List getSortedList()
WebEvent getSubscriptionsEvent(WebObjectInfo object)
Returns (if possible) an initialized WebEvent to go to the subscriptions of an object
Class getSupportedBeanType()
Get the class of objects this transform is able to handle, which are of the FolderBean type.
WebEvent getViewMediaRWEvent(WebObjectInfo object, int viewMedia)
WebEvent getViewMediaReportEvent(WebObjectInfo object, int viewMedia)
void initializeCss()
Initializes the Css classes to use.
void initializeImages()
Initializes the name of the images to use on this transform's output.
void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.
boolean isEmptyList()
Returns true if the list of elements from this folder available for display (getSortedList()) is empty or not.
boolean isFeatureAvailable(String feature)
Extends isFeatureAvailable by maintaining a cache of the features to use.
boolean isFolderEmpty()
This method is deprecated. please use isEmptyList() instead
void renderEmptyList(MarkupOutput out)
Renders the folder when it has no children.
void renderEmptyList(MarkupOutput out, WebFolder folder)
This method is deprecated. please use renderEmptyList(MarkupOutput) instead. The folder to access will be the available for this transform.
void renderImage(MarkupOutput out, String image)
Renders a transform's image.
void renderJavaScript()
void renderList(MarkupOutput out)
Renders the folder contents when it does have children, which will be obtained from the getSortedChildUnits() method.
abstract void renderList(MarkupOutput out, WebDisplayUnits children)
This method is deprecated. please note that this method will later on be replaced by using renderList(MarkupOutput) 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) instead of from this method.
void renderObjectCount(MarkupOutput out)
This method render the section that displays the number of objects found.
void transformForRequestSuccessful(MarkupOutput out)
Transforms the assosciated WebBean when its status is WebBeanRequestSuccessful.
Protected Methods
boolean checkLevel(int level)
Check if the level parameter value contains this flag.
int getBlockPosition()
int getBlockSize()
int getChildCount()
TransformContext getContext()
Extends getContext() by setting to the context object a reference the current WebObjectInfo
ContextMenu getContextMenu(WebObjectInfo object)
Return the ContextMenu associated with the object
JsonGenerator getFeatures()
FolderBean getFolderBean()
Get the folderBean target of this transform
int getFolderChildCount(WebFolder folder)
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.
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.
Comparator getListComparator()
int getOringalChildCount()
Return child count in the folde, including those shortcuts objects filtered out based on type restrictions
WebDisplayUnits getSortedChildUnits()
Returns a sorted list containing the folder's child units
void initializeSelectedItemsList()
Initialize selected items list, based on the objectID request paramter.
boolean isObjectSelected(WebObjectInfo object)
Utility method that checks if the WebObjectInfo is among the selected list, based on its ID.
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
boolean isViewableReport(WebObjectInfo object)
A report is viewable if its subtype is not EnumDSSXMLObjectSubTypes.DssXmlSubTypeReportDatamart, EnumDSSXMLObjectSubTypes.DssXmlSubTypeReportNonInteractive or EnumDSSXMLObjectSubTypes.DssXmlSubTypeReportCube
TransformContext newContext()
Creates a new instance of a TransformContext.
void setBoneProperties(JsonGenerator boneProps)
Sets the necessary properties to the bone assigned to this transform (based on the scriptClass formal parameter)
Usually called by renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.
[Expand]
Inherited Methods
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_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.

Constant Value: "displaySection"

public static final String FP_DATAMART_IMAGE

Constant specifying the name of the formal parameter for defining the datamart image. Value is datamartImage.

Constant Value: "datamartImage"

public static final String FP_DOCUMENT_IMAGE

Constant specifying the name of the formal parameter for defining the document image. Value is documentImage.

Constant Value: "documentImage"

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

Constant Value: "execTarget"

public static final String FP_FILTER_IMAGE

Constant specifying the name of the formal parameter for defining the filter image. Value is filterImage.

Constant Value: "filterImage"

public static final String FP_FOLDER_IMAGE

Constant specifying the name of the formal parameter for defining the folder image. Value is folderImage.

Constant Value: "folderImage"

public static final String FP_GRAPH_IMAGE

Constant specifying the name of the formal parameter for defining the graph image. Value is graphImage.

Constant Value: "graphImage"

public static final String FP_GRID_GRAPH_IMAGE

Constant specifying the name of the formal parameter for defining the gridGraph image. Value is gridGraphImage.

Constant Value: "gridGraphImage"

public static final String FP_IMAGE_HEIGTH

Constant specifying the name of the formal parameter for defining the image height. Value is imageHeight.

Constant Value: "imageHeight"

public static final String FP_IMAGE_WIDTH

Constant specifying the name of the formal parameter for defining the image width. Value is imageWidth.

Constant Value: "imageWidth"

public static final String FP_LEVEL_FLAG

Constant specifying the name of the formal parameter for defining the level flag. Value is levelFlag.

Constant Value: "levelFlag"

public static final String FP_MAX_OBJECT_TYPE_COUNT

Constant specifying the name of the formal parameter for defining the maximum object type count. Value is maxObjectTypeCount.

Constant Value: "maxObjectTypeCount"

public static final String FP_REPORT_IMAGE

Constant specifying the name of the formal parameter for defining the report image. Value is reportImage.

Constant Value: "reportImage"

public static final String FP_RW_DOCUMENT_IMAGE

Constant specifying the name of the formal parameter for defining the report writing document image. Value is rwDocumentImage.

Constant Value: "rwDocumentImage"

public static final String FP_SORT_ASCENDING

Constant specifying the name of the formal parameter for defining the sort order of the folder contents. Value is sortAscending.

Constant Value: "sortAscending"

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

Constant Value: "sortField"

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

Constant Value: "tableId"

public static final String FP_TEMPLATE_IMAGE

Constant specifying the name of the formal parameter for defining the template image. Value is templateImage.

Constant Value: "templateImage"

public static final int LEVEL_ALL

Allowed value for the levelFlag formal parameter. Convenience flag that includes all possible LEVEL values.
Value = 16777215

Constant Value: -1 (0xffffffff)

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

Constant Value: 512 (0x00000200)

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

Constant Value: 16 (0x00000010)

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

Constant Value: 2 (0x00000002)

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

Constant Value: 65536 (0x00010000)

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

Constant Value: 64 (0x00000040)

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

Constant Value: 256 (0x00000100)

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

Constant Value: 32768 (0x00008000)

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

Constant Value: 16384 (0x00004000)

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

Constant Value: 131072 (0x00020000)

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

Constant Value: 4096 (0x00001000)

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

Constant Value: 128 (0x00000080)

public static final int LEVEL_MODIFIED

Allowed value for the {@link #leveimport 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

Constant Value: 8 (0x00000008)

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

Constant Value: 1 (0x00000001)

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

Constant Value: 4 (0x00000004)

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

Constant Value: 8192 (0x00002000)

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

Constant Value: 32 (0x00000020)

Fields

protected int _bandingIndex

protected int _imgHeight

Property for holding the value specified to the imgHeight formal parameter

protected int _imgWidth

Property for holding the value specified to the imgWidth formal parameter

protected WebDisplayUnits _sortedChildUnits

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

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

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.

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.

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.

public FormalParameter sortField

Indicates the field to use while sorting the folder contents. The value of the formal parameter should be taken from the EnumWebObjectSort enumeration, which indicates the type of field tu use, for example, sorting on name, description, owner, etc.
The default value is WebObjectSortObjectNameFoldersFirst.
The sortAscending and sortField parameter are used in conjunction to sort by a particular field on the foder page.
For example: Setting these parameters to false, and WebObjectSortObjectOwner respectively will sort the contents of the folder page in descending order based on the Owner filed

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.

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.

Public Constructors

public AbstractFolderTransform ()

Default no-argument constructor. Initializes formal parameters.

Public Methods

public void addScriptDependency (String filename, String loadCondition)

Add javascript dependence

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

public boolean canDelete (WebObjectInfo object)

Checks if all privileges and access control are enabled to delete this object.

Parameters
object the corresponding WebObjectInfo

public boolean canEdit (WebObjectInfo object)

Checks if all privileges and access control are enabled to edit this object.

Parameters
object the corresponding WebObjectInfo

public boolean canExecute (WebObjectInfo object)

public boolean canExport (WebObjectInfo object)

Checks if all privileges and access control are enabled to export this object.

Parameters
object the corresponding WebObjectInfo

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

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

public Map getContextMenuAttributes (WebObjectInfo object)

Returns the context-menu specific attributes to assign to the context-menu container

Parameters
object WebObjectInfo
Returns
  • Map

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.

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.

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.

public WebEvent getEvent (WebObjectInfo object)

Based on the object type on the WebObjectInfo sent as parameter, it creates and initializes the corresponding WebEvent for having the object opened or run.

Parameters
object a WebObjectInfo for which the "execution" event must be retrieved.
Returns

public WebEvent getExportEvent (WebObjectInfo object)

Returns an initialized WebEvent to go to the Export page for an object. Currently this method handles only DssXmlTypeReportDefinition and DssXmlTypeDocumentDefinition objects.

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.

public WebEvent getExportEvent (WebObjectInfo object, boolean fastLink)

This method is deprecated.
use getExportEvent(WebObjectInfo)

Returns an initialized WebEvent to go to the Export page for an object. Currently this method handles only DssXmlTypeReportDefinition and DssXmlTypeDocumentDefinition objects.

Parameters
object the WebObjectInfo instance which will be exported if the event is called.
fastLink boolean that indicates if the link to generate for the export is for a report or document that has not been yet run.
Returns
  • an initialized WebEvent object if the application supports it. Otherwise, will return null.

public WebEvent getFlashExportEvent (WebObjectInfo object)

Returns an initialized WebEvent to go to the FlashExport page for an object. Currently this method handles only DssXmlSubTypeReportWritingDocument subtype objects.

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.

public int getGoToArgument ()

Returns
  • the identifier of the argument on the getGoToEvent() event where the element to navigate to will be specified.

public WebEvent getGoToEvent ()

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

public WebEvent getHtmlExportEvent (WebObjectInfo object)

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.

public WebEvent getPDFExportEvent (WebObjectInfo object)

Returns an initialized WebEvent to go to the PDF Export page for an object. Currently this method handles only DssXmlTypeReportDefinition and DssXmlTypeDocumentDefinition of DssXmlSubTypeReportWritingDocument subtype objects.

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.

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.

public List getSortedList ()

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.

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.

public Class getSupportedBeanType ()

Get the class of objects this transform is able to handle, which are of the FolderBean type.

Returns
  • a Class instance with the information about the beans this transform is able to manipulate.

public WebEvent getViewMediaRWEvent (WebObjectInfo object, int viewMedia)

public WebEvent getViewMediaReportEvent (WebObjectInfo object, int viewMedia)

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.

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.

public void initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform. Extends initializeTransform by initializing the cache of this transform's Formal parameters.

Parameters
data Transformable instance with the bean to be transformed.

public boolean isEmptyList ()

Returns true if the list of elements from this folder available for display (getSortedList()) is empty or not.

Returns
  • true if the underlying object list is empty.

public boolean isFeatureAvailable (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.

Parameters
feature the feature to check for.
Returns
  • True if the feature is available, otherwise returns False.

public boolean isFolderEmpty ()

This method is deprecated.
please use isEmptyList() instead

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.

Parameters
out MarkupOutput instance where the transform's output will be saved.

public void renderEmptyList (MarkupOutput out, WebFolder folder)

This method is 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.

public void renderImage (MarkupOutput out, 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.

Parameters
out MarkupOutput instance where to write the output of the method.
image String with the image name to display

public void renderJavaScript ()

public void renderList (MarkupOutput out)

Renders the folder contents when it does have children, which will be obtained from the getSortedChildUnits() method.

Parameters
out MarkupOutput instance to modify with the transform's output.

public abstract void renderList (MarkupOutput out, WebDisplayUnits children)

This method is deprecated.
please note that this method will later on be replaced by using renderList(MarkupOutput) 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) 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.

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

public void transformForRequestSuccessful (MarkupOutput out)

Transforms the assosciated WebBean when its status is WebBeanRequestSuccessful.

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

Protected Methods

protected boolean checkLevel (int level)

Check if the level parameter value contains this flag. This method calls checkLevel(int, FormalParameter) using the levelFlag formal parameter.

Parameters
level flag value to check for.
Returns
  • true means the level flag is included in the levelFlag formal parameter value

protected int getBlockPosition ()

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.

protected int getBlockSize ()

Returns
  • value of the property indicating the number of elements included on a single 'page' of the list output. Used for incremental fetch purposes.

protected int getChildCount ()

Returns
  • the total number of elements that are included on the list that could be rendered by this transform. Used for incremental fetch purposes.

protected TransformContext getContext ()

Extends getContext() by setting to the context object a reference the current WebObjectInfo

protected ContextMenu getContextMenu (WebObjectInfo object)

Return the ContextMenu associated with the object

Parameters
object WebObjectInfo
Returns

protected JsonGenerator getFeatures ()

protected FolderBean getFolderBean ()

Get the folderBean target of this transform

Returns

protected int getFolderChildCount (WebFolder folder)

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

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.

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

protected Comparator getListComparator ()

Returns
  • Comparator instance to be used to sort the children of the underlying folder to be rendered

protected int getOringalChildCount ()

Return child count in the folde, including those shortcuts objects filtered out based on type restrictions

protected WebDisplayUnits getSortedChildUnits ()

Returns a sorted list containing the folder's child units

Returns
Throws
WebBeanException if an error happens getting the child units
WebObjectsException if an error happens getting the child units

protected void initializeSelectedItemsList ()

Initialize selected items list, based on the objectID request paramter. Each element is separated by ;

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

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

protected boolean isViewableReport (WebObjectInfo object)

A report is viewable if its subtype is not EnumDSSXMLObjectSubTypes.DssXmlSubTypeReportDatamart, EnumDSSXMLObjectSubTypes.DssXmlSubTypeReportNonInteractive or EnumDSSXMLObjectSubTypes.DssXmlSubTypeReportCube

Returns
  • whether the report is viewable

protected TransformContext newContext ()

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.

protected void setBoneProperties (JsonGenerator boneProps)

Sets the necessary properties to the bone assigned to this transform (based on the scriptClass formal parameter)
Usually called by renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.

Parameters
boneProps the JsonGenerator object that contains the collection of bone properties.