Class ReportFrameClassicTransform
- java.lang.Object
-
- com.microstrategy.web.transform.AbstractTransform
-
- com.microstrategy.web.transform.AbstractLayoutTransform
-
- com.microstrategy.web.app.transforms.AbstractAppTransform
-
- com.microstrategy.web.app.transforms.ReportFrameClassicTransform
-
- All Implemented Interfaces:
AppTransform
,Transform
public class ReportFrameClassicTransform extends AbstractAppTransform
Deprecated.Please useReportFrameGenericTransform
insteadThe
ReportFrameClassicTransform
renders the output of aReportFrameBean
.The
ReportFrameBean
is used in the report page as a container of the different elements that constitute this page. It manages the interaction between the beans and controls who is open or not. TheReportFrameClassicTransform
controls the layout of these beans within the page.Through the style catalog users may control which sections can be displayed. This is accomplished using the
Users can then hide a section by turning off the corresponding bit of this flagged value.levelFlag
formal parameter. This takes a bitwise value combining constants such as:The
ReportFrameClassicTransform
delegates to its children their own HTML generation. The style to use for a child is selected in two ways:- If this Transform provides a specific Formal Parameter for it, it will simply use that value.
- Otherwise, it uses the default bean's style, this usually defined as the first style
assigned to the bean in the
pageConfig.xml
.
ReportBean
: depending on the situation, it will use the corresponding style.For the
PageByBean
, however, this Transform defines no Formal Parameter, therefore it uses its default style. Suppose the bean is defined in the pageConfig.xml as follows:<web-bean name="pbb" persist-mode="2" sys-bean="PageByBean"> <styles> <style name="PageByStyle"/> <style name="GroupByStyle"/> </styles> </web-bean>
- 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 static java.lang.String
FP_GRAPH_DESIGN_MODE_STYLE
Deprecated.name for the formal parameter "graphDesignModeStyle".static java.lang.String
FP_LEVEL_FLAG
Deprecated.Constant specifying the name of the formal parameter for defining the level flag.static java.lang.String
FP_MDX_FILTER_STYLE
Deprecated.static java.lang.String
FP_PROMPTS_CREATE_STYLE
Deprecated.name for the formal parameter "promptsCreateStyle".static java.lang.String
FP_PROMPTS_EDIT_STYLE
Deprecated.name for the formal parameter "promptsEditStyle".static java.lang.String
FP_PROMPTS_EXECUTE_STYLE
Deprecated.name for the formal parameter "promptsExecuteStyle".static java.lang.String
FP_PROMPTS_SAVING_STYLE
Deprecated.name for the formal parameter "promptsSavingStyle".static java.lang.String
FP_REPORT_DESIGN_MODE_STYLE
Deprecated.name for the formal parameter "reportDesignModeStyle".static java.lang.String
FP_REPORT_FILTER_STYLE
Deprecated.name for the formal parameter "reportFilterStyle".static java.lang.String
FP_REPORT_GRAPH_STYLE
Deprecated.name for the formal parameter "reportGraphStyle".static java.lang.String
FP_REPORT_GRID_GRAPH_STYLE
Deprecated.name for the formal parameter "reportGridGraphStyle".static java.lang.String
FP_REPORT_GRID_STYLE
Deprecated.name for the formal parameter "reportGridStyle".static java.lang.String
FP_REPORT_OUTLINE_MODE_STYLE
Deprecated.name for the formal parameter "reportOutlineModeStyle".static java.lang.String
FP_REPORT_PAGE_BY_STYLE
Deprecated.name for the formal parameter "reportPageByStyle".static java.lang.String
FP_REPORT_TOOLBAR_STYLE
Deprecated.name for the formal parameter "reportToolbarStyle".static java.lang.String
FP_VIEW_FILTER_STYLE
Deprecated.name for the formal parameter "viewFilterStyle".static java.lang.String
FP_VIEW_LIMIT_STYLE
Deprecated.name for the formal parameter "viewLimitStyle".protected FormalParameter
graphDesignModeStyle
Deprecated.This is the name of the style to use when rendering the graph in design mode.static int
LEVEL_ALL
Deprecated.Allowed value for thelevelFlag
formal parameter.static int
LEVEL_DISPLAY_DATA
Deprecated.Allowed value for thelevelFlag
formal parameter.static int
LEVEL_DISPLAY_DESIGN_MODE_BUTTONS
Deprecated.Allowed value for thelevelFlag
formal parameter.static int
LEVEL_DISPLAY_EDITOR_MESSAGE
Deprecated.Allowed value for thelevelFlag
formal parameter.static int
LEVEL_DISPLAY_FORMAT_EDITOR
Deprecated.Allowed value for thelevelFlag
formal parameter.static int
LEVEL_DISPLAY_GRAPH_TOOLBAR
Deprecated.Allowed value for thelevelFlag
formal parameter.static int
LEVEL_DISPLAY_GRID_EDITOR
Deprecated.Allowed value for thelevelFlag
formal parameter.static int
LEVEL_DISPLAY_GRID_TOOLBAR
Deprecated.Allowed value for thelevelFlag
formal parameter.static int
LEVEL_DISPLAY_MENUS
Deprecated.Allowed value for thelevelFlag
formal parameter.static int
LEVEL_DISPLAY_OBJECT_BROWSER
Deprecated.Allowed value for thelevelFlag
formal parameter.static int
LEVEL_DISPLAY_PAGE_BY
Deprecated.Allowed value for thelevelFlag
formal parameter.static int
LEVEL_DISPLAY_PROMPT_DETAILS
Deprecated.Allowed value for thelevelFlag
formal parameter.static int
LEVEL_DISPLAY_REPORT_ERROR
Deprecated.Allowed value for thelevelFlag
formal parameter.static int
LEVEL_DISPLAY_REPORT_FILTER
Deprecated.Allowed value for thelevelFlag
formal parameter.static int
LEVEL_DISPLAY_REPORT_LAST_UPDATE
Deprecated.Allowed value for thelevelFlag
formal parameter.static int
LEVEL_DISPLAY_REPORT_TOOLBAR
Deprecated.Allowed value for thelevelFlag
formal parameter.static int
LEVEL_DISPLAY_VIEW_FILTER
Deprecated.Allowed value for thelevelFlag
formal parameter.static int
LEVEL_DISPLAY_VIEW_LIMIT
Deprecated.Allowed value for thelevelFlag
formal parameter.FormalParameter
levelFlag
Deprecated.Indicates the level of information to use when displaying sections of the ReportFrame.protected FormalParameter
mdxFilterStyle
Deprecated.protected FormalParameter
promptsCreateStyle
Deprecated.This is the name of the style to use to transform a prompted grid when creating new reports.protected FormalParameter
promptsEditStyle
Deprecated.This is the name of the style to use to transform a prompted grid when editing reports.protected FormalParameter
promptsExecuteStyle
Deprecated.This is the name of the style to use to transform a prompted grid when normal report execution.protected FormalParameter
promptsSavingStyle
Deprecated.This is the name of the style to use to transform a prompted grid when trying to save edited or created report which have prompts to be resolved before saving.protected FormalParameter
reportDesignModeStyle
Deprecated.This is the name of the style to use when rendering the report in design mode.protected FormalParameter
reportFilterStyle
Deprecated.This is the name of the style to use to transform the report filter for normal report execution.protected FormalParameter
reportGraphStyle
Deprecated.This is the name of the style to use when rendering the report in graph mode.protected FormalParameter
reportGridGraphStyle
Deprecated.This is the name of the style to use when rendering the report in grid/graph mode.protected FormalParameter
reportGridStyle
Deprecated.This is the name of the style to use when rendering the report in grid mode.protected FormalParameter
reportOutlineModeStyle
Deprecated.This is the name of the style to use when rendering the report in outline grid mode.protected FormalParameter
reportPageByStyle
Deprecated.This formal parameter is not referenced anywhere in the codeprotected FormalParameter
reportToolbarStyle
Deprecated.This is the name of the style to use when rendering the Report toolbar component.protected FormalParameter
viewFilterStyle
Deprecated.This is the name of the style to use to transform the view filter for normal report execution.protected FormalParameter
viewLimitStyle
Deprecated.This is the name of the style to use to transform the view limit on normal report execution.-
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 ReportFrameClassicTransform()
Deprecated.default no-args constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected void
displayComponent(MarkupOutput out, java.lang.String name, FrameElement bean)
Deprecated.Renders a FrameElement as an iFrame component.protected void
displayComponent(MarkupOutput out, java.lang.String name, GuiElement component)
Deprecated.Renders a GUI element.protected void
displayComponent(MarkupOutput out, java.lang.String name, MarkupOutput value)
Deprecated.Display a string as an iFrame component.protected void
displayComponent(MarkupOutput out, java.lang.String name, MarkupOutput value, boolean copyContents)
Deprecated.Display a string as an iFrame component.protected void
displayComponent(MarkupOutput out, java.lang.String name, WebComponent bean)
Deprecated.Renders a FrameElement as an iFrame component.protected void
displayComponent(MarkupOutput out, java.lang.String name, WebComponent bean, java.lang.String styleName)
Deprecated.Renders a WebComponent with the corresponding style as an iFrame component.protected void
displayComponent(MarkupOutput out, java.lang.String name, java.lang.String value)
Deprecated.Display a string as an iFrame component.protected void
displayComponent(MarkupOutput out, java.lang.String name, java.lang.String value, boolean copyContents)
Deprecated.Display a string as an iFrame component.protected void
displayFrameComponent(MarkupOutput out, java.lang.String name, FrameElement bean, java.lang.String styleName)
Deprecated.void
generateDesignMode(MarkupOutput out)
Deprecated.Function that generate output for Design mode.void
generateExecuteMode(MarkupOutput out)
Deprecated.Function that generate output for execute mode.void
generateSimpleMode(MarkupOutput out)
Deprecated.Function that generate output for simple mode - report in error or cancelled status.java.lang.String
getDescription()
Deprecated.The description of this transform.protected WebEvent
getDesignModeEvent()
Deprecated.Returns the event used in the ReportFrame's design mode.protected TransformInstance
getPromptsTransform(ReportBean rb)
Deprecated.protected java.lang.String
getReportStyleName()
Deprecated.This method returns the name of a style from the style-catalog used to render the ReportBean.java.lang.Class
getSupportedBeanType()
Deprecated.Returns the supported bean type.void
initializeTransform(Transformable data)
Deprecated.This method initialize the private and protected fields of the transform.protected boolean
isEditingFilter(int filterType)
Deprecated.boolean
isInVisualizationMode()
Deprecated.boolean
isUrlVisualization()
Deprecated.void
renderCurrentEditor(MarkupOutput out)
Deprecated.render the current editor for the report.void
renderDesignModeProcessForm(MarkupOutput out)
Deprecated.Render the process form in design mode.void
renderDNDScripts(MarkupOutput out)
Deprecated.void
renderFormatEditors(MarkupOutput out)
Deprecated.Renders the Report Formatting Editors.void
renderMenus(MarkupOutput out)
Deprecated.render the menus on the top of report frame.void
renderReportArea(MarkupOutput out)
Deprecated.render report area in execute mode.void
renderReportData(MarkupOutput out)
Deprecated.render the report data area.void
renderReportElements(MarkupOutput out)
Deprecated.render the report frame elements in execute mode.void
renderReportFormEnd(MarkupOutput out)
Deprecated.render the FORM close tag for report area.void
renderReportFormStart(MarkupOutput out)
Deprecated.render the FORM start tag for report area.void
renderReportToolbar(MarkupOutput out)
Deprecated.render the report toolbar.void
renderTemplateEditor(MarkupOutput out)
Deprecated.render the template editor in design mode.void
transformForRequestCanceled(MarkupOutput out)
Deprecated.Transform when the status isCanceled
.void
transformForRequestInError(MarkupOutput out)
Deprecated.Transform when the status isIn Error
.void
transformForRequestNotInited(MarkupOutput out)
Deprecated.Transform when the status isNot initialized
.void
transformForRequestProcessing(MarkupOutput out)
Deprecated.Transform when the status isProcessing
.void
transformForRequestSuccessful(MarkupOutput out)
Deprecated.Transform when the status isSuccessful
.void
transformForRequestWaitingForUserInput(MarkupOutput out)
Deprecated.Method that generates the output when the bean is WaitingForUserInput.-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchor, 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, 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, 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
-
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
-
LEVEL_DISPLAY_MENUS
public static final int LEVEL_DISPLAY_MENUS
Deprecated.Allowed value for thelevelFlag
formal parameter. Specifies that the report frame transform will display the menus content. If the frame has no associated menus, then this flag has no effect on the final result. Value = 1- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
LEVEL_DISPLAY_DATA
public static final int LEVEL_DISPLAY_DATA
Deprecated.Allowed value for thelevelFlag
formal parameter. Specifies that the report frame transform will display the report data. Value = 2- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
LEVEL_DISPLAY_REPORT_LAST_UPDATE
public static final int LEVEL_DISPLAY_REPORT_LAST_UPDATE
Deprecated.Allowed value for thelevelFlag
formal parameter. Specifies that the report frame transform will display the report's last update section besides the menus. Value = 4- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
LEVEL_DISPLAY_REPORT_TOOLBAR
public static final int LEVEL_DISPLAY_REPORT_TOOLBAR
Deprecated.Allowed value for thelevelFlag
formal parameter. Specifies that the report frame transform will display the report's toolbar (it includes the list of autostyles). Value = 8- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
LEVEL_DISPLAY_REPORT_ERROR
public static final int LEVEL_DISPLAY_REPORT_ERROR
Deprecated.Allowed value for thelevelFlag
formal parameter. Specifies that the report frame transform will display the section including the report's error message. If the frame has no error, then this flag has no effect on the final result. Value = 16- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
LEVEL_DISPLAY_REPORT_FILTER
public static final int LEVEL_DISPLAY_REPORT_FILTER
Deprecated.Allowed value for thelevelFlag
formal parameter. Specifies that the report frame transform will display the report's filter. Value = 32- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
LEVEL_DISPLAY_VIEW_FILTER
public static final int LEVEL_DISPLAY_VIEW_FILTER
Deprecated.Allowed value for thelevelFlag
formal parameter. Specifies that the report frame transform will display the view's filter. Value = 64- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
LEVEL_DISPLAY_GRID_TOOLBAR
public static final int LEVEL_DISPLAY_GRID_TOOLBAR
Deprecated.Allowed value for thelevelFlag
formal parameter. Specifies that the report frame transform will display the grid's formatting toolbar. Value = 128- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
LEVEL_DISPLAY_GRAPH_TOOLBAR
public static final int LEVEL_DISPLAY_GRAPH_TOOLBAR
Deprecated.Allowed value for thelevelFlag
formal parameter. Specifies that the report frame transform will display the graph's formatting toolbar. Value = 256- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
LEVEL_DISPLAY_PAGE_BY
public static final int LEVEL_DISPLAY_PAGE_BY
Deprecated.Allowed value for thelevelFlag
formal parameter. Specifies that the report frame transform will display the report's page-by section on top of the report's data. Value = 512- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
LEVEL_DISPLAY_OBJECT_BROWSER
public static final int LEVEL_DISPLAY_OBJECT_BROWSER
Deprecated.Allowed value for thelevelFlag
formal parameter. Specifies that the report frame transform will display the report's object browser. Value = 1024- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
LEVEL_DISPLAY_FORMAT_EDITOR
public static final int LEVEL_DISPLAY_FORMAT_EDITOR
Deprecated.Allowed value for thelevelFlag
formal parameter. Specifies that the report frame transform will display the report's formatting editor (depending on the view mode). Value = 2048- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
LEVEL_DISPLAY_GRID_EDITOR
public static final int LEVEL_DISPLAY_GRID_EDITOR
Deprecated.Allowed value for thelevelFlag
formal parameter. Specifies that the report frame transform will display the current grid's editor (i.e. sorts, drilling, scheduling, etc). Value = 4096- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
LEVEL_DISPLAY_DESIGN_MODE_BUTTONS
public static final int LEVEL_DISPLAY_DESIGN_MODE_BUTTONS
Deprecated.Allowed value for thelevelFlag
formal parameter. Specifies that the report frame transform will display the execution bar in design mode.. Value = 8192- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
LEVEL_DISPLAY_EDITOR_MESSAGE
public static final int LEVEL_DISPLAY_EDITOR_MESSAGE
Deprecated.Allowed value for thelevelFlag
formal parameter. Specifies that the report frame transform will display the message associated with an editor before the report's data. Value = 16384- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
LEVEL_DISPLAY_PROMPT_DETAILS
public static final int LEVEL_DISPLAY_PROMPT_DETAILS
Deprecated.Allowed value for thelevelFlag
formal parameter. Specifies that the report frame transform will display the message associated with an editor before the report's data. Value = 32768- Since:
- MicroStrategy Web 8.0.1
- See Also:
- Constant Field Values
-
LEVEL_DISPLAY_VIEW_LIMIT
public static final int LEVEL_DISPLAY_VIEW_LIMIT
Deprecated.Allowed value for thelevelFlag
formal parameter. Specifies that the report frame transform will display the view limit. Value = 65536- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
LEVEL_ALL
public static final int LEVEL_ALL
Deprecated.Allowed value for thelevelFlag
formal parameter. Convenience flag to indicate all possible LEVEL values.
Value = 16777215- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
reportPageByStyle
protected FormalParameter reportPageByStyle
Deprecated.This formal parameter is not referenced anywhere in the codeThis is the name of the style to use when rendering the PageBy component.
Allowed Values: any report style name from StyelCatalog.xml file.
-
reportToolbarStyle
protected FormalParameter reportToolbarStyle
Deprecated.This is the name of the style to use when rendering the Report toolbar component.
Allowed Values: any report style name from StyelCatalog.xml file.
-
reportGridStyle
protected FormalParameter reportGridStyle
Deprecated.This is the name of the style to use when rendering the report in grid mode.
Allowed Values: any report style name from StyelCatalog.xml file.
-
reportOutlineModeStyle
protected FormalParameter reportOutlineModeStyle
Deprecated.This is the name of the style to use when rendering the report in outline grid mode.
Allowed Values: any report style name from StyelCatalog.xml file.
-
reportGraphStyle
protected FormalParameter reportGraphStyle
Deprecated.This is the name of the style to use when rendering the report in graph mode.
Allowed Values: any report style name from StyelCatalog.xml file.
-
reportDesignModeStyle
protected FormalParameter reportDesignModeStyle
Deprecated.This is the name of the style to use when rendering the report in design mode.
Allowed Values: any report style name from StyelCatalog.xml file.
-
graphDesignModeStyle
protected FormalParameter graphDesignModeStyle
Deprecated.This is the name of the style to use when rendering the graph in design mode.
Allowed Values: any report style name from StyelCatalog.xml file.- Since:
- MicroStrategy Web 9.0.0
-
reportGridGraphStyle
protected FormalParameter reportGridGraphStyle
Deprecated.This is the name of the style to use when rendering the report in grid/graph mode.
Allowed Values: any report style name from StyelCatalog.xml file.
-
promptsCreateStyle
protected FormalParameter promptsCreateStyle
Deprecated.This is the name of the style to use to transform a prompted grid when creating new reports.
Allowed Values: any report style name from StyelCatalog.xml file.
-
promptsEditStyle
protected FormalParameter promptsEditStyle
Deprecated.This is the name of the style to use to transform a prompted grid when editing reports.
Allowed Values: any report style name from StyelCatalog.xml file.
-
promptsSavingStyle
protected FormalParameter promptsSavingStyle
Deprecated.This is the name of the style to use to transform a prompted grid when trying to save edited or created report which have prompts to be resolved before saving.
Allowed Values: any report style name from StyelCatalog.xml file.
-
promptsExecuteStyle
protected FormalParameter promptsExecuteStyle
Deprecated.This is the name of the style to use to transform a prompted grid when normal report execution.
Allowed Values: any report style name from StyelCatalog.xml file.
-
viewFilterStyle
protected FormalParameter viewFilterStyle
Deprecated.This is the name of the style to use to transform the view filter for normal report execution.
Allowed Values: any view filter style name from StyleCatalog.xml file.- Since:
- MicroStrategy Web 8.0.0
-
reportFilterStyle
protected FormalParameter reportFilterStyle
Deprecated.This is the name of the style to use to transform the report filter for normal report execution.
Allowed Values: any filter style name from StyleCatalog.xml file.- Since:
- MicroStrategy Web 8.0.0
-
mdxFilterStyle
protected FormalParameter mdxFilterStyle
Deprecated.- Since:
- MicroStrategy Web 8.0.2
-
viewLimitStyle
protected FormalParameter viewLimitStyle
Deprecated.This is the name of the style to use to transform the view limit on normal report execution.
Allowed Values: any FilterElementBean style name from StyleCatalog.xml file.- Since:
- MicroStrategy Web 9.0.0
-
FP_REPORT_GRID_STYLE
public static final java.lang.String FP_REPORT_GRID_STYLE
Deprecated.name for the formal parameter "reportGridStyle".- See Also:
- Constant Field Values
-
FP_REPORT_OUTLINE_MODE_STYLE
public static final java.lang.String FP_REPORT_OUTLINE_MODE_STYLE
Deprecated.name for the formal parameter "reportOutlineModeStyle".- See Also:
- Constant Field Values
-
FP_REPORT_GRAPH_STYLE
public static final java.lang.String FP_REPORT_GRAPH_STYLE
Deprecated.name for the formal parameter "reportGraphStyle".- See Also:
- Constant Field Values
-
FP_REPORT_GRID_GRAPH_STYLE
public static final java.lang.String FP_REPORT_GRID_GRAPH_STYLE
Deprecated.name for the formal parameter "reportGridGraphStyle".- See Also:
- Constant Field Values
-
FP_REPORT_PAGE_BY_STYLE
public static final java.lang.String FP_REPORT_PAGE_BY_STYLE
Deprecated.name for the formal parameter "reportPageByStyle".- See Also:
- Constant Field Values
-
FP_REPORT_TOOLBAR_STYLE
public static final java.lang.String FP_REPORT_TOOLBAR_STYLE
Deprecated.name for the formal parameter "reportToolbarStyle".- See Also:
- Constant Field Values
-
FP_REPORT_DESIGN_MODE_STYLE
public static final java.lang.String FP_REPORT_DESIGN_MODE_STYLE
Deprecated.name for the formal parameter "reportDesignModeStyle".- See Also:
- Constant Field Values
-
FP_GRAPH_DESIGN_MODE_STYLE
public static final java.lang.String FP_GRAPH_DESIGN_MODE_STYLE
Deprecated.name for the formal parameter "graphDesignModeStyle".- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
FP_PROMPTS_EDIT_STYLE
public static final java.lang.String FP_PROMPTS_EDIT_STYLE
Deprecated.name for the formal parameter "promptsEditStyle".- See Also:
- Constant Field Values
-
FP_PROMPTS_CREATE_STYLE
public static final java.lang.String FP_PROMPTS_CREATE_STYLE
Deprecated.name for the formal parameter "promptsCreateStyle".- See Also:
- Constant Field Values
-
FP_PROMPTS_SAVING_STYLE
public static final java.lang.String FP_PROMPTS_SAVING_STYLE
Deprecated.name for the formal parameter "promptsSavingStyle".- See Also:
- Constant Field Values
-
FP_PROMPTS_EXECUTE_STYLE
public static final java.lang.String FP_PROMPTS_EXECUTE_STYLE
Deprecated.name for the formal parameter "promptsExecuteStyle".- See Also:
- Constant Field Values
-
FP_VIEW_FILTER_STYLE
public static final java.lang.String FP_VIEW_FILTER_STYLE
Deprecated.name for the formal parameter "viewFilterStyle".- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
FP_REPORT_FILTER_STYLE
public static final java.lang.String FP_REPORT_FILTER_STYLE
Deprecated.name for the formal parameter "reportFilterStyle".- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
FP_MDX_FILTER_STYLE
public static final java.lang.String FP_MDX_FILTER_STYLE
Deprecated.- Since:
- MicroStrategy Web 8.0.2
- See Also:
- Constant Field Values
-
FP_VIEW_LIMIT_STYLE
public static final java.lang.String FP_VIEW_LIMIT_STYLE
Deprecated.name for the formal parameter "viewLimitStyle".- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
FP_LEVEL_FLAG
public static final java.lang.String FP_LEVEL_FLAG
Deprecated.Constant specifying the name of the formal parameter for defining the level flag. Value is levelFlag.- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
levelFlag
public FormalParameter levelFlag
Deprecated.Indicates the level of information to use when displaying sections of the ReportFrame.
The sections include menus, toolbars, editors and data. Multiple sections might be rendered at the same time. For indicating which sections to show, the value to assign to this formal parameter should be a bitwise flag combining constants such asLEVEL_DISPLAY_MENUS
,LEVEL_DISPLAY_DATA
,LEVEL_DISPLAY_OBJECT_BROWSER
.
Notice that even if the Flag is ON for a particular section, that doesn't guarantees that section is rendered. It just indicates that when necessary it must be included. Logic inside the ReportFrame might prevent a section to be rendered. For example, if theLEVEL_DISPLAY_GRID_EDITOR
is ON, but the ReportFrame has no editor currently selected, nothing will be rendered. Similarly if theLEVEL_DISPLAY_GRID_TOOLBAR
but the current data view is Graph, or the Toolbar has been turned off through menus, the Toolbar will not be rendered.
On the other side, if the Flag is set to off, that sections will not be included regardles of other factors. Usage: If name, description and owner should be displayed, the value to assign to the formal parameter would be 7 (1 + 2 + 4). Default value isLEVEL_ALL
- Since:
- MicroStrategy Web 8.0.0
-
-
Method Detail
-
getDescription
public java.lang.String getDescription()
Deprecated.The description of this transform.- Returns:
- This renders the ouput of a ReportFrameBean as used by MicroStrategy Web Universal.
-
initializeTransform
public void initializeTransform(Transformable data)
Deprecated.This method initialize the private and protected fields of the transform.
In particular it holds a reference to thebean
being transformed.- Specified by:
initializeTransform
in interfaceAppTransform
- Overrides:
initializeTransform
in classAbstractAppTransform
- Parameters:
data
- The bean transforming.
-
getSupportedBeanType
public java.lang.Class getSupportedBeanType()
Deprecated.Returns the supported bean type.
This abstract Transform supports allWebComponents
.- Specified by:
getSupportedBeanType
in interfaceTransform
- Overrides:
getSupportedBeanType
in classAbstractAppTransform
- Returns:
WebComponent.class
-
transformForRequestInError
public void transformForRequestInError(MarkupOutput out)
Deprecated.Transform when the status isIn Error
.- Overrides:
transformForRequestInError
in classAbstractAppTransform
- Parameters:
out
- output by this transform- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
transformForRequestNotInited
public void transformForRequestNotInited(MarkupOutput out)
Deprecated.Transform when the status isNot initialized
.- Overrides:
transformForRequestNotInited
in classAbstractAppTransform
- Parameters:
out
- output by this transform- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
transformForRequestCanceled
public void transformForRequestCanceled(MarkupOutput out)
Deprecated.Transform when the status isCanceled
.- Overrides:
transformForRequestCanceled
in classAbstractAppTransform
- Parameters:
out
- output by this transform- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
transformForRequestProcessing
public void transformForRequestProcessing(MarkupOutput out)
Deprecated.Transform when the status isProcessing
.- Overrides:
transformForRequestProcessing
in classAbstractAppTransform
- Parameters:
out
- output by this transform- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
getPromptsTransform
protected TransformInstance getPromptsTransform(ReportBean rb)
Deprecated.- Since:
- MicroStrategy Web 8.0.0
-
transformForRequestWaitingForUserInput
public void transformForRequestWaitingForUserInput(MarkupOutput out)
Deprecated.Method that generates the output when the bean is WaitingForUserInput.
It checks if the child bean in this state is the report bean, and if so transforms it using the correct prompt style. However, if ReportFrameBean promptStyle property is available then prompt styles will be ignored and property value will indicate which prompt style to use.
If not, it just invokes thegenerateSimpleMode(com.microstrategy.web.beans.MarkupOutput)
method.- Overrides:
transformForRequestWaitingForUserInput
in classAbstractAppTransform
- Parameters:
out
- where to write the output of the method.- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
transformForRequestSuccessful
public void transformForRequestSuccessful(MarkupOutput out)
Deprecated.Transform when the status isSuccessful
.- Specified by:
transformForRequestSuccessful
in classAbstractAppTransform
- Parameters:
out
- output by this transform- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
getDesignModeEvent
protected WebEvent getDesignModeEvent()
Deprecated.Returns the event used in the ReportFrame's design mode.
This event handles most of the actions of the design mode, such as Save, Execute, Cancel, Change mode, etc.- Returns:
- by default returns the
WebEventDesignModeProcess
event.
-
generateSimpleMode
public void generateSimpleMode(MarkupOutput out)
Deprecated.Function that generate output for simple mode - report in error or cancelled status.- Parameters:
out
- where to write the output of the method.
-
generateDesignMode
public void generateDesignMode(MarkupOutput out)
Deprecated.Function that generate output for Design mode.- Parameters:
out
- where to write the output of the method.
-
generateExecuteMode
public void generateExecuteMode(MarkupOutput out)
Deprecated.Function that generate output for execute mode.- Parameters:
out
- where to write the output of the method.
-
renderDNDScripts
public void renderDNDScripts(MarkupOutput out)
Deprecated.render the supporting JavaScript and HTML code for Drag and drop functionality.- Parameters:
out
- output by the transform
-
renderDesignModeProcessForm
public void renderDesignModeProcessForm(MarkupOutput out)
Deprecated.Render the process form in design mode.
Out of box, it renders the "execute report", "save report", "cancel" and "edit report filter"/"edit grid" buttons.- Parameters:
out
- output by the transform
-
isEditingFilter
protected boolean isEditingFilter(int filterType)
Deprecated.- Since:
- MicroStrategy Web 8.0.2
-
renderTemplateEditor
public void renderTemplateEditor(MarkupOutput out)
Deprecated.render the template editor in design mode.
Out of box, it displays object browser on left side;
on right side, either pageby and template sections or report filter and view filter sections.- Parameters:
out
- output by the transform
-
renderReportElements
public void renderReportElements(MarkupOutput out)
Deprecated.render the report frame elements in execute mode.
Out of box, it includes error section, report filter, view filter, toolbar, and pageby sections.- Parameters:
out
- output by the transform
-
renderMenus
public void renderMenus(MarkupOutput out)
Deprecated.render the menus on the top of report frame.
Out of box, it renders drop down menus and last updated time.- Parameters:
out
- output by the transform
-
renderReportToolbar
public void renderReportToolbar(MarkupOutput out)
Deprecated.render the report toolbar.- Parameters:
out
- output by the transform
-
renderReportArea
public void renderReportArea(MarkupOutput out)
Deprecated.render report area in execute mode.
Out of box, it includes object browser, format editors, current editor and report data.- Parameters:
out
- the MarkupOutput object
-
renderReportFormStart
public void renderReportFormStart(MarkupOutput out)
Deprecated.render the FORM start tag for report area.- Parameters:
out
- output by the transform
-
renderReportFormEnd
public void renderReportFormEnd(MarkupOutput out)
Deprecated.render the FORM close tag for report area.- Parameters:
out
- output by the transform
-
renderFormatEditors
public void renderFormatEditors(MarkupOutput out)
Deprecated.Renders the Report Formatting Editors.- Parameters:
out
- output by the transform
-
renderCurrentEditor
public void renderCurrentEditor(MarkupOutput out)
Deprecated.render the current editor for the report.
Out of box, there is only one editor open at one time.- Parameters:
out
- output by the transform
-
renderReportData
public void renderReportData(MarkupOutput out)
Deprecated.render the report data area.
Out of box, it renders the message before the data and the report data - grid, graph or grid&graph.- Parameters:
out
- output by the transform
-
getReportStyleName
protected java.lang.String getReportStyleName()
Deprecated.This method returns the name of a style from the style-catalog used to render the ReportBean. The name is calculated based on the view mode, visualization settings and formal parameters. To programatically calculate a different style you may override this method.- Since:
- MicroStrategy Web 8.0.2
-
displayFrameComponent
protected void displayFrameComponent(MarkupOutput out, java.lang.String name, FrameElement bean, java.lang.String styleName)
Deprecated.- Since:
- MicroStrategy Web 8.0.0
-
displayComponent
protected void displayComponent(MarkupOutput out, java.lang.String name, FrameElement bean)
Deprecated.Renders a FrameElement as an iFrame component.
In this case, it checks if the element is open before render it.- Parameters:
out
- output by this transformname
- the name of the componentbean
- the FrameElement
-
displayComponent
protected void displayComponent(MarkupOutput out, java.lang.String name, WebComponent bean)
Deprecated.Renders a FrameElement as an iFrame component.
In this case, it checks if the element is open before render it.- Parameters:
out
- output by this transformname
- the name of the componentbean
- the FrameElement- Since:
- MicroStrategy Web 8.0.0
-
displayComponent
protected void displayComponent(MarkupOutput out, java.lang.String name, WebComponent bean, java.lang.String styleName)
Deprecated.Renders a WebComponent with the corresponding style as an iFrame component.- Parameters:
out
- output by this transformname
- the name of the componentbean
- theWebComponent
to transformstyleName
- the transform style name as define on the style catalog
-
displayComponent
protected void displayComponent(MarkupOutput out, java.lang.String name, GuiElement component)
Deprecated.Renders a GUI element.- Parameters:
out
- output by this transformname
- the name of the componentcomponent
- the GUI element object
-
displayComponent
protected void displayComponent(MarkupOutput out, java.lang.String name, java.lang.String value)
Deprecated.Display a string as an iFrame component.- Parameters:
out
- The HTML outputname
- the Component namevalue
- the String to render.
-
displayComponent
protected void displayComponent(MarkupOutput out, java.lang.String name, java.lang.String value, boolean copyContents)
Deprecated.Display a string as an iFrame component.- Parameters:
out
- The HTML outputname
- the Component namevalue
- the String to render.copyContents
- if true contents will be copied from the ifram to the main window
-
displayComponent
protected void displayComponent(MarkupOutput out, java.lang.String name, MarkupOutput value)
Deprecated.Display a string as an iFrame component.- Parameters:
out
- The HTML outputname
- the Component namevalue
- the MarkupOutput to render.- Since:
- MicroStrategy Web 8.0.0
-
displayComponent
protected void displayComponent(MarkupOutput out, java.lang.String name, MarkupOutput value, boolean copyContents)
Deprecated.Display a string as an iFrame component.- Parameters:
out
- The HTML outputname
- the Component namevalue
- the MarkupOutput to render.copyContents
- if true contents will be copied from the ifram to the main window- Since:
- MicroStrategy Web 8.0.0
-
isInVisualizationMode
public boolean isInVisualizationMode()
Deprecated.- Returns:
- whether the report is in visualization mode
- Since:
- MicroStrategy Web 8.0.2
-
isUrlVisualization
public boolean isUrlVisualization()
Deprecated.- Returns:
- whether the report is in visualization mode and is using a URL to obtain the report
data (the value of preference
EnumWebPreferences.WebPreferenceUseURLForVisualizations
) - Since:
- MicroStrategy Web 8.0.2
-
-