Package com.microstrategy.web.app.transforms

Class RWLayoutTransform

    • Field Detail

      • _jsPage

        protected java.lang.String _jsPage

      • FP_LEVEL_FLAG

        public static final java.lang.String FP_LEVEL_FLAG
        Constant specifying the name of the formal parameter for defining the level flag. Value is levelFlag.
        See Also:
        Constant Field Values

      • FP_GRID_TEMPLATES_STYLE

        public static final java.lang.String FP_GRID_TEMPLATES_STYLE
        Constant specifying the name of the formal parameter for defining the grid style to use with templates. Value is templatesStyle.
        See Also:
        Constant Field Values

      • FP_GRAPH_TEMPLATES_STYLE

        public static final java.lang.String FP_GRAPH_TEMPLATES_STYLE
        Constant specifying the name of the formal parameter for defining the graph style to use with templates. Value is templatesStyle.
        See Also:
        Constant Field Values

      • FP_OUTLINE_GRID_TEMPLATES_STYLE

        public static final java.lang.String FP_OUTLINE_GRID_TEMPLATES_STYLE
        Constant specifying the name of the formal parameter for defining the grid style to use with templates when the template is in outline mode. Value is outlineGridTemplatesStyle.
        See Also:
        Constant Field Values

      • FP_GRID_TEMPLATES_DESIGN_STYLE

        public static final java.lang.String FP_GRID_TEMPLATES_DESIGN_STYLE
        Constant specifying the name of the formal parameter for defining the grid style to use with templates when the template is in design mode and the RW document is in view mode. Value is gridTemplatesDesignStyle.
        Since:
        MicroStrategy Web 8.0.1
        See Also:
        Constant Field Values

      • FP_GRAPH_TEMPLATES_DESIGN_STYLE

        public static final java.lang.String FP_GRAPH_TEMPLATES_DESIGN_STYLE
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • FP_METRICS_UNIT

        public static final java.lang.String FP_METRICS_UNIT
        Constant specifying the name of the formal parameter for metrics unit to used with the rulers.
        See Also:
        Constant Field Values

      • FP_IMG_COLLAPSE

        public static final java.lang.String FP_IMG_COLLAPSE
        Constant specifying the name of the formal parameter for metrics unit to used with the rulers.
        See Also:
        Constant Field Values

      • FP_IMG_EXPAND

        public static final java.lang.String FP_IMG_EXPAND
        Constant specifying the name of the formal parameter for metrics unit to used with the rulers.
        See Also:
        Constant Field Values

      • FP_JS_PREFIX

        public static final java.lang.String FP_JS_PREFIX
        Constant specifying the name of the formal parameter for javascript object's ids prefix.
        See Also:
        Constant Field Values

      • FP_CLIENT_SIDE_DESIGN_MODE_TEMPLATE_MANIPULATIONS

        public static final java.lang.String FP_CLIENT_SIDE_DESIGN_MODE_TEMPLATE_MANIPULATIONS
        Constant specifying whether to use client-side template manipulations in design mode.
        See Also:
        Constant Field Values

      • FP_DPI_CONVERSION

        public static final java.lang.String FP_DPI_CONVERSION
        Constant specifying the spi conversion mode between pixels and inches.
        See Also:
        Constant Field Values

      • FP_GRID_DENSITY

        public static final java.lang.String FP_GRID_DENSITY
        Constant specifying the alignment grid density.
        See Also:
        Constant Field Values

      • FP_MARQUEE_STYLE

        public static final java.lang.String FP_MARQUEE_STYLE
        Constant specifying the marquee selection style.
        See Also:
        Constant Field Values

      • FP_UNITS

        public static final java.lang.String FP_UNITS
        Constant specifying the alignment grid density.
        See Also:
        Constant Field Values

      • FP_CUSTOM_JS_FEATURES

        public static final java.lang.String FP_CUSTOM_JS_FEATURES
        Constant specifying any extra features that will be send down to the client.
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • FP_PROMPTS_EXECUTE_STYLE

        public static final java.lang.String FP_PROMPTS_EXECUTE_STYLE
        name for the formal parameter "promptsExecuteStyle".
        See Also:
        Constant Field Values

      • FP_PROMPTS_CREATE_RW_DATASET_STYLE

        public static final java.lang.String FP_PROMPTS_CREATE_RW_DATASET_STYLE
        name for the formal parameter "promptsCreateRWDatasetStyle".
        Since:
        MicroStrategy Web 8.0.1
        See Also:
        Constant Field Values

      • FP_PROMPTS_EXECUTE_RW_DATASET_STYLE

        public static final java.lang.String FP_PROMPTS_EXECUTE_RW_DATASET_STYLE
        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
        name for the formal parameter "promptsEditStyle".
        See Also:
        Constant Field Values

      • FP_IS_VIEW_MODE_ONLY

        public static final java.lang.String FP_IS_VIEW_MODE_ONLY
        name for the formal parameter "promptsEditStyle".
        Since:
        MicroStrategy Web 8.0.2
        See Also:
        Constant Field Values

      • FP_RWD_DROPZONE_STYLE_NAME

        public static final java.lang.String FP_RWD_DROPZONE_STYLE_NAME
        name for the formal parameter "RWDZStyleName".
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • FP_IS_HTML_EXPORT

        public static final java.lang.String FP_IS_HTML_EXPORT
        See Also:
        Constant Field Values

      • LEVEL_VRULER

        public static final int LEVEL_VRULER
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display the vertical ruler for each subsection.
        value 1
        See Also:
        Constant Field Values

      • LEVEL_HRULER

        public static final int LEVEL_HRULER
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display the horizontal ruler for each subsection.
        value 2
        See Also:
        Constant Field Values

      • LEVEL_SECTION_TITLE

        public static final int LEVEL_SECTION_TITLE
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display the title of each section.
        value 4
        See Also:
        Constant Field Values

      • LEVEL_SUBSECTION_HANDLE

        public static final int LEVEL_SUBSECTION_HANDLE
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display the handle of each subsections.
        value 8
        See Also:
        Constant Field Values

      • LEVEL_ALL

        public static final int LEVEL_ALL
        Allowed value for the levelFlag formal parameter. Convenience flag to indicate all possible LEVEL values.
        value 16777215
        See Also:
        Constant Field Values

      • levelFlag

        protected FormalParameter levelFlag
        Indicates the level of information to use when displaying the Transform. For indicating which fields to show, the value to assign to this formal parameter should be a bitwise flag combining constants such as LEVEL_VRULER, LEVEL_HRULER, LEVEL_SECTION_TITLE, etc.
        value #LEVEL_ALL

      • gridTemplatesStyle

        protected FormalParameter gridTemplatesStyle
        Indicates the grid style to use when rendering Grid objects.

      • outlineGridTemplatesStyle

        protected FormalParameter outlineGridTemplatesStyle
        Indicates the graph style to use when rendering Grid objects in outline mode.

      • graphTemplatesStyle

        protected FormalParameter graphTemplatesStyle
        Indicates the graph style to use when rendering GridGraph objects.

      • graphTemplatesDesignStyle

        protected FormalParameter graphTemplatesDesignStyle
        Since:
        MicroStrategy Web 9.0.0

      • gridTemplatesDesignStyle

        protected FormalParameter gridTemplatesDesignStyle
        Indicates the grid style to use when rendering Grid objects in design mode when the RW document is in view mode. This will be used when the RW document is in view mode and the user decides to add a grid object to the RW document. In this case we will render the grid in design mode with no data unless we go back to the server to get the data.
        Since:
        MicroStrategy Web 8.0.1

      • metricsUnit

        protected FormalParameter metricsUnit
        Indicates the metrics unit to use for the rulers. Possible values are "in" for inches, "px" for pixels, "cm" for cetimeters value "in"

      • imgCollapse

        protected FormalParameter imgCollapse
        Specifies the image file name used by the transform to display a collapsable section.
        It is used to collapse the contents of the section when its children are displayed.
        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 collapsable section, you would need to copy it to the images folder and then specify its name in this formal parameter.

      • imgExpand

        protected FormalParameter imgExpand
        Specifies the image file name used by the transform to display an expandable section.
        It is used to expand the contents of the section by showing its children.
        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 expandable section, you would need to copy it to the images folder and then specify its name in this formal parameter.

      • jsPrefix

        protected FormalParameter jsPrefix
        Prefix to append to all javascript object's ids.

      • promptsExecuteStyle

        protected FormalParameter promptsExecuteStyle
        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.

      • promptsCreateRWDatasetStyle

        protected FormalParameter promptsCreateRWDatasetStyle
        This is the name of the style to use to transform a prompted report writer document (from the Create Document page or when a prompted dataset is added).
        In this case, the cancel and save buttons should not be displayed in the prompt page.
        Since:
        MicroStrategy Web 8.0.1

      • promptsExecuteRWDatasetStyle

        protected FormalParameter promptsExecuteRWDatasetStyle
        This is the name of the style to use to transform a prompted report writer document (when a prompted dataset is added).
        In this case, the cancel and save buttons should not be displayed in the prompt page.
        Since:
        MicroStrategy Web 9.0.0

      • promptsEditStyle

        protected FormalParameter promptsEditStyle
        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.

      • useClientSideManipulations

        protected FormalParameter useClientSideManipulations
        name for the formal parameter "useClientSideManipulations".

      • dpiConversion

        protected FormalParameter dpiConversion
        name for the formal parameter "dpiConversion".

      • gridDensity

        protected FormalParameter gridDensity
        name for the formal parameter "gridDensity".

      • marqueeSelectionStyle

        protected FormalParameter marqueeSelectionStyle
        name for the formal parameter "gridDensity".

      • units

        protected FormalParameter units
        name for the formal parameter "units".

      • customJavaScriptFeatures

        protected FormalParameter customJavaScriptFeatures
        Indicates a comma separated list of the extra features that will be send down to the client
        Since:
        MicroStrategy Web 9.0.0

      • isViewModeOnly

        @Deprecated
protected FormalParameter isViewModeOnly
        Deprecated.
        use useDHTML
        Indicates the only available mode for the document will be HTML view mode.
        Since:
        MicroStrategy Web 8.0.2

      • RWDZStyleName

        protected FormalParameter RWDZStyleName
        Indicates the style name of the Drop Zone Editor
        Since:
        MicroStrategy Web 9.0.0

    • Constructor Detail

      • RWLayoutTransform

        public RWLayoutTransform()
        Default, no argument constructor.

    • Method Detail

      • isIFrameDisplayMode

        public boolean isIFrameDisplayMode()
        Description copied from class: AbstractAppTransform
        Determines if the display mode should consider iframe request or not. A sample application of this logic will be to determine if the COMMENT HTML tags have to be generated in order for the response to be processed correctly by the iframe in the page. If the logic is to be specialized for the application, please overwrite AbstractAppTransform.localIsIFrameDisplayMode().
        Specified by:
        isIFrameDisplayMode in interface AppTransform
        Overrides:
        isIFrameDisplayMode in class AbstractAppTransform
        Returns:
        boolean value indicating if the display mode of this transform should be generated for iframe manipulation or not
        Since:
        MicroStrategy Web 8.1.0

      • renderShell

        public void renderShell​(MarkupOutput out)
        Description copied from class: AbstractAppTransform

        Generates the shell for this Transform.

        The shell is a <div> tag that automatically surrounds the content generated by the Transform. It's used among other things by the javascript to identify the HTML associated with a bone, and by the iFrame update technology to identify a component in the page.

        The attributes to append to this <div> are obtained from the getAttributesShellDiv method; the style from the getStyleShellDiv method.
        This method calls renderCssLink and checkStatus to generate the Transform's content.
        Overrides:
        renderShell in class AbstractAppTransform
        Parameters:
        out - output by this transform
        Since:
        MicroStrategy Web 8.1.0

      • transformForPartialDisplay

        public void transformForPartialDisplay​(MarkupOutput out)
        Since:
        MicroStrategy Web 8.1.0

      • getDpiConversion

        protected int getDpiConversion()
        Since:
        MicroStrategy Web 8.1.0

      • getLocale

        protected java.util.Locale getLocale()
        Description copied from class: AbstractAppTransform
        Returns number/date locale. Should not be used for messages.
        Overrides:
        getLocale in class AbstractAppTransform
        Returns:
        Locale instance
        Since:
        MicroStrategy Web 8.1.0

      • getZoomFactor

        protected int getZoomFactor()
        Since:
        MicroStrategy Web 8.1.0

      • startIteration

        public void startIteration​(MarkupOutput out,
                           boolean definitionOnly)
        Starts iterating the data, by invoking rwi.iterate();

      • startIteration

        public void startIteration​(MarkupOutput out,
                           java.lang.String key,
                           boolean definitionOnly)
        Starts iterating the data, by invoking rwi.iterate();
        Since:
        MicroStrategy Web 8.1.0

      • startIteration

        public void startIteration​(RWBeanVisitor visitor,
                           MarkupOutput out,
                           java.lang.String key,
                           boolean definitionOnly)
        Starts iterating the data, by invoking rwi.iterate();
        Since:
        MicroStrategy Web 8.1.0

      • onStart

        public void onStart​(RWDefinition definition,
                    MarkupOutput out)
        Callback used by RWVisitor for the start of the document.
        Specified by:
        onStart in interface RWBeanVisitor2
        Parameters:
        definition - document definition
        out - markup output
        Since:
        MicroStrategy Web 8.1.0

      • onEnd

        public void onEnd​(MarkupOutput out)
        Callback used by RWVisitor for the end of the document.
        Specified by:
        onEnd in interface RWBeanVisitor2
        Parameters:
        out - markup output
        Since:
        MicroStrategy Web 8.1.0

      • onStartSubsection

        public void onStartSubsection​(RWSection section,
                              MarkupOutput out)
        Callback used by RWVisitor for a new SubSection.
        Specified by:
        onStartSubsection in interface RWBeanVisitor2
        Parameters:
        section - subsection
        out - markup output
        Since:
        MicroStrategy Web 8.1.0

      • onEndSubsection

        public void onEndSubsection​(RWSection section,
                            MarkupOutput out,
                            boolean borderedSubsection)
        Callback used by RWVisitor to end a subsection.
        Specified by:
        onEndSubsection in interface RWBeanVisitor2
        Parameters:
        section - the subsection before the border.
        out - the markup output.
        Since:
        MicroStrategy Web 8.1.0

      • renderDashboardControl

        public void renderDashboardControl​(MarkupOutput out,
                                   RWObject control)
        Since:
        MicroStrategy Web 8.1.0

      • getCurrentSliceId

        public int getCurrentSliceId​(java.lang.String key)

      • onObject

        public void onObject​(ViewBean viewBean,
                     RWObject ob,
                     MarkupOutput out)
        Description copied from interface: RWBeanVisitor

        Specific case where RWObject#getDefinition().getType == EnumRWUnitTypes.RWUNIT_GRIDGRAPH The corresponding data value is encapsulated in a ViewBean for ease of use.

        Specified by:
        onObject in interface RWBeanVisitor
        Parameters:
        viewBean - an embedded bean.
        ob - the report writing document object.
        out - the markup output.
        See Also:
        RWVisitor.onObject(RWObject)

      • renderPanelStackStart

        public void renderPanelStackStart​(MarkupOutput out,
                                  RWSection section)
        Since:
        MicroStrategy Web 8.1.0

      • renderPanelStackTitleBar

        public void renderPanelStackTitleBar​(MarkupOutput out,
                                     RWObject object)
        Since:
        MicroStrategy Web 8.1.0

      • renderPanelStackEnd

        public void renderPanelStackEnd​(MarkupOutput out,
                                RWSection section)
        Since:
        MicroStrategy Web 8.1.0

      • isCurrentPanel

        public boolean isCurrentPanel​(RWSection section)
        Since:
        MicroStrategy Web 8.1.0

      • renderPanelStart

        public void renderPanelStart​(MarkupOutput out,
                             RWSection section)
        Since:
        MicroStrategy Web 8.1.0

      • renderPanelEnd

        public void renderPanelEnd​(MarkupOutput out,
                           RWSection section)
        Since:
        MicroStrategy Web 8.1.0

      • renderSubsectionEnd

        @Deprecated
public void renderSubsectionEnd​(MarkupOutput out,
                                RWSection section)
        Deprecated.
        This method has been deprecated. Insted use the method renderSubsectionEnd(MarkupOutput out, RWSection section, boolean renderSubsectionDivider)

      • renderSubsectionEnd

        public void renderSubsectionEnd​(MarkupOutput out,
                                RWSection section,
                                boolean renderSubsectionDivider)
        Since:
        MicroStrategy Web 8.1.0

      • hasCharts

        public boolean hasCharts()
        Since:
        MicroStrategy Web 9.0.0

      • renderHTMLContainer

        public void renderHTMLContainer​(MarkupOutput out,
                                RWObject htmlContainer)
        Since:
        MicroStrategy Web 9.0.0

      • getWebHyperLinks

        public java.util.Iterator<WebHyperLinkContainer> getWebHyperLinks()
        Since:
        MicroStrategy Web 9.0.0

      • updateGridVisualizationTransform

        protected void updateGridVisualizationTransform​(RWObject object,
                                                ViewBean vb,
                                                TransformInstance ti)
        Add necessary formal parameters to the Grid Visualization transform
        Parameters:
        object - RWObject
        vb - View Bean
        ti - Transform Instance

      • renderClipboardGrid

        protected void renderClipboardGrid​(MarkupOutput out,
                                   RWObject object)
        Since:
        MicroStrategy Web 9.0.0

      • renderGrid

        protected void renderGrid​(MarkupOutput out,
                          RWObject object,
                          ViewBean grid,
                          boolean isDormantBone)
        Parameters:
        out -
        object -
        grid -
        isDormantBone -
        Since:
        MicroStrategy Web 9.0.0

      • setupOndemandContextMenuModelView

        protected void setupOndemandContextMenuModelView​(MarkupOutput out)
        Sets up the context menu model and view for ondemand loading of context menu items and renders in the Markupoutput
        Parameters:
        out - MarkupOutput object
        Since:
        MicroStrategy Web 9.0.0

      • renderPlaceFolder

        public void renderPlaceFolder​(RWObject object,
                              MarkupOutput out)
        Since:
        MicroStrategy Web 8.1.0

      • renderTitleBar

        public void renderTitleBar​(MarkupOutput out,
                           RWObject object,
                           boolean isGridEmpty)
        Since:
        MicroStrategy Web 9.0.0

      • renderTitleBar

        public void renderTitleBar​(MarkupOutput out,
                           RWObject object)
        Since:
        MicroStrategy Web 8.1.0

      • renderControlTitleBar

        public void renderControlTitleBar​(MarkupOutput out,
                                  RWObject object)
        Since:
        MicroStrategy Web 9.0.3

      • renderHRuler

        public void renderHRuler​(MarkupOutput out)
        Parameters:
        out -

      • renderRulerStyle

        public void renderRulerStyle​(MarkupOutput out)
        Since:
        MicroStrategy Web 9.0.0

      • renderVRuler

        public void renderVRuler​(MarkupOutput out,
                         RWSection section)
        Parameters:
        out -
        section -

      • renderHorizontalContainerHandle

        public void renderHorizontalContainerHandle​(MarkupOutput out)
        Since:
        MicroStrategy Web 9.0.0

      • renderPartialBoneProperties

        public void renderPartialBoneProperties​(MarkupOutput out)

      • getFeaturesList

        public static final java.lang.String[] getFeaturesList()
        Returns:
        a copy of the features String array that is sent to the RW execution page
        Since:
        MicroStrategy Web 9.0.0

      • getNextId

        protected int getNextId()
        Returns the next integer to use as objectId for new objects
        Returns:
        the int value of getRWBean().getRWInstance().getDefinition().getKeySeed()

      • initializeJavascript

        protected void initializeJavascript()

      • getDescription

        public java.lang.String getDescription()
        Display's the description of this transform for StyleCatalog
        Specified by:
        getDescription in interface Transform
        Returns:
        This transform displays the data of a Report Writing Document.

      • renderImage

        public void renderImage​(MarkupOutput out,
                        java.lang.String image)
        Renders a transform's image
        Overrides:
        renderImage in class AbstractRWTransform
        Parameters:
        out - where to write the output of the method.
        image - the image name

      • isDhtml

        public boolean isDhtml()
        Description copied from class: AbstractAppTransform
        Determine if the environment where this transform instance is being used is DHTML or not
        Overrides:
        isDhtml in class AbstractAppTransform
        Returns:
        boolean value indicating the environment is DHTML or not.
        Since:
        MicroStrategy Web 8.0.2

      • getContextMenuManagerName

        protected java.lang.String getContextMenuManagerName()
        Description copied from class: AbstractAppTransform
        Returns the name to use for the ContextMenuManager of this Transform. By default, it uses getID() + "_cmm". Transforms may override this method in case they need a different value.
        Overrides:
        getContextMenuManagerName in class AbstractAppTransform
        Since:
        MicroStrategy Web 8.0.1

      • renderContextMenu

        @Deprecated
public void renderContextMenu​(MarkupOutput out)
        Deprecated.
        This method is not used anymore and will be removed in future versions of the product. To customize context-menus use the xml-definition specified by AbstractAppTransform.contextMenus
        Renders the context menu context to use in the transform
        Parameters:
        out - where to write the output of the method.

      • renderGoverningMessage

        public void renderGoverningMessage​(MarkupOutput out)
        Renders a message in the page indicated the document has exceeded the limits of xml creation in the intelligence server.
        Parameters:
        out -

      • renderGridCss

        public void renderGridCss​(MarkupOutput out)

      • getBeanXml

        protected java.lang.String getBeanXml()
        Returns the Bean's xml. This is only implemented for beans that extends WebBean, for other beans, the transform needs to overwrite this method.
        Returns:
        The bean's getDocument() results. If the bean doesn't support it or an exception is thrown, returns [na]

      • getHyperLinks

        public HashList getHyperLinks()
        Since:
        MicroStrategy Web 9.0.0

      • addStyleRule

        protected void addStyleRule​(java.lang.String key)
                     throws java.lang.IllegalArgumentException
        Throws:
        java.lang.IllegalArgumentException
        Since:
        MicroStrategy Web 8.1.0

      • getID

        public java.lang.String getID()
        TQMS 372960 This method overwrites the super implementation of the getID() so that the id of the shell div of the rwb_viewer, or the id that contains the rwb_viewer shell stays the same when adding prompted datasets. The original issue happens because in design mode, it was rwbDocumentDesignStyle, but after adding a prompeted dataset it changes to rwbDocumentViewStyle
        Specified by:
        getID in interface Transform
        Overrides:
        getID in class AbstractAppTransform
        Returns:
        the component's unique id