Class InboxListXHTMLTransform
- java.lang.Object
-
- com.microstrategy.web.transform.AbstractTransform
-
- com.microstrategy.web.transform.AbstractLayoutTransform
-
- com.microstrategy.web.app.transforms.AbstractAppTransform
-
- com.microstrategy.web.app.transforms.InboxListXHTMLTransform
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
public class InboxListXHTMLTransform extends AbstractAppTransform implements LayoutTransform
Title: InboxListXHTMLTransform. The InboxListXHTMLTransform generates a list content of the user's Inbox. From this list, users can execute the corresponding inbox message, view its details or remove the message from the inbox.
The output of this Transform generates well-formed XHTML, and it's designed to use external css files for all formatting.- Since:
- MicroStrategy Web 8.0.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
InboxListXHTMLTransform.Context
ExtendsAbstractAppTransform.Context
by providing a link to the currentWebObjectInfo
.
-
Field Summary
Fields Modifier and Type Field Description FormalParameter
allowDocumentExecutionOnDetails
Specifies whether the user will be able to execute documents from the document details page.FormalParameter
allowReportExecutionOnDetails
Specifies whether the user will be able to execute reports from the report details page.static java.lang.String
CSS_MESSAGE_CUBE
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformstatic java.lang.String
CSS_MESSAGE_CUBE_ERROR
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformstatic java.lang.String
CSS_MESSAGE_CUBE_EXECUTING
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformstatic java.lang.String
CSS_MESSAGE_CUBE_SCHEDULED
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformstatic java.lang.String
CSS_MESSAGE_DATAMART
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformstatic java.lang.String
CSS_MESSAGE_DATAMART_ERROR
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformstatic java.lang.String
CSS_MESSAGE_DATAMART_EXECUTING
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformstatic java.lang.String
CSS_MESSAGE_DATAMART_SCHEDULED
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformstatic java.lang.String
CSS_MESSAGE_DOCUMENT
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformstatic java.lang.String
CSS_MESSAGE_DOCUMENT_ERROR
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformstatic java.lang.String
CSS_MESSAGE_DOCUMENT_SCHEDULED
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformstatic java.lang.String
CSS_MESSAGE_DOCUMENT_WAIT
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformstatic java.lang.String
CSS_MESSAGE_GRAPH
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformstatic java.lang.String
CSS_MESSAGE_GRAPH_ARCHIVED
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformstatic java.lang.String
CSS_MESSAGE_GRAPH_ERROR
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformstatic java.lang.String
CSS_MESSAGE_GRAPH_EXECUTING
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformstatic java.lang.String
CSS_MESSAGE_GRAPH_SCHEDULED
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformstatic java.lang.String
CSS_MESSAGE_GRID
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformstatic java.lang.String
CSS_MESSAGE_GRID_ARCHIVED
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformstatic java.lang.String
CSS_MESSAGE_GRID_ERROR
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformstatic java.lang.String
CSS_MESSAGE_GRID_EXECUTING
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformstatic java.lang.String
CSS_MESSAGE_GRID_GRAPH
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformstatic java.lang.String
CSS_MESSAGE_GRID_SCHEDULED
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformstatic java.lang.String
CSS_MESSAGE_RW
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformstatic java.lang.String
CSS_MESSAGE_RW_ERROR
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformstatic java.lang.String
CSS_MESSAGE_RW_SCHEDULED
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformstatic java.lang.String
CSS_MESSAGE_RW_WAIT
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformstatic java.lang.String
EXEC_TARGET
Constant used as the name for the formal parameter that determines how the user want's to execute the Report/Document object.FormalParameter
execTarget
Determines how the user want's to execute the Report/Document object.static int
LEVEL_ALL
Allowed value for thelevelFlag
formal parameter.static int
LEVEL_CREATION_TIME
Allowed value for thelevelFlag
formal parameter.static int
LEVEL_DETAILS
Allowed value for thelevelFlag
formal parameter.static int
LEVEL_EXPORT_EXCEL
Allowed value for thelevelFlag
formal parameter.static int
LEVEL_EXPORT_PDF
Allowed value for thelevelFlag
formal parameter.static int
LEVEL_FOOTER
Allowed value for thelevelFlag
formal parameter.static int
LEVEL_HEADER
Allowed value for thelevelFlag
formal parameter.static int
LEVEL_ICON
Allowed value for thelevelFlag
formal parameter.static int
LEVEL_MODIFICATION_TIME
Allowed value for thelevelFlag
formal parameter.static int
LEVEL_NAME
Allowed value for thelevelFlag
formal parameter.static int
LEVEL_REMOVE
Allowed value for thelevelFlag
formal parameter.static int
LEVEL_SORT_ICONS
Allowed value for thelevelFlag
formal parameter.static int
LEVEL_START_TIME
Allowed value for thelevelFlag
formal parameter.static int
LEVEL_STATUS
Allowed value for thelevelFlag
formal parameter.static int
LEVEL_UNREAD_LINK
Allowed value for thelevelFlag
formal parameter.FormalParameter
levelFlag
Specifies what information is displayed for each item in the inbox.FormalParameter
maxItemCount
Specifies the maximum number of objects to be displayed in the history list.-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
_bean, _componentBlock, _cssPrefix, _imgBlank, _imgWait, _selfOutput, _subOutput, appliesTo, CLASS_INPUT, CLASS_MESSAGE, contextMenus, cssFile, cssPrefix, debugErrorFlags, debugFlags, dragMode, extraInput, extraUrl, FP_APPLIES_TO, FP_CONTEXT_MENUS, FP_CSS_ERROR_MESSAGE, FP_CSS_ERROR_TITLE, FP_CSS_FILE, FP_CSS_PREFIX, FP_DEBUG_ERROR_FLAGS, FP_DEBUG_FLAGS, FP_DRAG_MODE, FP_EXTRA_INPUT, FP_EXTRA_URL, FP_HEIGHT, FP_IFRAME_ENABLED, FP_IMG_WAIT, FP_INITIAL_INDENT, FP_ORIENTATION, FP_ORIENTATIONS_ALLOWED, FP_PARTIAL_IFRAME_UPDATE, FP_PROCESSING_BUTTONS_FLAGS, FP_PROCESSING_INFO_FLAGS, FP_RESIZE_LEVEL, FP_SCRIPT_CLASS, FP_TYPE, FP_USE_DHTML, FP_WIDTH, globalCssErrorMessage, globalCssErrorTitle, height, iframeEnabled, imgWait, indent, initialIndent, isDHTML, orientation, orientationsAllowed, partialIframeUpdate, PROCESSING_BUTTONS_ALL, PROCESSING_BUTTONS_CANCEL, PROCESSING_BUTTONS_HISTORY_LIST, PROCESSING_BUTTONS_REFRESH, PROCESSING_BUTTONS_VIEW_DETAILS, PROCESSING_INFO_ALL, PROCESSING_INFO_DESCRIPTION, PROCESSING_INFO_LAST_UPDATE, PROCESSING_INFO_NAME, PROCESSING_INFO_NONE, PROCESSING_INFO_STATUS, processingButtonsFlags, processingInfoFlags, RESIZE_ALL, RESIZE_HORIZONTAL, RESIZE_NONE, RESIZE_VERTICAL, resizeLevel, scriptClass, scriptEndTagEncoder, type, useDHTML, width
-
-
Constructor Summary
Constructors Constructor Description InboxListXHTMLTransform()
Default constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
canExport(WebMessage message)
boolean
canMarkUnread(WebMessage message)
boolean
canPDF(WebMessage message)
boolean
canRemove(WebMessage message)
boolean
canRename(WebMessage mesg)
boolean
canShowDetails(WebMessage message)
protected AnchorTag
generateAnchor(WebEvent event)
Overwrites the parent method by setting special attributes if the event is not providedprotected Tag
generateColumnGroup()
Generates aCOLGROUP
HTML tag withCOL
tags defined for each one of the columns to be rendered on this transform.protected RowTag
generateHeadersRow()
Generates aTR
HTML tag withTD
tags defined for each one of the column headers to be rendered on this transform according to privileges and value assigned to thelevel
formal parameter.protected RowTag
generateItem(WebMessage message, boolean isParent)
Generates theRowTag
instance corresponding to the information of theWebMessage
sent in as parameter.protected RowTag[]
generateItems()
Analyzes all the items available on the inbox to display and generates an array ofRowTag
instances (corresponding toTR
HTML tags) with the information.protected TableTag
generateTable()
Generates aTABLE
HTML tag where all the contents of the inbox will be added as rows of this table.protected WebEvent
getCancelRenameEvent()
java.util.ArrayList
getChildMessages(WebMessage message)
Return the child messages for a Inbox messageprotected TransformContext
getContext()
ExtendsAbstractAppTransform.getContext()
by setting to the context object a reference the currentWebMessage
protected ContextMenu
getContextMenu(WebMessage mesg)
Return the ContextMenu associated with the objectjava.util.Map
getContextMenuAttributes(WebMessage mesg)
Returns the context-menu specific attributes to assign to the context-menu containerprotected java.lang.String
getCssName(WebMessage message)
Generate the css name to be associated with the message icon, depending on its request type and its current state.protected java.lang.String
getDerivedCssName(WebMessage message)
Generated a css name to be associated with the message, for cases when a report message is child of a document, or when a document has a children list to be collapsed or expanded.java.lang.String
getDescription()
Returns the descriptor to use in the Style Catalog.WebEvent
getDetailsEvent(WebMessage message)
protected WebEvent
getEditRenameEvent()
WebEvent
getEditRenameEvent(WebMessage msg)
protected WebEvent
getEventForMessage(WebMessage message)
protected WebEvent
getExecuteEvent(WebMessage message)
Generate the event to use if the current message is to be executed in some way.WebEvent
getExportEvent(WebMessage message)
Returns an initialized WebEvent to go to the Export page for an object.protected int
getFieldCount()
java.util.Map
getMainTableAttributes()
Return the Summary Attribute to be used in the table for the transform.WebEvent
getMarkUnreadEvent(WebMessage message)
java.util.Map
getMessageAttributes(WebMessage webMessage)
Return the Summary Attribute to be used in the table for the transform.protected java.lang.String
getMessageRowCssName(WebMessage message)
Obtain the css to be associated to the message on the table row (TR
tag) to generate for it.java.util.ArrayList
getMessages()
Return the list of Inbox MessagesWebEvent
getPDFExportEvent(WebMessage message)
Returns an initialized WebEvent to go to the PDF Export page for an object.protected WebEvent
getRemoveEvent()
Generate the event to be used for commanding the removal of an element listed on the inbox contents.WebEvent
getRemoveEvent(WebMessage message)
WebEvent
getRenameEvent()
protected WebEvent
getSortEvent()
Generate the event to be used for commanding the sort of the information present on the inbox.java.lang.Class
getSupportedBeanType()
Get the class of objects this transform is able to handle.void
initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.boolean
isInboxEmpty()
Returns true if there are no messages in Inbox.protected TransformContext
newContext()
Creates a new instance of a TransformContext.void
renderCreateTimeInfo(MarkupOutput out, WebMessage message)
Renders the creation time, ie the time that this Inbox Message was created within the Intelligence Server.void
renderDetailsInfo(MarkupOutput out, WebMessage message)
Render an icon with a link for job detailsvoid
renderEmptyList(MarkupOutput out)
void
renderEmptySpaceIcon(MarkupOutput out)
void
renderExpandMessageIcon(MarkupOutput out, WebMessage message)
Renders the image information required for documents to render a list with their children information.void
renderExportInfo(MarkupOutput out, WebMessage message)
Render an icon for exporting the messagevoid
renderFooter(MarkupOutput out)
Renders a status bar message for the history list tablevoid
renderFormEnd(MarkupOutput out)
Renders theFORM
tag end information.void
renderFormStart(MarkupOutput out)
Renders theFORM
tag start informationvoid
renderIconInfo(MarkupOutput out, WebMessage message)
Write out the image information for a single message.void
renderLayeredIconInfo(MarkupOutput out, WebMessage message)
Similar torenderIconInfo(com.microstrategy.web.beans.MarkupOutput, com.microstrategy.web.objects.WebMessage)
, but instead of generating an IMG tag, having a transparent image as its source and a background image assigned via the CSS style, it will now generate a SPAN tag which will have the same css class defined (where the background image is indicated) and an inner SPAN for the layering effect, in case an additional image has to be included, on top of the original (for example, a shortcut arrow, a red error sign, etc).void
renderMarkUnread(MarkupOutput out, WebMessage message)
void
renderModificationTimeInfo(MarkupOutput out, WebMessage message)
Renders the message's modification timevoid
renderNameInfo(MarkupOutput out, WebMessage message)
Write out the name information for a single message.void
renderPDFExportInfo(MarkupOutput out, WebMessage message)
Render an icon for exporting to PDF the messagevoid
renderRemoveButton(MarkupOutput out)
Render the remove button in the inbox pagevoid
renderRemoveInfo(MarkupOutput out, WebMessage message)
Renders a checkbox so the user can remove the messagevoid
renderRenameIcon(MarkupOutput out, WebMessage message)
void
renderRenameWidgets(MarkupOutput out, WebMessage message)
void
renderSort(MarkupOutput out, int field)
Deprecated.the sort can be rendered usingrenderSortingTitle(MarkupOutput, int, int)
void
renderSortingTitle(MarkupOutput out, int name, int field)
function for rendering the title with sortingvoid
renderStartTimeInfo(MarkupOutput out, WebMessage message)
Renders the start request time, ie the time when the job started executing.void
renderStatusInfo(MarkupOutput out, WebMessage message)
Render the status of the message.void
transformForRequestSuccessful(MarkupOutput out)
Transform when the status is "Successful".-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchorForExport, generateHiddenInputsForEvent, generateIFrameTag, getAppContext, getArgumentName, getAttributesShellDiv, getBeanPath, getBoneId, getCancelEvent, getClientSideHelper, getContainerServices, getContextMenu, getContextMenuManager, getContextMenuManagerName, getContextMenusDefinition, getCssPrefix, getDateFormat, getDebugOut, getDescriptor, getDescriptor, getDescriptor, getDescriptor, getDisplayMode, getDisplayName, getErrorMessage, getErrorMessage, getErrorTitle, getErrorTitle, getEventManager, getFirstDayOfWeek, getFloatValue, getHelpPath, getID, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getLocale, getPreferenceValue, getProjectID, getRefreshEvent, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, initializeImages, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, renderBean, renderBean, renderBean, renderBean, renderCancelButton, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderImage, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderRegisterBone, renderSelf, renderShell, renderSubBlock, renderUserHelpAnchor, setBoneProperties, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, transformForRequestInError, transformForRequestNotInited, transformForRequestProcessing, transformForRequestWaitingForUserInput
-
Methods inherited from class com.microstrategy.web.transform.AbstractLayoutTransform
getLayoutDefinition, setLayoutDefinition, transformUsingLayout
-
Methods inherited from class com.microstrategy.web.transform.AbstractTransform
addFormalParam, canTransform, getEvents, getFormalParams, getPreview, isPreviewAvailable, isResolved, removeFormalParam, setAnnotation, setDeprecated, supports, supports
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.microstrategy.web.transform.LayoutTransform
getLayoutDefinition, setLayoutDefinition
-
Methods inherited from interface com.microstrategy.web.transform.Transform
canTransform, getFormalParams, getID, getPreview, isPreviewAvailable, isResolved, supports, supports, transform
-
-
-
-
Field Detail
-
LEVEL_ICON
public static final int LEVEL_ICON
Allowed value for thelevelFlag
formal parameter. Specifies that the folder transform will display object's icon.
Value = 1- See Also:
- Constant Field Values
-
LEVEL_NAME
public static final int LEVEL_NAME
Allowed value for thelevelFlag
formal parameter. Specifies that the folder transform will display object's name.
Value = 2- See Also:
- Constant Field Values
-
LEVEL_STATUS
public static final int LEVEL_STATUS
Allowed value for thelevelFlag
formal parameter. Specifies that the folder transform will display object's status.
Value = 4- See Also:
- Constant Field Values
-
LEVEL_START_TIME
public static final int LEVEL_START_TIME
Allowed value for thelevelFlag
formal parameter. Specifies that the folder transform will display object's time information.
Value = 8- See Also:
- Constant Field Values
-
LEVEL_DETAILS
public static final int LEVEL_DETAILS
Allowed value for thelevelFlag
formal parameter. Specifies that the folder transform will display object's link to details.
Value = 16- See Also:
- Constant Field Values
-
LEVEL_REMOVE
public static final int LEVEL_REMOVE
Allowed value for thelevelFlag
formal parameter. Specifies that the folder transform will display object's option to be removed.
Value = 32- See Also:
- Constant Field Values
-
LEVEL_SORT_ICONS
public static final int LEVEL_SORT_ICONS
Allowed value for thelevelFlag
formal parameter. Specifies that the folder transform will display sort buttons.
Value = 64- See Also:
- Constant Field Values
-
LEVEL_HEADER
public static final int LEVEL_HEADER
Allowed value for thelevelFlag
formal parameter. Specifies that it is requested the folder transform to display the header.
Value = 128- See Also:
- Constant Field Values
-
LEVEL_FOOTER
public static final int LEVEL_FOOTER
Allowed value for thelevelFlag
formal parameter. Specifies that it is requested the folder transform to display the footer.
Value = 256- See Also:
- Constant Field Values
-
LEVEL_UNREAD_LINK
public static final int LEVEL_UNREAD_LINK
Allowed value for thelevelFlag
formal parameter. Specifies that it is requested the folder transform to display the link to mark message as unread.
Value = 512- See Also:
- Constant Field Values
-
LEVEL_EXPORT_EXCEL
public static final int LEVEL_EXPORT_EXCEL
Allowed value for thelevelFlag
formal parameter. Specifies that the folder transform will display object's option to be exported to excel.
Value = 1024- See Also:
- Constant Field Values
-
LEVEL_EXPORT_PDF
public static final int LEVEL_EXPORT_PDF
Allowed value for thelevelFlag
formal parameter. Specifies that the folder transform will display object's option to be exported to excel.
Value = 2048- See Also:
- Constant Field Values
-
LEVEL_CREATION_TIME
public static final int LEVEL_CREATION_TIME
Allowed value for thelevelFlag
formal parameter. Specifies that the folder transform will display the message's creation time.
Value = 4096- See Also:
- Constant Field Values
-
LEVEL_MODIFICATION_TIME
public static final int LEVEL_MODIFICATION_TIME
Allowed value for thelevelFlag
formal parameter. Specifies that the folder transform will display the message's modification time.
Value = 8192- See Also:
- Constant Field Values
-
LEVEL_ALL
public static final int LEVEL_ALL
Allowed value for thelevelFlag
formal parameter. Convenience flag to indicate all enabled LEVEL values.
Value = 65535- See Also:
- Constant Field Values
-
levelFlag
public FormalParameter levelFlag
Specifies what information is displayed for each item in the inbox.
The information may include object icon, name, status and other information. Multiple fields may be displayed at the same time.
Which fields to show is indicated by a bitwise flag. This specifies fields like icon, name, status etc. This flag is used as a bit-wise flag.
Allowed Values:
- Icon = 1
- Name = 2
- Status = 4
For complete list, seeLEVEL_ICON
,LEVEL_STATUS
,LEVEL_START_TIME
,LEVEL_DETAILS
LEVEL_REMOVE
,LEVEL_SORT_ICONS
,LEVEL_HEADER
,LEVEL_FOOTER
,LEVEL_EXPORT_EXCEL
,LEVEL_EXPORT_PDF
,LEVEL_UNREAD_LINK
,LEVEL_ALL
Usage:
For example, if you want to specify icon and status, then you would specify (1 + 4 = 5)
Default value:
LEVEL_HEADER
+LEVEL_SORT_ICONS
+LEVEL_FOOTER
+LEVEL_ICON
+LEVEL_NAME
+LEVEL_STATUS
+LEVEL_UNREAD_LINK
+LEVEL_START_TIME
+LEVEL_EXPORT_EXCEL
+LEVEL_EXPORT_PDF
+LEVEL_DETAILS
+LEVEL_REMOVE
-
allowReportExecutionOnDetails
public FormalParameter allowReportExecutionOnDetails
Specifies whether the user will be able to execute reports from the report details page.
Allowed values:
- true
- false
Usage:
For example, if you allow to execute reports from the details page, then you would specify (true).
-
allowDocumentExecutionOnDetails
public FormalParameter allowDocumentExecutionOnDetails
Specifies whether the user will be able to execute documents from the document details page.
Allowed values:
- true
- false
Usage:
For example, if you allow to execute documents from the details page, then you would specify (true).
-
maxItemCount
public FormalParameter maxItemCount
Specifies the maximum number of objects to be displayed in the history list.
The default value is -1, which indicates that all the objects will be rendered.
Usage:
For example, if you want to show only 5 objects in the history list, you would need to set (5) in this formal parameter.
-
execTarget
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.
-
CSS_MESSAGE_GRAPH_ERROR
public static final java.lang.String CSS_MESSAGE_GRAPH_ERROR
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformConstant used as the CSS class for graph messages that ends in error- See Also:
- Constant Field Values
-
CSS_MESSAGE_GRAPH_ARCHIVED
public static final java.lang.String CSS_MESSAGE_GRAPH_ARCHIVED
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformConstant used as the CSS class for graph messages stored in the inbox- See Also:
- Constant Field Values
-
CSS_MESSAGE_GRAPH_SCHEDULED
public static final java.lang.String CSS_MESSAGE_GRAPH_SCHEDULED
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformConstant used as the CSS class for graph messages that were originated from a web-scheduled- See Also:
- Constant Field Values
-
CSS_MESSAGE_GRAPH
public static final java.lang.String CSS_MESSAGE_GRAPH
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformConstant used as the CSS class for graph messages- See Also:
- Constant Field Values
-
CSS_MESSAGE_GRAPH_EXECUTING
public static final java.lang.String CSS_MESSAGE_GRAPH_EXECUTING
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformConstant used as the CSS class for graph messages that are still executing- See Also:
- Constant Field Values
-
CSS_MESSAGE_GRID_GRAPH
public static final java.lang.String CSS_MESSAGE_GRID_GRAPH
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformConstant used as the CSS class for grid-graph messages- See Also:
- Constant Field Values
-
CSS_MESSAGE_DATAMART_ERROR
public static final java.lang.String CSS_MESSAGE_DATAMART_ERROR
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformConstant used as the CSS class for datamart messages that end in error- See Also:
- Constant Field Values
-
CSS_MESSAGE_CUBE_ERROR
public static final java.lang.String CSS_MESSAGE_CUBE_ERROR
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformConstant used as the CSS class for cube messages that end in error- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
CSS_MESSAGE_GRID_ERROR
public static final java.lang.String CSS_MESSAGE_GRID_ERROR
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformConstant used as the CSS class for grid messages that end in error- See Also:
- Constant Field Values
-
CSS_MESSAGE_DATAMART_SCHEDULED
public static final java.lang.String CSS_MESSAGE_DATAMART_SCHEDULED
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformConstant used as the CSS class for datamart messages originated from a web-schedule- See Also:
- Constant Field Values
-
CSS_MESSAGE_CUBE_SCHEDULED
public static final java.lang.String CSS_MESSAGE_CUBE_SCHEDULED
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformConstant used as the CSS class for cube messages originated from a web-schedule- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
CSS_MESSAGE_DATAMART
public static final java.lang.String CSS_MESSAGE_DATAMART
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformConstant used as the CSS class for datamart messages- See Also:
- Constant Field Values
-
CSS_MESSAGE_CUBE
public static final java.lang.String CSS_MESSAGE_CUBE
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformConstant used as the CSS class for cube messages- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
CSS_MESSAGE_GRID_ARCHIVED
public static final java.lang.String CSS_MESSAGE_GRID_ARCHIVED
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformConstant used as the CSS class for grid messages stored in the inbox- See Also:
- Constant Field Values
-
CSS_MESSAGE_GRID_SCHEDULED
public static final java.lang.String CSS_MESSAGE_GRID_SCHEDULED
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformConstant used as the CSS class for grid messages that were originated from a web-schedule- See Also:
- Constant Field Values
-
CSS_MESSAGE_GRID
public static final java.lang.String CSS_MESSAGE_GRID
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformConstant used as the CSS class for grid messages- See Also:
- Constant Field Values
-
CSS_MESSAGE_DATAMART_EXECUTING
public static final java.lang.String CSS_MESSAGE_DATAMART_EXECUTING
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformConstant used as the CSS class for datamart messages that are still executing- See Also:
- Constant Field Values
-
CSS_MESSAGE_CUBE_EXECUTING
public static final java.lang.String CSS_MESSAGE_CUBE_EXECUTING
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformConstant used as the CSS class for datamart messages that are still executing- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
CSS_MESSAGE_GRID_EXECUTING
public static final java.lang.String CSS_MESSAGE_GRID_EXECUTING
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformConstant used as the CSS class for grid messages that are still executing- See Also:
- Constant Field Values
-
CSS_MESSAGE_DOCUMENT_ERROR
public static final java.lang.String CSS_MESSAGE_DOCUMENT_ERROR
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformConstant used as the CSS class for html-document messages that ends in error- See Also:
- Constant Field Values
-
CSS_MESSAGE_DOCUMENT_SCHEDULED
public static final java.lang.String CSS_MESSAGE_DOCUMENT_SCHEDULED
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformConstant used as the CSS class for html-document messages that were originated from a web-schedule- See Also:
- Constant Field Values
-
CSS_MESSAGE_DOCUMENT
public static final java.lang.String CSS_MESSAGE_DOCUMENT
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformConstant used as the CSS class for html-document messages- See Also:
- Constant Field Values
-
CSS_MESSAGE_DOCUMENT_WAIT
public static final java.lang.String CSS_MESSAGE_DOCUMENT_WAIT
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformConstant used as the CSS class for html-document messages that are still executing- See Also:
- Constant Field Values
-
CSS_MESSAGE_RW_ERROR
public static final java.lang.String CSS_MESSAGE_RW_ERROR
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformConstant used as the CSS class for Document messages that ends in error- See Also:
- Constant Field Values
-
CSS_MESSAGE_RW_SCHEDULED
public static final java.lang.String CSS_MESSAGE_RW_SCHEDULED
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformConstant used as the CSS class for document messages that were originated from a web-schedule- See Also:
- Constant Field Values
-
CSS_MESSAGE_RW
public static final java.lang.String CSS_MESSAGE_RW
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformConstant used as the CSS class for document messages- See Also:
- Constant Field Values
-
CSS_MESSAGE_RW_WAIT
public static final java.lang.String CSS_MESSAGE_RW_WAIT
Deprecated.Please review thegetCssName(com.microstrategy.web.objects.WebMessage)
method output for the CSS classes generated by this transformConstant used as the CSS class for document messages that are still executing- See Also:
- Constant Field Values
-
EXEC_TARGET
public static final java.lang.String EXEC_TARGET
Constant used as the name for the formal parameter that 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.- See Also:
- Constant Field Values
-
-
Method Detail
-
getDescription
public java.lang.String getDescription()
Returns the descriptor to use in the Style Catalog.- Specified by:
getDescription
in interfaceTransform
- Returns:
- "This implements the transform for an Inbox Bean"
-
initializeTransform
public void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.- Specified by:
initializeTransform
in interfaceAppTransform
- Overrides:
initializeTransform
in classAbstractAppTransform
- Parameters:
data
-Transformable
instance with the bean to be transformed.
-
generateTable
protected TableTag generateTable()
Generates aTABLE
HTML tag where all the contents of the inbox will be added as rows of this table. Basic HTML attributes are defined to it, such asclass
.- Returns:
- a
TableTag
instance defined, by default no rows or other information are added to it. Methods likegenerateHeadersRow
andgenerateItems
should be called for obtaining the information that shall be added to it.
-
generateColumnGroup
protected Tag generateColumnGroup()
Generates aCOLGROUP
HTML tag withCOL
tags defined for each one of the columns to be rendered on this transform. For example, the content might look like this:<colgroup> <col class=typ /> <col class=nam /> <col class=sta /> <col class=mct /> </colgroup>
- Returns:
Tag
instance corresponding to theCOLGROUP
HTML tag.
-
canExport
public boolean canExport(WebMessage message)
- Since:
- MicroStrategy Web 9.0.0
-
canPDF
public boolean canPDF(WebMessage message)
- Since:
- MicroStrategy Web 9.0.0
-
canShowDetails
public boolean canShowDetails(WebMessage message)
- Since:
- MicroStrategy Web 9.0.0
-
renderSort
public void renderSort(MarkupOutput out, int field)
Deprecated.the sort can be rendered usingrenderSortingTitle(MarkupOutput, int, int)
Utility method for rendering a sort button linked to the event that triggers it.- Parameters:
out
-MarkupOutput
instance where the contents of this transform will be saved.field
- integer value that defines the type of sort to be executed if requested
-
renderSortingTitle
public void renderSortingTitle(MarkupOutput out, int name, int field)
function for rendering the title with sorting- Parameters:
out
-MarkupOutput
instance where the contents of this transform will be saved.name
- Integer value that defines the name of title to be executedfield
- Integer value that defines the type of sort to be executed if requested
-
getContextMenuAttributes
public java.util.Map getContextMenuAttributes(WebMessage mesg)
Returns the context-menu specific attributes to assign to the context-menu container- Parameters:
mesg
-- Returns:
- Map
- Since:
- MicroStrategy Web 9.0.0
-
getContextMenu
protected ContextMenu getContextMenu(WebMessage mesg)
Return the ContextMenu associated with the object- Parameters:
mesg
-WebMessage
- Returns:
- ContextMenu
ContextMenu
- Since:
- MicroStrategy Web 9.0.0
-
getContext
protected TransformContext getContext()
ExtendsAbstractAppTransform.getContext()
by setting to the context object a reference the currentWebMessage
- Overrides:
getContext
in classAbstractAppTransform
- Since:
- MicroStrategy Web 9.0.0
- See Also:
AbstractAppTransform.getContextMenu(java.lang.String)
-
newContext
protected TransformContext newContext()
Description copied from class:AbstractAppTransform
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.- Overrides:
newContext
in classAbstractAppTransform
- Since:
- MicroStrategy Web 9.0.0
-
generateHeadersRow
protected RowTag generateHeadersRow()
Generates aTR
HTML tag withTD
tags defined for each one of the column headers to be rendered on this transform according to privileges and value assigned to thelevel
formal parameter. For example, the content might look like this:<tr> <td> </td> <td>Name</td> <td>Status</td> <td>Last Execution Time</td> </tr>
- Returns:
RowTag
instance corresponding to theTR
HTML tag where the headers were defined.
-
getSortEvent
protected WebEvent getSortEvent()
Generate the event to be used for commanding the sort of the information present on the inbox.- Returns:
WebEvent
intialized instance, if the event is supported by the application. By default, returns theEnumInboxBeanEvents.INBOX_EVENT_SORT_MESSAGES
event.
-
getRemoveEvent
protected WebEvent getRemoveEvent()
Generate the event to be used for commanding the removal of an element listed on the inbox contents.- Returns:
WebEvent
intialized instance, if the event is supported by the application. By default, returns theEnumInboxBeanEvents.INBOX_EVENT_REMOVE_MESSAGES
event.
-
generateItems
protected RowTag[] generateItems()
Analyzes all the items available on the inbox to display and generates an array ofRowTag
instances (corresponding toTR
HTML tags) with the information.- Returns:
- RowTag[] an array of
RowTag
instances, each one with the information of one message on the inbox being transformed. If no message is found to render, returns a simple row indicating so.
-
renderEmptyList
public void renderEmptyList(MarkupOutput out)
-
generateItem
protected RowTag generateItem(WebMessage message, boolean isParent)
Generates theRowTag
instance corresponding to the information of theWebMessage
sent in as parameter.- Parameters:
message
-WebMessage
message to render.- Returns:
- a
RowTag
(TR
HTML tag) with the information about theWebMessage
instance requested contained onCellTag
child instances. For example, icon image, name, status, etc.
-
renderFormStart
public void renderFormStart(MarkupOutput out)
Renders theFORM
tag start information- Parameters:
out
-MarkupOutput
instance where the transform's output will be saved.
-
renderFormEnd
public void renderFormEnd(MarkupOutput out)
Renders theFORM
tag end information.- Parameters:
out
-MarkupOutput
instance where the transform's output will be saved.
-
renderEmptySpaceIcon
public void renderEmptySpaceIcon(MarkupOutput out)
-
renderExpandMessageIcon
public void renderExpandMessageIcon(MarkupOutput out, WebMessage message)
Renders the image information required for documents to render a list with their children information.- Parameters:
out
-MarkupOutput
instance where the transform's output will be saved.message
-WebMessage
instance being rendered
-
getFieldCount
protected int getFieldCount()
- Returns:
- the number fields this transform is displaying, this will depend on the fields that are enabled through the levelFlags formal parameter
-
transformForRequestSuccessful
public void transformForRequestSuccessful(MarkupOutput out)
Transform when the status is "Successful".- Specified by:
transformForRequestSuccessful
in classAbstractAppTransform
- Parameters:
out
-MarkupOutput
instance where the transform's output will be saved.- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
renderLayeredIconInfo
public void renderLayeredIconInfo(MarkupOutput out, WebMessage message)
Similar torenderIconInfo(com.microstrategy.web.beans.MarkupOutput, com.microstrategy.web.objects.WebMessage)
, but instead of generating an IMG tag, having a transparent image as its source and a background image assigned via the CSS style, it will now generate a SPAN tag which will have the same css class defined (where the background image is indicated) and an inner SPAN for the layering effect, in case an additional image has to be included, on top of the original (for example, a shortcut arrow, a red error sign, etc).- Parameters:
out
-MarkupOutput
instance where to save the contents to displaymessage
-WebMessage
instance being rendered- Since:
- MicroStrategy Web 9.0.0
-
renderIconInfo
public void renderIconInfo(MarkupOutput out, WebMessage message)
Write out the image information for a single message. The css class of the image (which defines the GIF to use) is determined by the message type. The image will be rendered as a link if the event according to the object type, provided by thegetExecuteEvent()
method, is available and gives access to it.
The image is provided in a CSS file and set on theImageTag
tag so it gets rendered.- Parameters:
out
-MarkupOutput
instance where to save the contents to displaymessage
-WebMessage
instance being rendered
-
renderNameInfo
public void renderNameInfo(MarkupOutput out, WebMessage message)
Write out the name information for a single message. The name will be rendered as a link if the event according to the object type, provided by thegetExecuteEvent()
method, is available and gives access to it.
The link is built using thegenerateAnchor()
method, using the event obtained from thegetExecuteEvent()
method as an attribute. Once this is done, the title for the message is simply appended to the contents of the tag.- Parameters:
out
-MarkupOutput
instance where to save the contents to displaymessage
-WebMessage
instance being rendered
-
renderRenameWidgets
public void renderRenameWidgets(MarkupOutput out, WebMessage message)
- Since:
- MicroStrategy Web 9.0.0
-
getEventForMessage
protected WebEvent getEventForMessage(WebMessage message)
- Since:
- MicroStrategy Web 8.0.1
-
renderStatusInfo
public void renderStatusInfo(MarkupOutput out, WebMessage message)
Render the status of the message. If status is "Read" then it also renders a link to mark as unread.- Parameters:
out
-MarkupOutput
instance where to save the contents to displaymessage
-WebMessage
instance being rendered
-
canMarkUnread
public boolean canMarkUnread(WebMessage message)
- Since:
- MicroStrategy Web 9.0.0
-
renderMarkUnread
public void renderMarkUnread(MarkupOutput out, WebMessage message)
-
getMarkUnreadEvent
public WebEvent getMarkUnreadEvent(WebMessage message)
-
renderStartTimeInfo
public void renderStartTimeInfo(MarkupOutput out, WebMessage message)
Renders the start request time, ie the time when the job started executing. This is the column used by Microstrategy Web out of the box with title "Message Creation Time".- Parameters:
out
-MarkupOutput
instance where to save the contents to displaymessage
-WebMessage
instance being rendered
-
renderCreateTimeInfo
public void renderCreateTimeInfo(MarkupOutput out, WebMessage message)
Renders the creation time, ie the time that this Inbox Message was created within the Intelligence Server. An inbox message may be created by starting a new report instance or by duplicating an existing Inbox Message.- Parameters:
out
-MarkupOutput
instance where to save the contents to displaymessage
-WebMessage
instance being rendered
-
renderModificationTimeInfo
public void renderModificationTimeInfo(MarkupOutput out, WebMessage message)
Renders the message's modification time- Parameters:
out
-MarkupOutput
instance where to save the contents to displaymessage
-WebMessage
instance being rendered
-
renderExportInfo
public void renderExportInfo(MarkupOutput out, WebMessage message)
Render an icon for exporting the message- Parameters:
out
-MarkupOutput
instance where to save the contents to displaymessage
-WebMessage
instance being rendered
-
renderPDFExportInfo
public void renderPDFExportInfo(MarkupOutput out, WebMessage message)
Render an icon for exporting to PDF the message- Parameters:
out
-MarkupOutput
instance where to save the contents to displaymessage
-WebMessage
instance being rendered
-
renderDetailsInfo
public void renderDetailsInfo(MarkupOutput out, WebMessage message)
Render an icon with a link for job details- Parameters:
out
-MarkupOutput
instance where to save the contents to displaymessage
-WebMessage
instance being rendered
-
generateAnchor
protected AnchorTag generateAnchor(WebEvent event)
Overwrites the parent method by setting special attributes if the event is not provided- Overrides:
generateAnchor
in classAbstractAppTransform
- Parameters:
event
- WebEvent- Returns:
- AnchorTag
-
getDetailsEvent
public WebEvent getDetailsEvent(WebMessage message)
-
getEditRenameEvent
public WebEvent getEditRenameEvent(WebMessage msg)
- Since:
- MicroStrategy Web 9.0.0
-
getRenameEvent
public WebEvent getRenameEvent()
- Since:
- MicroStrategy Web 9.0.0
-
getEditRenameEvent
protected WebEvent getEditRenameEvent()
- Since:
- MicroStrategy Web 9.0.0
-
getCancelRenameEvent
protected WebEvent getCancelRenameEvent()
- Since:
- MicroStrategy Web 9.0.0
-
canRemove
public boolean canRemove(WebMessage message)
- Since:
- MicroStrategy Web 9.0.0
-
renderRemoveInfo
public void renderRemoveInfo(MarkupOutput out, WebMessage message)
Renders a checkbox so the user can remove the message- Parameters:
out
-MarkupOutput
instance where to save the contents to displaymessage
-WebMessage
instance being rendered
-
getRemoveEvent
public WebEvent getRemoveEvent(WebMessage message)
- Since:
- MicroStrategy Web 9.0.0
-
renderFooter
public void renderFooter(MarkupOutput out)
Renders a status bar message for the history list table- Parameters:
out
-MarkupOutput
instance where to save the contents to display
-
getMessageRowCssName
protected java.lang.String getMessageRowCssName(WebMessage message)
Obtain the css to be associated to the message on the table row (TR
tag) to generate for it.- Parameters:
message
-WebMessage
instance being analyzed- Returns:
- String value with the css name to use on the
TR
tag where this message is being displayed. May return an empty string if no special css is needed for the it.
-
getCssName
protected java.lang.String getCssName(WebMessage message)
Generate the css name to be associated with the message icon, depending on its request type and its current state.- Parameters:
message
-WebMessage
instance being analyzed- Returns:
- String value with the css name to use for the image of the message being rendered.
-
getDerivedCssName
protected java.lang.String getDerivedCssName(WebMessage message)
Generated a css name to be associated with the message, for cases when a report message is child of a document, or when a document has a children list to be collapsed or expanded.- Parameters:
message
-WebMessage
instance being analyzed- Returns:
- String value with the css to be used for a secondary image associated with the message being analyzed. It may return an empty string if none is needed.
-
getExecuteEvent
protected WebEvent getExecuteEvent(WebMessage message)
Generate the event to use if the current message is to be executed in some way.- Parameters:
message
-WebMessage
instance being analyzed- Returns:
- a
WebEvent
instance initialized to execute the message. Returnsnull
if the application won't support it. Samples of events returned may beEnumReportBeanEvents.REPORT_EVENT_EXECUTE
for messages of type report,EnumDocumentBeanEvents.DOCUMENT_EVENT_EXECUTE_DOCUMENT
for documents, andEnumRWBeanEvents.REPORT_WRITER_EVENT_EXECUTE
for report writing documents.
-
getExportEvent
public WebEvent getExportEvent(WebMessage message)
Returns an initialized WebEvent to go to the Export page for an object. Currently this method handles only report and report writing messages.- Parameters:
message
- theWebMessage
instance which will be exported if the event is called.- Returns:
- an initialized
WebEvent
object if the application supports it. Otherwise, will returnnull
. The events it may return includeEnumServletEvents.WebEventOpenExportOptionsFromReport
for reports, andEnumServletEvents.WebEventReportWritingDocumentPDFFastExport
for report writing documents.
-
getPDFExportEvent
public WebEvent getPDFExportEvent(WebMessage message)
Returns an initialized WebEvent to go to the PDF Export page for an object. Currently this method handles only report objects.- Parameters:
message
- theWebMessage
instance which will be exported if the event is called.- Returns:
- an initialized
WebEvent
object if the application supports it. Otherwise, will returnnull
. The events it may return includeEnumServletEvents.WebEventFastPDFExport
for reports, andEnumServletEvents.WebEventReportWritingDocumentPDFFastExport
for report writing documents.
-
getSupportedBeanType
public java.lang.Class getSupportedBeanType()
Get the class of objects this transform is able to handle.- Specified by:
getSupportedBeanType
in interfaceTransform
- Overrides:
getSupportedBeanType
in classAbstractAppTransform
- Returns:
- a
Class
instance with the information about the beans this transform is able to manipulate.
-
getMainTableAttributes
public java.util.Map getMainTableAttributes()
Return the Summary Attribute to be used in the table for the transform.- Returns:
java.util.Map
with the attribute name (as key) and the value.- Since:
- MicroStrategy Web 8.0.1
-
getMessageAttributes
public java.util.Map getMessageAttributes(WebMessage webMessage)
Return the Summary Attribute to be used in the table for the transform.- Returns:
java.util.Map
with the attribute name (as key) and the value.- Since:
- MicroStrategy Web 8.0.1
-
renderRemoveButton
public void renderRemoveButton(MarkupOutput out)
Render the remove button in the inbox page- Parameters:
out
- - the MarkupOutput instace to append the information- Since:
- MicroStrategy Web 8.0.1
-
getMessages
public java.util.ArrayList getMessages()
Return the list of Inbox Messages- Returns:
- an ArrayList containing the top level inbox messages.
- Since:
- MicroStrategy Web 8.0.1
-
getChildMessages
public java.util.ArrayList getChildMessages(WebMessage message)
Return the child messages for a Inbox message- Parameters:
message
- - message you are interested in- Returns:
- ArrayList of the childMessages
- Since:
- MicroStrategy Web 8.0.1
-
isInboxEmpty
public boolean isInboxEmpty()
Returns true if there are no messages in Inbox.- Returns:
- true if Inbox is empty
- Since:
- MicroStrategy Web 8.0.1
-
canRename
public boolean canRename(WebMessage mesg)
- Since:
- MicroStrategy Web 9.0.0
-
renderRenameIcon
public void renderRenameIcon(MarkupOutput out, WebMessage message)
- Since:
- MicroStrategy Web 9.0.0
-
-