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 |
![]() |
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.
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 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() |
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 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() |
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, boolean fastLink)
This method is deprecated.
use
getExportEvent(WebObjectInfo)
| ||||||||||
WebEvent |
getExportEvent(WebObjectInfo object)
Returns an initialized
WebEvent to go to the Export page for an object. | ||||||||||
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 | isObjectRunableinPauseMode(WebObjectInfo object) | ||||||||||
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 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() |
Constant specifying the name of the formal parameter for defining which sections will be displayed in the Create Report page. Value is displaySection.
Constant specifying the name of the formal parameter for defining the datamart image. Value is datamartImage.
Constant specifying the name of the formal parameter for defining the document image. Value is documentImage.
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 specifying the name of the formal parameter for defining the filter image. Value is filterImage.
Constant specifying the name of the formal parameter for defining the folder image. Value is folderImage.
Constant specifying the name of the formal parameter for defining the graph image. Value is graphImage.
Constant specifying the name of the formal parameter for defining the gridGraph image. Value is gridGraphImage.
Constant specifying the name of the formal parameter for defining the image height. Value is imageHeight.
Constant specifying the name of the formal parameter for defining the image width. Value is imageWidth.
Constant specifying the name of the formal parameter for defining the level flag. Value is levelFlag.
Constant specifying the name of the formal parameter for defining the maximum object type count. Value is maxObjectTypeCount.
Constant specifying the name of the formal parameter for defining the report image. Value is reportImage.
Constant specifying the name of the formal parameter for defining the report writing document image. Value is rwDocumentImage.
Constant specifying the name of the formal parameter for defining the sort order of the folder contents. Value is sortAscending.
Constant specifying the name of the formal parameter for defining the field from which the folder contents will be sorted. Value is sortField.
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 specifying the name of the formal parameter for defining the template image. Value is templateImage.
Allowed value for the levelFlag
formal parameter.
Convenience flag that includes all possible LEVEL values.
Value = 16777215
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
Allowed value for the levelFlag
formal parameter.
Specifies that the folder transform will display a link for deleting the object.
Value = 16
Allowed value for the levelFlag
formal parameter.
Specifies that the folder transform will display object's description.
Value = 2
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
Allowed value for the levelFlag
formal parameter.
Specifies that the folder transform will display the link for editing the object.
Value = 64
Allowed value for the levelFlag
formal parameter.
Specifies that if the folder is empty, a message should be displayed about it
Value = 256
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
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
Allowed value for the levelFlag
formal parameter.
Specifies that the folder information (such as its description) will be displayed.
Value = 131072
Allowed value for the levelFlag
formal parameter.
Specifies that the folder transform includes incremental fetch arrows
Value = 4096
Allowed value for the levelFlag
formal parameter.
Specifies that the folder transform will display the object's location (folder path).
Value = 128
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
Allowed value for the levelFlag
formal parameter.
Specifies that the folder transform will display object's name.
Value = 1
Allowed value for the levelFlag
formal parameter.
Specifies that the folder transform will display object's owner.
Value = 4
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
Allowed value for the levelFlag
formal parameter.
Specifies that the folder transform will display the link for creating subscriptions to the object.
Value = 32
Property for holding the value specified to the imgHeight formal parameter
Property for holding the value specified to the imgWidth formal parameter
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.
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.
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.
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.
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.
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.
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.
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.
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.
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
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.
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.
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.
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.
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
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.
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.
Default no-argument constructor. Initializes formal parameters.
Add javascript dependence
Checks if all privileges and access control are enabled to create an iServer subscription for this object.
object | the corresponding WebObjectInfo |
---|
Checks if all privileges and access control are enabled to delete this object.
object | the corresponding WebObjectInfo |
---|
Checks if all privileges and access control are enabled to edit this object.
object | the corresponding WebObjectInfo |
---|
Checks if all privileges and access control are enabled to export this object.
object | the corresponding WebObjectInfo |
---|
Checks if all privileges and access control are enabled to export to PDF this object.
object | the corresponding WebObjectInfo |
---|
Checks if all privileges and access control are enabled to create a send-now subscription for this object.
object | the corresponding WebObjectInfo |
---|
Returns the context-menu specific attributes to assign to the context-menu container
object | WebObjectInfo |
---|
Returns an initialized WebEvent
to delete an object.
object | the WebObjectInfo instance of the object to delete. |
---|
WebEvent
instance initialized if possible, null
if the application doesn't support it.
Returns an initialized WebEvent
to delete an object.
object | the WebObjectInfo instance of the object to delete. |
---|
WebEvent
instance initialized if possible, null
if the application doesn't support it.Returns an initialized WebEvent
to edit an object.
object | the WebObjectInfo instance of the object to edit. |
---|
WebEvent
instance initialized if possible, null
if the application doesn't support it.
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.
object | a WebObjectInfo for which the "execution" event must be retrieved. |
---|
DssXmlTypeReportDefinition
, the REPORT_EVENT_EXECUTE
event,
DssXmlTypeFolder
, the FOLDER_EVENT_BROWSE
event.
DssXmlTypeDocumentDefinition
, the DOCUMENT_EVENT_EXECUTE_DOCUMENT
event.
DssXmlTypeFilter
, the WebEventSelectFilter
event.
DssXmlTypeTemplate
, the WebEventSelectTemplate
event.null
.
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.
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. |
WebEvent
object if the application supports it. Otherwise, will return null
.Returns an initialized WebEvent
to go to the Export page for an object. Currently this method handles only
DssXmlTypeReportDefinition
and
DssXmlTypeDocumentDefinition
objects.
object | the WebObjectInfo instance which will be exported if the event is called. |
---|
WebEvent
object if the application supports it. Otherwise, will return null
.
Returns an initialized WebEvent to go to the FlashExport page for an object. Currently this method handles only
DssXmlSubTypeReportWritingDocument
subtype objects.
object | the WebObjectInfo instance which will be exported if the event is called. |
---|
WebEvent
object if the application supports it. Otherwise, will return null
.getGoToEvent()
event where
the element to navigate to will be specified.
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
Returns web event to export VI Dashboard to .mstr format
object | the WebObjectInfo instance which will be exported if the event is called. |
---|
WebEvent
object if the application supports it. Otherwise, will return null
.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.
object | the WebObjectInfo instance which will be exported if the event is called. |
---|
WebEvent
object if the application supports it. Otherwise, will return null
.
Returns a WebEvent
to send an object through email
object | the WebObjectInfo of the object to send |
---|
WebEvent
instance if possible otherwise, null
if the application doesn't support it.
Returns (if possible) an initialized WebEvent
to go to the subscriptions of an object
object | the WebObjectInfo of the object to see its subscriptions |
---|
WebEvent
initialized if possible, null
if the application doesn't support it.
Get the class of objects this transform is able to handle, which are of the FolderBean
type.
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.
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.
This method initialize the private and protected fields of the transform. Extends initializeTransform by initializing the cache of this transform's Formal parameters.
data | Transformable instance with the bean to be transformed.
|
---|
Returns true
if the list of elements from this folder available for display
(getSortedList()
) is empty or not.
true
if the underlying object list is empty. 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.
feature | the feature to check for. |
---|
True
if the feature is available, otherwise returns False
.
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.
out | MarkupOutput instance where the transform's output will be saved. |
---|
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.
out | MarkupOutput instance where the transform's output will be saved. |
---|---|
folder | the WebFolder instance from the FolderBean being transformed. |
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.
out | MarkupOutput instance where to write the output of the method. |
---|---|
image | String with the image name to display
|
Renders the folder contents when it does have children, which will be obtained from the
getSortedChildUnits()
method.
out | MarkupOutput instance to modify with the transform's output. |
---|
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.
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. |
This method render the section that displays the number of objects found. Used for the report - all objects tab of the object browser
out | MarkupOutput |
---|
Transforms the assosciated WebBean
when its status is WebBeanRequestSuccessful
.
out | MarkupOutput instance where the contents of this transform will be saved.
|
---|
Check if the level parameter value contains this flag.
This method calls checkLevel(int, FormalParameter)
using the levelFlag
formal parameter.
level | flag value to check for. |
---|
Extends getContext()
by setting
to the context object a reference the current WebObjectInfo
Return the ContextMenu associated with the object
object | WebObjectInfo |
---|
ContextMenu
Get the folderBean target of this transform
FolderBean
instance used with this transform
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.
object | The WebObjectInfo for which it's image name is required. |
---|
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.
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.
object | The WebObjectInfo for which it's image name is required. |
---|
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.Return child count in the folde, including those shortcuts objects filtered out based on type restrictions
Returns a sorted list containing the folder's child units
WebDisplayUnits
} instance with the folder contents sorted as requested
by the sortField
and sortAscending
formal parameters of the transform.WebBeanException | if an error happens getting the child units |
---|---|
WebObjectsException | if an error happens getting the child units |
Initialize selected items list, based on the objectID request paramter. Each element
is separated by ;
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.
object | WebObjectInfo with the object to check for. |
---|
True
if the object is selected, otherwise returns False
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
object | WebObjectInfo with the object to check for. |
---|
True
if the object should be displayed, otherwise returns False
A report is viewable if its subtype is not EnumDSSXMLObjectSubTypes.DssXmlSubTypeReportDatamart, EnumDSSXMLObjectSubTypes.DssXmlSubTypeReportNonInteractive or EnumDSSXMLObjectSubTypes.DssXmlSubTypeReportCube
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.
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.
boneProps | the JsonGenerator object that contains the collection of bone properties. |
---|