Class ObjectBrowserTabReportWorkingSetTransform
- java.lang.Object
-
- com.microstrategy.web.transform.AbstractTransform
-
- com.microstrategy.web.transform.AbstractLayoutTransform
-
- com.microstrategy.web.app.transforms.AbstractAppTransform
-
- com.microstrategy.web.app.transforms.AbstractEditorTransform
-
- com.microstrategy.web.app.transforms.AbstractObjectBrowserTabTransform
-
- com.microstrategy.web.app.transforms.ObjectBrowserTabReportWorkingSetTransform
-
- All Implemented Interfaces:
AppTransform
,Transform
public class ObjectBrowserTabReportWorkingSetTransform extends AbstractObjectBrowserTabTransform
This Transform renders the Report objects (working set) tab of the report's object browser.
- Since:
- MicroStrategy Web 8.0.0
-
-
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 java.lang.String
cssBold
Class name for a WorkingSet element that is on the templateprotected java.lang.String
cssClosed
Class name for a WorkingSet element that is closedprotected java.lang.String
cssOpen
Class name for a tree element that is openprotected java.lang.String
cssTree
Class name for the DIV tag that contains all the tree elements of the working set-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractObjectBrowserTabTransform
_imgAttribute, _imgAttributeForm, _imgConsolidation, _imgCube, _imgCustomGroup, _imgDerivedMetric, _imgFilter, _imgFolder, _imgGraph, _imgGridGraph, _imgHierarchy, _imgMetric, _imgMetricDmx, _imgPrompt, _imgRa, _imgReport, attributeFormImage, attributeImage, consolidationImage, cubeImage, customGroupImage, derivedMetricImage, filterImage, folderImage, FP_ATTRIBUTE_FORM_IMAGE, FP_ATTRIBUTE_IMAGE, FP_CONSOLIDATION_IMAGE, FP_CUBE_IMAGE, FP_CUSTOM_GROUP_IMAGE, FP_DERIVED_METRIC_IMAGE, FP_FILTER_IMAGE, FP_FOLDER_IMAGE, FP_GRAPH_IMAGE, FP_GRID_GRAPH_IMAGE, FP_HIERARCHY_IMAGE, FP_INCLUDE_DYNAMIC_SCRIPT, FP_METRIC_DMX_IMAGE, FP_METRIC_IMAGE, FP_OBJECT_SUBTYPES_FILTER, FP_OBJECT_TYPES_FILTER, FP_PROMPT_IMAGE, FP_RA_IMAGE, FP_REPORT_IMAGE, graphImage, gridGraphImage, hierarchyImage, metricDmxImage, metricImage, objectSubtypesFilter, objectTypesFilter, promptImage, raImage, reportImage, sSpaces
-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractEditorTransform
_helpTopic, _helpType, applyJS, applyLabel, applyLabelID, canAutoSize, cancelJS, cancelLabel, cancelLabelID, closeEvent, closeImage, closeJS, closeLabel, closeLabelID, dhtmlClose, disableOKButton, editorContentsStyle, editorElements, editorLayoutFile, editorSubType, FP_APPLY_JS, FP_APPLY_LABEL, FP_APPLY_LABEL_ID, FP_CAN_AUTO_SIZE, FP_CANCEL_JS, FP_CANCEL_LABEL, FP_CANCEL_LABEL_ID, FP_CLOSE_EVENT, FP_CLOSE_IMAGE, FP_CLOSE_JS, FP_CLOSE_LABEL, FP_CLOSE_LABEL_ID, FP_DHTML_CLOSE, FP_DISABLE_OK_BUTTON, FP_EDITOR_CONTENTS_STYLE, FP_EDITOR_ELEMENTS, FP_EDITOR_LAYOUT_FILE, FP_EDITOR_SUBTYPE, FP_HELP_PAGE, FP_HELP_TOPIC, FP_HELP_TYPE, FP_NAVIGATE_ON_SUBMIT, FP_OK_JS, FP_OK_LABEL, FP_OK_LABEL_ID, FP_RENDER_FORM, FP_TITLE_LABEL, FP_TITLE_LABEL_ID, FP_USE_JS_IN_BONE, helpPage, helpTopic, helpType, includeDynamicScript, navigateOnSubmit, okJS, okLabel, okLabelID, renderForm, titleLabel, titleLabelID
-
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 ObjectBrowserTabReportWorkingSetTransform()
Default constructor, no arguments.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected AnchorTag
generateAnchor(WebEvent event)
Deprecated.No longer needed since there are no Anchor tags in this transform anymoreprotected java.lang.String
generateTooltipInformation(java.lang.String objectAlias, WebWorkingSet wSet, WebObjectInfo item)
Get the tooltip information for each objectjava.lang.String
getContextMenuManagerName()
Returns the name to use for theContextMenuManager
of this Transform.java.lang.String
getDescription()
Returns the textual description of the transformReportFrameBean
getFrame()
protected java.lang.String
getObjectImageName(WebObjectInfo object)
Utility method that helps giving the image name to use - based on the information available on the formal parameters - based on the the object type and/or subtype of theWebObjectInfo
instance.java.lang.Class
getSupportedBeanType()
Returns the supported bean type.protected java.lang.String
getTooltipTitle(WebObjectInfo obj, WebWorkingSet wSet)
To get the descriptor for the object depending on type and subtypevoid
initializeCss()
Initializes the Css Classes to use.void
initializeTransform(Transformable data)
Initializes transform formal parametersboolean
isDesignMode()
Returns true if this Transform is being used in the context of design-modevoid
renderAttributeForm(MarkupOutput out, WebAttributeForm attForm, WebAttribute att, WebWorkingSet wSet)
Renders each attribute formvoid
renderAttributeForms(MarkupOutput out, WebObjectInfo objectInfo, WebWorkingSet wSet)
Renders the attribute forms for each attributevoid
renderContextMenu(MarkupOutput out)
Deprecated.To customize context-menus use the xml-definition specified byAbstractAppTransform.contextMenus
void
renderEditorContents(MarkupOutput out)
Method that renders the main contents of the transform, according to the information available on the bean.protected void
renderJavascript(MarkupOutput out)
This method should be used by the Editor transforms to generate any javascript necessary.void
renderTreeEntry(MarkupOutput out, WebObjectInfo objectInfo, WebWorkingSet wSet)
Takes care of displaying the HTML for one single element on the list.void
renderTreeTable(MarkupOutput out)
Renders the framework for the list that will include the objects available based on the bean being analyzed.void
renderTreeTableBodyDHTML(MarkupOutput out)
For each one of the elements of the bean analyzed, renders their corresponding HTML for them to be shown on the list.void
renderTreeTableBodyHTML(MarkupOutput out)
Renders the working set contents of the report in HTML modevoid
transformForRequestSuccessful(MarkupOutput out)
Transforms the assosciatedTabBean
when its status isEnumRequestStatus.WebBeanRequestSuccessful
.-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractObjectBrowserTabTransform
formatObjectInfoParameter, generateTooltipInformation, getClassName, getFolderLinkClasses, getJavascriptTyAttribute, getObjectDescription, getTooltipTitle, initEditor, initializeImages, isObjectSubtypeVisible, isObjectTypeVisible, isTransformEnabled, shouldDisplayObject
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractEditorTransform
generateForm, getDivTagAroundContents, getEditorTitle, getOnSubmitJS, getWebBeanErrorInfo, initHelp, renderEditor, renderEditorElement, setFocusFieldId, transformForRequestInError
-
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, 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, hasSubBlock, initHeightAndWidthFromPreferences, 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, 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
-
cssTree
protected java.lang.String cssTree
Class name for the DIV tag that contains all the tree elements of the working set
-
cssOpen
protected java.lang.String cssOpen
Class name for a tree element that is open
-
cssClosed
protected java.lang.String cssClosed
Class name for a WorkingSet element that is closed
-
cssBold
protected java.lang.String cssBold
Class name for a WorkingSet element that is on the template
-
-
Method Detail
-
initializeTransform
public void initializeTransform(Transformable data)
Initializes transform formal parameters- Specified by:
initializeTransform
in interfaceAppTransform
- Overrides:
initializeTransform
in classAbstractObjectBrowserTabTransform
- Parameters:
data
-Transformable
instance to be transformed by this class
-
initializeCss
public void initializeCss()
Initializes the Css Classes to use. For each one of the css classes to use, the prefix indicated on the formal parameter is added to the name of the class to use.- Overrides:
initializeCss
in classAbstractAppTransform
-
getSupportedBeanType
public java.lang.Class getSupportedBeanType()
Returns the supported bean type. This transform supportsReportWorkingSetBrowserTabBean
instances- Specified by:
getSupportedBeanType
in interfaceTransform
- Overrides:
getSupportedBeanType
in classAbstractObjectBrowserTabTransform
- Returns:
- the class of the bean supported by this transform.
-
getDescription
public java.lang.String getDescription()
Returns the textual description of the transform- Returns:
- the description of the transform
-
isDesignMode
public boolean isDesignMode()
Returns true if this Transform is being used in the context of design-mode- Returns:
true
if the correspondingReportFrameBean
is in design mode.- Since:
- MicroStrategy Web 8.0.1
-
transformForRequestSuccessful
public void transformForRequestSuccessful(MarkupOutput out)
Transforms the assosciatedTabBean
when its status isEnumRequestStatus.WebBeanRequestSuccessful
. CallsrenderTabFrame()
- Overrides:
transformForRequestSuccessful
in classAbstractEditorTransform
- Parameters:
out
-MarkupOutput
instance where the contents of this transform will be saved.- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
renderEditorContents
public void renderEditorContents(MarkupOutput out)
Method that renders the main contents of the transform, according to the information available on the bean.- Specified by:
renderEditorContents
in classAbstractEditorTransform
- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderTreeTable
public void renderTreeTable(MarkupOutput out)
Renders the framework for the list that will include the objects available based on the bean being analyzed. CallsrenderTreeTableBody()
- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderTreeTableBodyDHTML
public void renderTreeTableBodyDHTML(MarkupOutput out)
For each one of the elements of the bean analyzed, renders their corresponding HTML for them to be shown on the list. CallsrenderTreeEntry()
for each one of the elements to render.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
generateAnchor
protected AnchorTag generateAnchor(WebEvent event)
Deprecated.No longer needed since there are no Anchor tags in this transform anymoreOverwrites the parent method by setting requested attributes- Overrides:
generateAnchor
in classAbstractAppTransform
- Parameters:
event
-WebEvent
instance base for creating the anchor- Returns:
AnchorTag
intitialized instance with the information as provided
-
renderTreeEntry
public void renderTreeEntry(MarkupOutput out, WebObjectInfo objectInfo, WebWorkingSet wSet)
Takes care of displaying the HTML for one single element on the list. CallselementHasChildren()
to find out if child objects need to be displayed, andrenderChildrenElements()
if there's any to include.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.objectInfo
- currentWebObjectInfo
instance to include on the listwSet
-WebWorkingSet
instance of the report.
-
renderAttributeForms
public void renderAttributeForms(MarkupOutput out, WebObjectInfo objectInfo, WebWorkingSet wSet)
Renders the attribute forms for each attribute- Parameters:
out
- MarkupOutputobjectInfo
- WebObjectInfowSet
- WebWorkingSet
-
renderAttributeForm
public void renderAttributeForm(MarkupOutput out, WebAttributeForm attForm, WebAttribute att, WebWorkingSet wSet)
Renders each attribute form- Parameters:
out
- MarkupOutputattForm
- WebAttributeFormatt
- WebAttributewSet
- WebWorkingSet
-
getContextMenuManagerName
public java.lang.String getContextMenuManagerName()
Description copied from class:AbstractAppTransform
Returns the name to use for theContextMenuManager
of this Transform. By default, it usesgetID() + "_cmm"
. Transforms may override this method in case they need a different value.- Overrides:
getContextMenuManagerName
in classAbstractAppTransform
- Since:
- MicroStrategy Web 8.0.1
-
renderContextMenu
public void renderContextMenu(MarkupOutput out)
Deprecated.To customize context-menus use the xml-definition specified byAbstractAppTransform.contextMenus
Renders the context menu context to use in the transform For dataset: 'set as primary dataset', 'delete from document' For template unit: ' add to grouping' , 'add to section'- Parameters:
out
- where to write the output of the method.
-
getObjectImageName
protected java.lang.String getObjectImageName(WebObjectInfo object)
Utility method that helps giving the image name to use - based on the information available on the formal parameters - based on the the object type and/or subtype of theWebObjectInfo
instance.- Overrides:
getObjectImageName
in classAbstractObjectBrowserTabTransform
- Parameters:
object
- TheWebObjectInfo
for which it's image name is required.- Returns:
- a
String
with the name of the image associated with theWebObjectInfo
. If the type specified on theWebObjectInfo
definition does not match the predefined list of styles, it looks then based on the subtype. If still not found, it will return a transparent image.
-
renderTreeTableBodyHTML
public void renderTreeTableBodyHTML(MarkupOutput out)
Renders the working set contents of the report in HTML mode- Parameters:
out
-MarkupOutput
-
renderJavascript
protected void renderJavascript(MarkupOutput out)
Description copied from class:AbstractEditorTransform
This method should be used by the Editor transforms to generate any javascript necessary.
The default implementation includes a call to theClientSideHelper
to render the dynamic scrips and the registerBone call.- Overrides:
renderJavascript
in classAbstractEditorTransform
- Parameters:
out
-MarkupOutput
where the output should be rendered.- Since:
- MicroStrategy Web 9.0.0
-
generateTooltipInformation
protected java.lang.String generateTooltipInformation(java.lang.String objectAlias, WebWorkingSet wSet, WebObjectInfo item)
Get the tooltip information for each object- Parameters:
item
- WebObjectInfowSet
- WebWorkingSetobjectAlias
-String
- Returns:
- String
-
getTooltipTitle
protected java.lang.String getTooltipTitle(WebObjectInfo obj, WebWorkingSet wSet)
To get the descriptor for the object depending on type and subtype- Parameters:
obj
- WebObjectInfowSet
-WebWorkingSet
- Returns:
- String
-
getFrame
public ReportFrameBean getFrame()
- Since:
- MicroStrategy Web 8.0.2
-
-