Class ReportGridGraphTransformImpl
- java.lang.Object
-
- com.microstrategy.web.transform.AbstractTransform
-
- com.microstrategy.web.transform.AbstractLayoutTransform
-
- com.microstrategy.web.app.transforms.AbstractAppTransform
-
- com.microstrategy.web.app.transforms.AbstractWebBeanTransform
-
- com.microstrategy.web.app.transforms.AbstractReportTransform
-
- com.microstrategy.web.app.transforms.AbstractReportDataTransform
-
- com.microstrategy.web.app.transforms.ReportGridGraphTransformImpl
-
- All Implemented Interfaces:
AppTransform
,ReportDataTransform
,LayoutTransform
,Transform
public class ReportGridGraphTransformImpl extends AbstractReportDataTransform
Provides a graph view to the report bean. This same transform is also used to render the grid-graph view. This behaviour is controlled by a formal parameter.- 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 FormalParameter
graphStyle
This is the name of the style for the graph if we want to show the grid along with the graph.protected FormalParameter
gridStyle
This is the name of the style for the grid if we want to show the grid along with the graph.protected FormalParameter
outlineGridStyle
This is the name of the style for the grid if we want to show the grid in outline mode along with the graph.protected FormalParameter
showGraphBeforeGrid
Deprecated.It's now recommended to modify the layout-xml to decide where to position the grid-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractReportDataTransform
_blankImage, _cssBottom, _cssCenter, _cssLeft, _cssRight, _cssTop, _ifLeftArrowImage, _ifRightArrowImage, advancedDrillingContextMenuDisplay, BLANK_SUBSET_REPORT_ID, cssBottom, cssCenter, cssLeft, cssRight, cssTop, customJavaScriptFeatures, drillRetainThresholds, drillWithinBehavior, gridGraphUnitKeyContext, groupContextMenuDrillPathsByType, hasIncreFetchForColumnOnLeft, hasIncreFetchForColumnOnRight, id, ifLeftArrowImage, ifRightArrowImage, incrementalFetchStyleForRow, quickSwitch, quickSwitchCurrent, rwbViewerID, showDrillPathSetNamesSubMenuAtTopLevel, showIncreFetchForColumn, showIncreFetchForRowOnBottom, showIncreFetchForRowOnTop, showSubtitlePara, sortSetNamesAndDrillPaths, transformContext, uniqueReportId
-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractReportTransform
BLANK_XDA_REPORT_ID, cssErrorMessage, cssErrorTitle, cssUseFileContent, generateJSForDrillCheckBoxesForIncFetch, iFramePara, imgError, showScroller, useBuiltInFormatPara
-
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 ReportGridGraphTransformImpl()
default no-args constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getDescription()
Return description for this Transformprotected java.lang.String
getGraphStyle()
protected java.lang.String
getGridStyle()
boolean
hasCenter()
Whether the transform has the center area.protected boolean
isDesignMode()
This methods allows the transform to identify if concrete subclasses are designed to work in design mode, or in execute mode.protected boolean
isGraphTransform()
protected boolean
isGridTransform()
void
renderCenter(MarkupOutput out, ReportBean rb)
Render center area of the transform.void
renderData(MarkupOutput out, ReportBean rb)
Render the report data area.void
renderEmptyCase(MarkupOutput out, ReportBean rb)
Render when the report grid/graph is empty.void
renderGraph(MarkupOutput out)
void
renderGraphData(MarkupOutput out, ReportBean rb)
void
renderGrid(MarkupOutput out)
void
renderGridData(MarkupOutput out, ReportBean rb)
render the grid part.void
renderJavascript(MarkupOutput out)
This method renders the javascript code that needs to be generated on the server side because its content is dynamic.void
renderLayout(MarkupOutput out, ReportBean rb)
Render the layout for the report grid.-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractReportDataTransform
createBlockEditorProperties, createBlockEditorProperties, generatePageHistoryItems, getAttributesShellDiv, getBeanPath, getBoneId, getDisplayMode, getFrameBean, getGridData, getGridScriptClass, getGridWidths, getID, getMetricAxisName, getReportSetting, getTransformContext, getViewBean, getWebTemplate, hasBottom, hasLeft, hasRight, hasTop, initializeCss, initializeImages, initializeProperties, initializeTranformContext, initializeTransform, initializeWebComponent, isCalledFromPrinting, isGridEmpty, isQuickSwitchEnabled, isRWBean, renderBottom, renderContent, renderIncreFetchOnColumnLeftPart, renderIncreFetchOnColumnRightPart, renderIncreFetchOnRow, renderLeft, renderRight, renderRowsIncrementalFetch, renderTop, setBoneProperties, shouldRenderGridInfo, showSubtitle, showSubtitle, showSubTitleOnly, supports, supports, transformForRequestSuccessful
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractReportTransform
canTransform, generateAnchor, generateErrorForIframe, generateErrorForIframe, generateIncFetchAnchor, generateIncFetchOpenAnchor, getCancelEvent, getContinueEvent, getErrorMessage, getErrorTitle, getHistoryListEvent, getInboxSource, getJobExpiredMessage, getNextColumnsEvent, getPreviousColumnsEvent, getReexecuteButtonDescription, getReportBean, getReportStatus, getReportStatusDescriptorKey, getRepromptEvent, getSupportedBeanType, getViewDetailsEvent, getWebReexecuteEvent, isCubeReport, isDatamart, isIFrameEnabled, isIncRefreshReport, isNonViewableReport, renderColumnsIncrementalFetch, renderColumnsIncrementalFetchNext, renderColumnsIncrementalFetchPrevious, renderContinueFormForRequestInError, renderErrorButtons, renderErrorInfo, renderHistoryListButton, renderImage, renderJobExpiredSection, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoDetails, renderViewDetailsButton, setWebReexecuteEventArguments, transformForRequestInError, transformForRequestNotInited, useBuiltInFormat
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractWebBeanTransform
getReexcuteEventFromBean, getTaskProcessorBaseURL
-
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, getClientSideHelper, getContainerServices, getContext, getContextMenu, getContextMenuManager, getContextMenuManagerName, getContextMenusDefinition, getCssPrefix, getDateFormat, getDebugOut, getDescriptor, getDescriptor, getDescriptor, getDescriptor, getDisplayMode, getDisplayName, getErrorMessage, getErrorTitle, getEventManager, getFirstDayOfWeek, getFloatValue, getHelpPath, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getLocale, getPreferenceValue, getProjectID, getRefreshEvent, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newContext, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, renderBean, renderBean, renderBean, renderBean, renderCancelButton, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderRegisterBone, renderSelf, renderShell, renderSubBlock, renderUserHelpAnchor, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, transformForRequestProcessing, transformForRequestWaitingForUserInput
-
Methods inherited from class com.microstrategy.web.transform.AbstractLayoutTransform
getLayoutDefinition, setLayoutDefinition, transformUsingLayout
-
Methods inherited from class com.microstrategy.web.transform.AbstractTransform
addFormalParam, getEvents, getFormalParams, getPreview, isPreviewAvailable, isResolved, removeFormalParam, setAnnotation, setDeprecated
-
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, getPreview, getSupportedBeanType, isPreviewAvailable, isResolved, transform
-
-
-
-
Field Detail
-
gridStyle
protected FormalParameter gridStyle
This is the name of the style for the grid if we want to show the grid along with the graph.
Allowed Values: any report style name from StyelCatalog.xml file.
-
outlineGridStyle
protected FormalParameter outlineGridStyle
This is the name of the style for the grid if we want to show the grid in outline mode along with the graph.
sAllowed Values: any outline mode report style name from StyelCatalog.xml file.- Since:
- MicroStrategy Web 7.5.4
-
graphStyle
protected FormalParameter graphStyle
This is the name of the style for the graph if we want to show the grid along with the graph.
Allowed Values: any report style name from StyelCatalog.xml file.- Since:
- MicroStrategy Web 8.0.0
-
showGraphBeforeGrid
protected FormalParameter showGraphBeforeGrid
Deprecated.It's now recommended to modify the layout-xml to decide where to position the gridThis flag is used to decide if we need to show the graph before the grid in the Grid-Graph mode.
Allowed Values: TRUE/FALSE.
-
-
Method Detail
-
renderJavascript
public void renderJavascript(MarkupOutput out)
Description copied from class:AbstractReportDataTransform
This method renders the javascript code that needs to be generated on the server side because its content is dynamic. In particular this method invokesrenderRegisterBone
which initializes and registers a grid's bone..- Overrides:
renderJavascript
in classAbstractReportDataTransform
- Parameters:
out
- MarkupOutput to generate the HTML.- Since:
- MicroStrategy Web 8.0.0
-
renderGridData
public void renderGridData(MarkupOutput out, ReportBean rb)
render the grid part.
Out of box, it's called from renderData() method.- Parameters:
out
- output by this transformrb
- this report bean
-
renderGraphData
public void renderGraphData(MarkupOutput out, ReportBean rb)
- Since:
- MicroStrategy Web 8.0.0
-
renderGrid
public void renderGrid(MarkupOutput out)
- Since:
- MicroStrategy Web 8.0.0
-
renderGraph
public void renderGraph(MarkupOutput out)
- Since:
- MicroStrategy Web 8.0.0
-
getGridStyle
protected java.lang.String getGridStyle()
- Since:
- MicroStrategy Web 8.0.0
-
getGraphStyle
protected java.lang.String getGraphStyle()
- Since:
- MicroStrategy Web 8.0.0
-
isDesignMode
protected boolean isDesignMode()
Description copied from class:AbstractReportTransform
This methods allows the transform to identify if concrete subclasses are designed to work in design mode, or in execute mode.- Overrides:
isDesignMode
in classAbstractReportTransform
- Returns:
- false by default. Any inherting class should override to implement its own version.
- Since:
- MicroStrategy Web 8.0.0
-
hasCenter
public boolean hasCenter()
Description copied from class:AbstractReportDataTransform
Whether the transform has the center area. Out of box, it returns true.- Specified by:
hasCenter
in classAbstractReportDataTransform
- Returns:
- Whether the transform has the center area
- Since:
- MicroStrategy Web 8.0.0
-
renderCenter
public void renderCenter(MarkupOutput out, ReportBean rb)
Description copied from interface:ReportDataTransform
Render center area of the transform.- Parameters:
out
- output by this transformrb
- this report bean- Since:
- MicroStrategy Web 8.0.0
-
renderLayout
public void renderLayout(MarkupOutput out, ReportBean rb)
Description copied from interface:ReportDataTransform
Render the layout for the report grid.
The CENTER area of the transform has layout on top and data on bottom.- Parameters:
out
- output by this transformrb
- this report bean- Since:
- MicroStrategy Web 8.0.0
-
renderData
public void renderData(MarkupOutput out, ReportBean rb)
Description copied from interface:ReportDataTransform
Render the report data area.
The CENTER area of the transform has layout on top and data on bottom.- Parameters:
out
- output by this transformrb
- this report bean
-
renderEmptyCase
public void renderEmptyCase(MarkupOutput out, ReportBean rb)
Description copied from interface:ReportDataTransform
Render when the report grid/graph is empty.
Usually some information message is displayed.- Parameters:
out
- output by this transformrb
- this report bean- Since:
- MicroStrategy Web 8.0.0
-
getDescription
public java.lang.String getDescription()
Return description for this Transform- Returns:
- The description as to what this Transform does.
-
isGridTransform
protected boolean isGridTransform()
- Specified by:
isGridTransform
in classAbstractReportDataTransform
- Since:
- MicroStrategy Web 8.1.0
-
isGraphTransform
protected boolean isGraphTransform()
- Specified by:
isGraphTransform
in classAbstractReportDataTransform
- Since:
- MicroStrategy Web 8.1.0
-
-