Class InboxExtrasTransform
- java.lang.Object
-
- com.microstrategy.web.transform.AbstractTransform
-
- com.microstrategy.web.transform.AbstractLayoutTransform
-
- com.microstrategy.web.app.transforms.AbstractAppTransform
-
- com.microstrategy.web.app.transforms.InboxExtrasTransform
-
- All Implemented Interfaces:
AppTransform
,Transform
- Direct Known Subclasses:
InboxToolbarTransform
public class InboxExtrasTransform extends AbstractAppTransform
Title: InboxExtrasTransform.
Description: This implements the inbox extras options on the toolbar.
- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
AbstractAppTransform.Context
-
-
Field Summary
Fields Modifier and Type Field Description protected InboxBean
_inboxBean
protected WebMessages
_messages
static java.lang.String
FP_BULLET_IMAGE
Constant specifying the name of the formal parameter for defining the bullet image.FormalParameter
imgBullet
Specifies the image file name used by the transform to display the bullet icon.-
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 InboxExtrasTransform()
Default no-argument constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected AnchorTag
generateAnchor(WebEvent event)
Overwrites the parent method by setting special attributes to the anchor as required by the caller.protected WebEvent
getClearEvent()
Returns an initializedWebEvent
to clear the contents of the history list.java.lang.String
getDescription()
Returns the description of this Transform.protected int
getDocumentCount()
Utility methodprotected WebEvent
getExpandMessagesEvent()
Returns an initializedWebEvent
to expand the document messages information on the history list.protected WebEvent
getRefreshEvent()
Returns an initializedWebEvent
to refresh the contents of the history list.protected int
getSelectedDocumentCount()
Utility methodprotected java.lang.String
getSelectedMessageIDFromRequest()
Utility method for returning the selected message information if available on the requestjava.lang.Class
getSupportedBeanType()
Get the class of objects this transform is able to handle.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.void
renderClearHistoryList(MarkupOutput out)
Renders the option to clear the history list.void
renderExpandMessages(MarkupOutput out)
Renders the option to expand the document messages information (if applicable) on the history list.void
renderRefreshHistoryList(MarkupOutput out)
Renders the option to refresh the history list.void
transformForRequestSuccessful(MarkupOutput out)
Transforms the assosciatedWebBean
when its status isEnumRequestStatus.WebBeanRequestSuccessful
.-
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, getContext, 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, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newContext, 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.Transform
canTransform, getFormalParams, getPreview, isPreviewAvailable, isResolved, supports, supports
-
-
-
-
Field Detail
-
imgBullet
public FormalParameter imgBullet
Specifies the image file name used by the transform to display the bullet icon.
This image should be contained in the images folder of the application.
Usage:
For example, if you want to specify a different image to display the bullet icon, you would need to copy it to the images folder and then specify its name in this formal parameter.
-
FP_BULLET_IMAGE
public static final java.lang.String FP_BULLET_IMAGE
Constant specifying the name of the formal parameter for defining the bullet image. Value is imgBullet.- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
_inboxBean
protected InboxBean _inboxBean
-
_messages
protected WebMessages _messages
-
-
Method Detail
-
getDescription
public java.lang.String getDescription()
Returns the description of this Transform.- 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. Extends initializeTransform by initializing the cache of this transform's Formal parameters.- Specified by:
initializeTransform
in interfaceAppTransform
- Overrides:
initializeTransform
in classAbstractAppTransform
- Parameters:
data
-Transformable
instance with the bean to be transformed.
-
transformForRequestSuccessful
public void transformForRequestSuccessful(MarkupOutput out)
Transforms the assosciatedWebBean
when its status isEnumRequestStatus.WebBeanRequestSuccessful
.- Specified by:
transformForRequestSuccessful
in classAbstractAppTransform
- Parameters:
out
-MarkupOutput
instance where the contents of this transform will be saved.- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
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.
-
renderRefreshHistoryList
public void renderRefreshHistoryList(MarkupOutput out)
Renders the option to refresh the history list.- Parameters:
out
-MarkupOutput
instance where to write the output of the method.
-
renderClearHistoryList
public void renderClearHistoryList(MarkupOutput out)
Renders the option to clear the history list.- Parameters:
out
-MarkupOutput
instance where to write the output of the method.
-
renderExpandMessages
public void renderExpandMessages(MarkupOutput out)
Renders the option to expand the document messages information (if applicable) on the history list.- Parameters:
out
-MarkupOutput
instance where to write the output of the method.
-
initializeImages
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.- Overrides:
initializeImages
in classAbstractAppTransform
-
getRefreshEvent
protected WebEvent getRefreshEvent()
Returns an initializedWebEvent
to refresh the contents of the history list.- Overrides:
getRefreshEvent
in classAbstractAppTransform
- Returns:
- the
WebEvent
instance initialized if possible,null
if the application doesn't support it. - Since:
- MicroStrategy Web 8.0.0
-
getClearEvent
protected WebEvent getClearEvent()
Returns an initializedWebEvent
to clear the contents of the history list.- Returns:
- the
WebEvent
instance initialized if possible,null
if the application doesn't support it. - Since:
- MicroStrategy Web 8.0.0
-
getExpandMessagesEvent
protected WebEvent getExpandMessagesEvent()
Returns an initializedWebEvent
to expand the document messages information on the history list.- Returns:
- the
WebEvent
instance initialized if possible,null
if the application doesn't support it. - Since:
- MicroStrategy Web 8.0.0
-
getSelectedMessageIDFromRequest
protected java.lang.String getSelectedMessageIDFromRequest()
Utility method for returning the selected message information if available on the request- Returns:
- an empty
String
value if nothing was found, otherwise it will return the value of the argument found on the request.
-
getDocumentCount
protected int getDocumentCount()
Utility method- Returns:
- the number of documents available on the inbox
- Since:
- MicroStrategy Web 8.0.0
-
getSelectedDocumentCount
protected int getSelectedDocumentCount()
Utility method- Returns:
- the number of documents available on the inbox that have been selected by the user
- Since:
- MicroStrategy Web 8.0.0
-
generateAnchor
protected AnchorTag generateAnchor(WebEvent event)
Overwrites the parent method by setting special attributes to the anchor as required by the caller.- Overrides:
generateAnchor
in classAbstractAppTransform
- Parameters:
event
-WebEvent
instance from where the anchor will be constructed- Returns:
AnchorTag
initialized instance with the information as provided by the arguments.- Since:
- MicroStrategy Web 8.0.0
-
-