Class RWLayoutTransform
- 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.AbstractRWTransform
-
- com.microstrategy.web.app.transforms.RWLayoutTransform
-
- All Implemented Interfaces:
AppTransform
,RWBeanVisitor
,RWBeanVisitor2
,Transform
- Direct Known Subclasses:
AbstractRWDataVisualizationTransform
public class RWLayoutTransform extends AbstractRWTransform implements RWBeanVisitor2
This transform displays the data of a Report Writing Document. It implements the RWBeanVisitor to iterate through the RWData and provides individual methods to render sections, subsections and objects.- Since:
- MicroStrategy Web 8.0.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RWLayoutTransform.ButtonHelper
-
Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractRWTransform
AbstractRWTransform.ButtonAlignmentsHelper
-
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
_jsPage
protected FormalParameter
customJavaScriptFeatures
Indicates a comma separated list of the extra features that will be send down to the clientprotected FormalParameter
dpiConversion
name for the formal parameter "dpiConversion".static java.lang.String
FP_CLIENT_SIDE_DESIGN_MODE_TEMPLATE_MANIPULATIONS
Constant specifying whether to use client-side template manipulations in design mode.static java.lang.String
FP_CUSTOM_JS_FEATURES
Constant specifying any extra features that will be send down to the client.static java.lang.String
FP_DPI_CONVERSION
Constant specifying the spi conversion mode between pixels and inches.static java.lang.String
FP_GRAPH_TEMPLATES_DESIGN_STYLE
static java.lang.String
FP_GRAPH_TEMPLATES_STYLE
Constant specifying the name of the formal parameter for defining the graph style to use with templates.static java.lang.String
FP_GRID_DENSITY
Constant specifying the alignment grid density.static 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.static java.lang.String
FP_GRID_TEMPLATES_STYLE
Constant specifying the name of the formal parameter for defining the grid style to use with templates.static java.lang.String
FP_IMG_COLLAPSE
Constant specifying the name of the formal parameter for metrics unit to used with the rulers.static java.lang.String
FP_IMG_EXPAND
Constant specifying the name of the formal parameter for metrics unit to used with the rulers.static java.lang.String
FP_IS_HTML_EXPORT
static java.lang.String
FP_IS_VIEW_MODE_ONLY
name for the formal parameter "promptsEditStyle".static java.lang.String
FP_JS_PREFIX
Constant specifying the name of the formal parameter for javascript object's ids prefix.static java.lang.String
FP_LEVEL_FLAG
Constant specifying the name of the formal parameter for defining the level flag.static java.lang.String
FP_MARQUEE_STYLE
Constant specifying the marquee selection style.static java.lang.String
FP_METRICS_UNIT
Constant specifying the name of the formal parameter for metrics unit to used with the rulers.static 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.static java.lang.String
FP_PROMPTS_CREATE_RW_DATASET_STYLE
name for the formal parameter "promptsCreateRWDatasetStyle".static java.lang.String
FP_PROMPTS_EDIT_STYLE
name for the formal parameter "promptsEditStyle".static java.lang.String
FP_PROMPTS_EXECUTE_RW_DATASET_STYLE
static java.lang.String
FP_PROMPTS_EXECUTE_STYLE
name for the formal parameter "promptsExecuteStyle".static java.lang.String
FP_RWD_DROPZONE_STYLE_NAME
name for the formal parameter "RWDZStyleName".static java.lang.String
FP_UNITS
Constant specifying the alignment grid density.protected FormalParameter
graphTemplatesDesignStyle
protected FormalParameter
graphTemplatesStyle
Indicates the graph style to use when rendering GridGraph objects.protected FormalParameter
gridDensity
name for the formal parameter "gridDensity".protected FormalParameter
gridTemplatesDesignStyle
Indicates the grid style to use when rendering Grid objects in design mode when the RW document is in view mode.protected FormalParameter
gridTemplatesStyle
Indicates the grid style to use when rendering Grid objects.protected static java.lang.String
ID_POSTFIX
protected FormalParameter
imgCollapse
Specifies the image file name used by the transform to display a collapsable section.protected FormalParameter
imgExpand
Specifies the image file name used by the transform to display an expandable section.protected FormalParameter
isHTMLExport
protected FormalParameter
isViewModeOnly
Deprecated.useuseDHTML
protected FormalParameter
jsPrefix
Prefix to append to all javascript object's ids.static int
LEVEL_ALL
Allowed value for thelevelFlag
formal parameter.static int
LEVEL_HRULER
Allowed value for thelevelFlag
formal parameter.static int
LEVEL_SECTION_TITLE
Allowed value for thelevelFlag
formal parameter.static int
LEVEL_SUBSECTION_HANDLE
Allowed value for thelevelFlag
formal parameter.static int
LEVEL_VRULER
Allowed value for thelevelFlag
formal parameter.protected FormalParameter
levelFlag
Indicates the level of information to use when displaying the Transform.protected FormalParameter
marqueeSelectionStyle
name for the formal parameter "gridDensity".protected FormalParameter
metricsUnit
Indicates the metrics unit to use for the rulers.protected FormalParameter
outlineGridTemplatesStyle
Indicates the graph style to use when rendering Grid objects in outline mode.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).protected FormalParameter
promptsEditStyle
This is the name of the style to use to transform a prompted grid when editing reports.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).protected FormalParameter
promptsExecuteStyle
This is the name of the style to use to transform a prompted grid when normal report execution.protected FormalParameter
RWDZStyleName
Indicates the style name of the Drop Zone Editorprotected FormalParameter
units
name for the formal parameter "units".protected FormalParameter
useClientSideManipulations
name for the formal parameter "useClientSideManipulations".-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractRWTransform
imgError
-
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 RWLayoutTransform()
Default, no argument constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected void
addStyleRule(java.lang.String key)
java.util.Map
getAttributesShellDiv()
Returns a Map with the list of attributes that the shell div must use.protected java.lang.String
getBeanPath()
Returns the path within the application of the WebBean being transformed.protected java.lang.String
getBeanXml()
Returns the Bean's xml.protected java.lang.String
getBoneId()
Returns the id to be used for the JavaScript bone.protected java.lang.String
getContextMenuManagerName()
Returns the name to use for theContextMenuManager
of this Transform.WebEvent
getContinueEvent()
Returns an event to continue browsing if an error happened.int
getCurrentSliceId(java.lang.String key)
java.lang.String
getDescription()
Display's the description of this transform for StyleCatalogprotected int
getDpiConversion()
protected JsonGenerator
getFeatures()
static java.lang.String[]
getFeaturesList()
HashList
getHyperLinks()
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.protected java.util.Locale
getLocale()
Returns number/date locale.protected int
getNextId()
Returns the next integer to use as objectId for new objectsprotected TransformInstance
getPromptsTransform(RWBean rw)
protected TransformInstance
getReportGraphTransform(RWObject object, ViewBean vb)
protected TransformInstance
getReportGridTransform(RWObject object, ViewBean vb)
protected TransformInstance
getReportOutlineGridTransform(RWObject object, ViewBean vb)
protected TransformInstance
getReportVisualizationTransform(RWObject object, ViewBean vb)
java.lang.Class
getSupportedBeanType()
Returns the BeanType supported by this bean.java.util.Iterator<WebHyperLinkContainer>
getWebHyperLinks()
protected int
getZoomFactor()
boolean
hasCharts()
void
initializeCss()
ExtendsAbstractAppTransform.initializeCss()
by initializing private css classes used by this transform.void
initializeImages()
Initialize the images to be used by this transform.protected void
initializeJavascript()
void
initializeTransform(Transformable data)
ExtendsAbstractAppTransform.initializeTransform(com.microstrategy.web.beans.Transformable)
by obtaining a reference to the databoolean
isContextMenusEnabled()
Indicates whether context-menus are enabled for this Transform.boolean
isCurrentPanel(RWSection section)
boolean
isDhtml()
Determine if the environment where this transform instance is being used is DHTML or notboolean
isIFrameDisplayMode()
Determines if the display mode should consider iframe request or not.void
onEnd(MarkupOutput out)
Callback used by RWVisitor for the end of the document.void
onEndSection(RWSection section, MarkupOutput out)
Callback used by RWVisitor to end a Section.void
onEndSubsection(RWSection section, MarkupOutput out, boolean borderedSubsection)
Callback used by RWVisitor to end a subsection.void
onObject(RWBean rwBean, RWObject ob, MarkupOutput out)
This method is implemented as part of the interface, but it actually does not renders subvoid
onObject(ViewBean viewBean, RWObject ob, MarkupOutput out)
Specific case whereRWObject#getDefinition().getType == EnumRWUnitTypes.RWUNIT_GRIDGRAPH
The corresponding data value is encapsulated in a ViewBean for ease of use.void
onObject(RWObject object, MarkupOutput out)
Callback used by RWVisitor for individual objects.void
onStart(RWDefinition definition, MarkupOutput out)
Callback used by RWVisitor for the start of the document.void
onStartSection(RWSection section, MarkupOutput out)
Callback used by RWVisitor for a new Section.void
onStartSubsection(RWSection section, MarkupOutput out)
Callback used by RWVisitor for a new SubSection.protected void
renderClipboardGrid(MarkupOutput out, RWObject object)
void
renderContextMenu(MarkupOutput out)
Deprecated.This method is not used anymore and will be removed in future versions of the product.void
renderControlTitleBar(MarkupOutput out, RWObject object)
void
renderDashboardControl(MarkupOutput out, RWObject control)
void
renderGoverningMessage(MarkupOutput out)
Renders a message in the page indicated the document has exceeded the limits of xml creation in the intelligence server.void
renderGrid(MarkupOutput out, RWObject object, ViewBean grid)
protected void
renderGrid(MarkupOutput out, RWObject object, ViewBean grid, boolean isDormantBone)
void
renderGridCss(MarkupOutput out)
void
renderHorizontalContainerHandle(MarkupOutput out)
void
renderHRuler(MarkupOutput out)
void
renderHTMLContainer(MarkupOutput out, RWObject htmlContainer)
void
renderImage(MarkupOutput out, RWObject image)
void
renderImage(MarkupOutput out, java.lang.String image)
Renders a transform's imagevoid
renderLine(MarkupOutput out, RWObject line)
void
renderPanelEnd(MarkupOutput out, RWSection section)
void
renderPanelStackEnd(MarkupOutput out, RWSection section)
void
renderPanelStackStart(MarkupOutput out, RWSection section)
void
renderPanelStackTitleBar(MarkupOutput out, RWObject object)
void
renderPanelStart(MarkupOutput out, RWSection section)
void
renderPartialBoneProperties(MarkupOutput out)
void
renderPlaceFolder(RWObject object, MarkupOutput out)
void
renderRegisterBone(MarkupOutput out)
If a scriptClass is specified, this method registers the corresponding javascript bone for this component.void
renderRulerStyle(MarkupOutput out)
void
renderSectionEnd(MarkupOutput out, RWSection section)
void
renderSectionStart(MarkupOutput out, RWSection section)
void
renderSectionTitle(MarkupOutput out, RWSection section)
void
renderShape(MarkupOutput out, RWObject shape)
void
renderShell(MarkupOutput out)
Generates the shell for this Transform.void
renderSubsectionEnd(MarkupOutput out, RWSection section)
Deprecated.This method has been deprecated.void
renderSubsectionEnd(MarkupOutput out, RWSection section, boolean renderSubsectionDivider)
void
renderSubsectionHandle(MarkupOutput out, RWSection section)
void
renderSubsectionStart(MarkupOutput out, RWSection section)
void
renderText(MarkupOutput out, RWObject label)
void
renderTitleBar(MarkupOutput out, RWObject object)
void
renderTitleBar(MarkupOutput out, RWObject object, boolean isGridEmpty)
void
renderVRuler(MarkupOutput out, RWSection section)
protected void
setupOndemandContextMenuModelView(MarkupOutput out)
Sets up the context menu model and view for ondemand loading of context menu items and renders in the Markupoutputvoid
startIteration(MarkupOutput out, boolean definitionOnly)
Starts iterating the data, by invokingrwi.iterate();
void
startIteration(MarkupOutput out, java.lang.String key, boolean definitionOnly)
Starts iterating the data, by invokingrwi.iterate();
void
startIteration(RWBeanVisitor visitor, MarkupOutput out, java.lang.String key, boolean definitionOnly)
Starts iterating the data, by invokingrwi.iterate();
void
transformForPartialDisplay(MarkupOutput out)
void
transformForRequestSuccessful(MarkupOutput out)
Generates the output when the bean's status isEnumRequestStatus.WebBeanRequestSuccessful
.void
transformForRequestWaitingForUserInput(MarkupOutput out)
Method that generates the output when the bean is WaitingForUserInput.protected void
updateGridVisualizationTransform(RWObject object, ViewBean vb, TransformInstance ti)
Add necessary formal parameters to the Grid Visualization transform-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractRWTransform
displayError, generateErrorForIframe, getCancelEvent, getDocumentStatus, getDocumentStatusDescriptorKey, getErrorMessage, getErrorTitle, getHistoryListEvent, getInboxSource, getJobExpiredMessage, getReexecuteButtonDescription, getRefreshEvent, getRWBean, getRWFrame, getViewDetailsEvent, getWebReexecuteEvent, isDesignMode, renderHistoryListButton, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoDetails, renderProcessingInfoStatus, renderViewDetailsButton, setWebReexecuteEventArguments, transformForRequestInError, transformForRequestNotInited, updateVisTransform
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractWebBeanTransform
getReexcuteEventFromBean, getTaskProcessorBaseURL, renderJobExpiredSection
-
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, getClientSideHelper, getContainerServices, getContext, getContextMenu, getContextMenuManager, getContextMenusDefinition, getCssPrefix, getDateFormat, getDebugOut, getDescriptor, getDescriptor, getDescriptor, getDescriptor, getDisplayMode, getDisplayName, getErrorMessage, getErrorMessage, getErrorTitle, getErrorTitle, getEventManager, getFirstDayOfWeek, getFloatValue, getHelpPath, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getPreferenceValue, getProjectID, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, initializeWebComponent, is508, isBlockMode, isDialog, isDormant, isFeatureAvailable, isIFrameEnabled, 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, renderSelf, renderSubBlock, renderUserHelpAnchor, setBoneProperties, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, transformForRequestProcessing
-
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
-
_jsPage
protected java.lang.String _jsPage
-
ID_POSTFIX
protected static final java.lang.String ID_POSTFIX
- See Also:
- Constant Field Values
-
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 thelevelFlag
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 thelevelFlag
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 thelevelFlag
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 thelevelFlag
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 thelevelFlag
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 asLEVEL_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
protected FormalParameter isViewModeOnly
Deprecated.useuseDHTML
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
-
isHTMLExport
protected FormalParameter isHTMLExport
-
-
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 overwriteAbstractAppTransform.localIsIFrameDisplayMode()
.- Specified by:
isIFrameDisplayMode
in interfaceAppTransform
- Overrides:
isIFrameDisplayMode
in classAbstractAppTransform
- 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
The attributes to append to this<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.<div>
are obtained from thegetAttributesShellDiv
method; the style from thegetStyleShellDiv
method.
This method callsrenderCssLink
andcheckStatus
to generate the Transform's content.- Overrides:
renderShell
in classAbstractAppTransform
- Parameters:
out
- output by this transform- Since:
- MicroStrategy Web 8.1.0
-
transformForPartialDisplay
public void transformForPartialDisplay(MarkupOutput out)
- Since:
- MicroStrategy Web 8.1.0
-
transformForRequestSuccessful
public void transformForRequestSuccessful(MarkupOutput out)
Description copied from class:AbstractAppTransform
Generates the output when the bean's status isEnumRequestStatus.WebBeanRequestSuccessful
. This is the main entry point to generate the output for those Transforms that just want to render the "regular" bean case.
This is an abstract method. All classes need to implement it.- Specified by:
transformForRequestSuccessful
in classAbstractAppTransform
- Parameters:
out
- output by this transform- See Also:
AbstractAppTransform.transformForRequestSuccessful(com.microstrategy.web.beans.MarkupOutput)
-
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 classAbstractAppTransform
- Returns:
- Locale instance
- Since:
- MicroStrategy Web 8.1.0
-
getZoomFactor
protected int getZoomFactor()
- Since:
- MicroStrategy Web 8.1.0
-
getPromptsTransform
protected TransformInstance getPromptsTransform(RWBean rw)
-
transformForRequestWaitingForUserInput
public void transformForRequestWaitingForUserInput(MarkupOutput out)
Method that generates the output when the bean is WaitingForUserInput.
It checks if the child bean in this state is the RW bean, and if so transforms it using the correct style.- Overrides:
transformForRequestWaitingForUserInput
in classAbstractAppTransform
- Parameters:
out
- where to write the output of the method.- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
initializeImages
public void initializeImages()
Initialize the images to be used by this transform.- Overrides:
initializeImages
in classAbstractRWTransform
-
startIteration
public void startIteration(MarkupOutput out, boolean definitionOnly)
Starts iterating the data, by invokingrwi.iterate();
-
startIteration
public void startIteration(MarkupOutput out, java.lang.String key, boolean definitionOnly)
Starts iterating the data, by invokingrwi.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 invokingrwi.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 interfaceRWBeanVisitor2
- Parameters:
definition
- document definitionout
- 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 interfaceRWBeanVisitor2
- Parameters:
out
- markup output- Since:
- MicroStrategy Web 8.1.0
-
onStartSection
public void onStartSection(RWSection section, MarkupOutput out)
Callback used by RWVisitor for a new Section.- Specified by:
onStartSection
in interfaceRWBeanVisitor
- Parameters:
section
- the report writing document section.out
- the markup output.- See Also:
RWVisitor.onStartSection(RWSection)
-
onStartSubsection
public void onStartSubsection(RWSection section, MarkupOutput out)
Callback used by RWVisitor for a new SubSection.- Specified by:
onStartSubsection
in interfaceRWBeanVisitor2
- Parameters:
section
- subsectionout
- markup output- Since:
- MicroStrategy Web 8.1.0
-
onEndSection
public void onEndSection(RWSection section, MarkupOutput out)
Callback used by RWVisitor to end a Section.- Specified by:
onEndSection
in interfaceRWBeanVisitor
- Parameters:
section
- the report writing document section.out
- the markup output.- See Also:
RWVisitor.onEndSection(RWSection)
-
onEndSubsection
public void onEndSubsection(RWSection section, MarkupOutput out, boolean borderedSubsection)
Callback used by RWVisitor to end a subsection.- Specified by:
onEndSubsection
in interfaceRWBeanVisitor2
- Parameters:
section
- the subsection before the border.out
- the markup output.- Since:
- MicroStrategy Web 8.1.0
-
onObject
public void onObject(RWObject object, MarkupOutput out)
Callback used by RWVisitor for individual objects.- Specified by:
onObject
in interfaceRWBeanVisitor
- Parameters:
object
- the report writing document object.out
- the markup output.- See Also:
RWVisitor.onObject(RWObject)
-
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 interfaceRWBeanVisitor
- Parameters:
viewBean
- an embedded bean.ob
- the report writing document object.out
- the markup output.- See Also:
RWVisitor.onObject(RWObject)
-
onObject
public void onObject(RWBean rwBean, RWObject ob, MarkupOutput out)
This method is implemented as part of the interface, but it actually does not renders sub- Specified by:
onObject
in interfaceRWBeanVisitor
- Parameters:
rwBean
- 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
-
renderSectionStart
public void renderSectionStart(MarkupOutput out, RWSection section)
-
renderSectionEnd
public void renderSectionEnd(MarkupOutput out, RWSection section)
-
renderSubsectionStart
public void renderSubsectionStart(MarkupOutput out, RWSection section)
-
renderSubsectionEnd
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
-
renderText
public void renderText(MarkupOutput out, RWObject label)
-
renderImage
public void renderImage(MarkupOutput out, RWObject image)
-
renderShape
public void renderShape(MarkupOutput out, RWObject shape)
-
renderLine
public void renderLine(MarkupOutput out, RWObject line)
-
hasCharts
public boolean hasCharts()
- Since:
- MicroStrategy Web 9.0.0
-
renderHTMLContainer
public void renderHTMLContainer(MarkupOutput out, RWObject htmlContainer)
- Since:
- MicroStrategy Web 9.0.0
-
getContinueEvent
public WebEvent getContinueEvent()
Description copied from class:AbstractRWTransform
Returns an event to continue browsing if an error happened.- Overrides:
getContinueEvent
in classAbstractRWTransform
-
getWebHyperLinks
public java.util.Iterator<WebHyperLinkContainer> getWebHyperLinks()
- Since:
- MicroStrategy Web 9.0.0
-
getReportGridTransform
protected TransformInstance getReportGridTransform(RWObject object, ViewBean vb)
-
getReportVisualizationTransform
protected TransformInstance getReportVisualizationTransform(RWObject object, ViewBean vb)
- Since:
- MicroStrategy Web 8.0.2
-
updateGridVisualizationTransform
protected void updateGridVisualizationTransform(RWObject object, ViewBean vb, TransformInstance ti)
Add necessary formal parameters to the Grid Visualization transform- Parameters:
object
- RWObjectvb
- View Beanti
- Transform Instance
-
getReportGraphTransform
protected TransformInstance getReportGraphTransform(RWObject object, ViewBean vb)
-
getReportOutlineGridTransform
protected TransformInstance getReportOutlineGridTransform(RWObject object, ViewBean vb)
-
renderClipboardGrid
protected void renderClipboardGrid(MarkupOutput out, RWObject object)
- Since:
- MicroStrategy Web 9.0.0
-
renderGrid
public void renderGrid(MarkupOutput out, RWObject object, ViewBean grid)
- Parameters:
out
-object
-grid
-
-
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
-
-
renderSubsectionHandle
public void renderSubsectionHandle(MarkupOutput out, RWSection section)
-
renderHorizontalContainerHandle
public void renderHorizontalContainerHandle(MarkupOutput out)
- Since:
- MicroStrategy Web 9.0.0
-
renderSectionTitle
public void renderSectionTitle(MarkupOutput out, RWSection section)
-
renderPartialBoneProperties
public void renderPartialBoneProperties(MarkupOutput out)
-
renderRegisterBone
public void renderRegisterBone(MarkupOutput out)
Description copied from class:AbstractAppTransform
If a scriptClass is specified, this method registers the corresponding javascript bone for this component.- Overrides:
renderRegisterBone
in classAbstractAppTransform
- Parameters:
out
- MarkupOutput whether the output should be rendered.- See Also:
AbstractAppTransform.getScriptClass()
-
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
-
getFeatures
protected JsonGenerator getFeatures()
-
getBeanPath
protected java.lang.String getBeanPath()
Description copied from class:AbstractAppTransform
Returns the path within the application of the WebBean being transformed.
When submitting anWebEvent
, this path allows Microstrategy Web to uniquely identify the location of the bean that needs to handle the event.
This method is used by therenderRegisterBone
method to inform the javascript bone the bean to whom it should send its server-side requests.- Overrides:
getBeanPath
in classAbstractAppTransform
- Returns:
- String
- Since:
- MicroStrategy Web 9.0.0
- See Also:
WebComponent.getPath()
,AbstractAppTransform.renderRegisterBone(com.microstrategy.web.beans.MarkupOutput)
-
getBoneId
protected java.lang.String getBoneId()
Description copied from class:AbstractAppTransform
Returns the id to be used for the JavaScript bone.
This method is used by therenderRegisterBone
method to indicate the id of the bone html element.- Overrides:
getBoneId
in classAbstractAppTransform
- Returns:
- String
- Since:
- MicroStrategy Web 9.0.0
- See Also:
AbstractAppTransform.renderRegisterBone(com.microstrategy.web.beans.MarkupOutput)
-
getNextId
protected int getNextId()
Returns the next integer to use as objectId for new objects- Returns:
- the int value of getRWBean().getRWInstance().getDefinition().getKeySeed()
-
initializeTransform
public void initializeTransform(Transformable data)
ExtendsAbstractAppTransform.initializeTransform(com.microstrategy.web.beans.Transformable)
by obtaining a reference to the data- Specified by:
initializeTransform
in interfaceAppTransform
- Overrides:
initializeTransform
in classAbstractRWTransform
- Parameters:
data
- The bean to transform.
-
initializeJavascript
protected void initializeJavascript()
-
initializeCss
public void initializeCss()
ExtendsAbstractAppTransform.initializeCss()
by initializing private css classes used by this transform.- Overrides:
initializeCss
in classAbstractAppTransform
-
getSupportedBeanType
public java.lang.Class getSupportedBeanType()
Returns the BeanType supported by this bean. (non-Javadoc)- Specified by:
getSupportedBeanType
in interfaceTransform
- Overrides:
getSupportedBeanType
in classAbstractRWTransform
- Returns:
- RWBean.class
-
getDescription
public java.lang.String getDescription()
Display's the description of this transform for StyleCatalog- Specified by:
getDescription
in interfaceTransform
- 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 classAbstractRWTransform
- Parameters:
out
- where to write the output of the method.image
- the image name
-
isContextMenusEnabled
public boolean isContextMenusEnabled()
Description copied from class:AbstractAppTransform
Indicates whether context-menus are enabled for this Transform. By default context-menus are enabled only if theAbstractAppTransform.contextMenus
formal parameter has been set.- Overrides:
isContextMenusEnabled
in classAbstractAppTransform
- Returns:
true
if context-menus are enabled in this Transform.- Since:
- MicroStrategy Web 8.0.1
-
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 classAbstractAppTransform
- 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 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.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 byAbstractAppTransform.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 interfaceTransform
- Overrides:
getID
in classAbstractAppTransform
- Returns:
- the component's unique id
-
getAttributesShellDiv
public java.util.Map getAttributesShellDiv()
Description copied from class:AbstractAppTransform
Returns a Map with the list of attributes that the shell div must use. The shell is the main div surrounding the Transform's output.
This method can be overriden in case the subclass would like to add or change the value of attributes in the shell.- Overrides:
getAttributesShellDiv
in classAbstractAppTransform
- See Also:
AbstractAppTransform.renderShell(com.microstrategy.web.beans.MarkupOutput)
-
-