Class TabPageOutputTransform
- java.lang.Object
 - 
- com.microstrategy.web.transform.AbstractTransform
 - 
- com.microstrategy.web.transform.AbstractLayoutTransform
 - 
- com.microstrategy.web.app.transforms.AbstractAppTransform
 - 
- com.microstrategy.web.app.transforms.AbstractTabTransform
 - 
- com.microstrategy.web.app.transforms.TabPageOutputTransform
 
 
 
 
 
 
- 
- All Implemented Interfaces:
 AppTransform,LayoutTransform,Transform
public class TabPageOutputTransform extends AbstractTabTransform implements LayoutTransform
Deprecated.all properties from this tab have been moved to either theTabPageSetupTransformor theTabDocumentExportTransform.This class transforms a
TabBeanallowing users to view/modify general page output properties (like graphs format, PDF settings, horizontal fit). As with other TabTransforms, this one assumes itsTabManagerBeanwill take care of rendering the required HTML & Javascript allowing users to switch between different formattingTabBeaninstances.The output of this transform is divided into three sections:
- Horizontal Fit section
 - Graph Format section
 - PDF section
 
Each one of these sections has its ownrendermethod. Furthermore each section generates individual settings which are generated in their own render method. This Transform implementsLayoutTransform, therefore its render methods can be invoked using a custom layout-xml. When this is the case, the layout-xml specified in the style-catalog controls which methods are called and in which order. Otherwise, the default output of this transform is divided as follows:
Contents / ContentsBody ------------------------------------- | | | Horizontal fit Section | | | ------------------------------------- | | | Graph Format Section | | | ------------------------------------- | | | PDF Section | | | -------------------------------------- Since:
 - MicroStrategy Web 8.0.0
 
 
- 
- 
Nested Class Summary
- 
Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
AbstractAppTransform.Context 
 - 
 
- 
Field Summary
- 
Fields inherited from class com.microstrategy.web.app.transforms.AbstractTabTransform
cssBody, cssFrame, cssPicker, cssPickers, FP_TAB_HEIGHT, scriptClassBody, scriptClassFrame, styBody, styFrame, tabHeight, tyBody, tyFrame 
- 
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 TabPageOutputTransform()Deprecated.Default empty constructor. 
- 
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.lang.StringgetDescription()Deprecated.Returns the textual description of the transformjava.lang.ClassgetSupportedBeanType()Deprecated.Returns the supported bean type.voidinitializeCss()Deprecated.Initializes the Css Classes to use.voidinitializeJavaScriptAttributes()Deprecated.For JavaScript, certain properties are required to be added to the HTML tags to generate for its integration with the code generated for the feature to work in DHTML environments.voidinitializeTransform(Transformable data)Deprecated.This method initialize the private and protected fields of the transform.voidrenderContentsBody(MarkupOutput out)Deprecated.This is the entry point for the Tranform, and generates the body of the Tab.voidrenderGraphFormatSection(MarkupOutput out)Deprecated.this section has been moved toTabDocumentExportTransform.voidrenderHorizontalFitSection(MarkupOutput out)Deprecated.this section has been moved to the Page Setup tabTabPageSetupTransform.voidrenderJavascriptLinks(MarkupOutput out)Deprecated.Used to dynamically include links to js files.voidrenderPDFSection(MarkupOutput out)Deprecated.this section has been moved toTabDocumentExportTransform.- 
Methods inherited from class com.microstrategy.web.app.transforms.AbstractTabTransform
addJSValidationInfo, AddJSValidationInfo, addPicker, getArgumentName, getAttributesBody, getAttributesFrame, getDropDownTag, getFieldSetTag, getLabelTag, getPickerId, getTabBean, getTabManagerBean, isCurrentTab, isIFrameEnabled, renderColorDropdown, renderContents, renderDropdown, renderFlashWarning, renderPickers, renderSingleOption, renderSingleOption, renderTabFrame, renderTabSectionTitle, transformForRequestSuccessful 
- 
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, 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, initializeImages, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newContext, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, renderBean, renderBean, renderBean, renderBean, renderCancelButton, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderImage, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderRegisterBone, renderSelf, renderShell, renderSubBlock, renderUserHelpAnchor, setBoneProperties, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, transformForRequestInError, transformForRequestNotInited, transformForRequestProcessing, transformForRequestWaitingForUserInput 
- 
Methods inherited from class com.microstrategy.web.transform.AbstractLayoutTransform
getLayoutDefinition, setLayoutDefinition, transformUsingLayout 
- 
Methods inherited from class com.microstrategy.web.transform.AbstractTransform
addFormalParam, canTransform, getEvents, getFormalParams, getPreview, isPreviewAvailable, isResolved, removeFormalParam, setAnnotation, setDeprecated, supports, supports 
- 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait 
- 
Methods inherited from interface com.microstrategy.web.transform.LayoutTransform
getLayoutDefinition, setLayoutDefinition 
- 
Methods inherited from interface com.microstrategy.web.transform.Transform
canTransform, getFormalParams, getID, getPreview, isPreviewAvailable, isResolved, supports, supports, transform 
 - 
 
 - 
 
- 
- 
Method Detail
- 
renderContentsBody
public void renderContentsBody(MarkupOutput out)
Deprecated.This is the entry point for the Tranform, and generates the body of the Tab.
If a layout-xml is specified, this method will delegate the output generation to the Layout parser, otherwise it calls
renderHorizontalFitSection,renderGraphFormatSectionandrenderPDFSection.- Specified by:
 renderContentsBodyin classAbstractTabTransform- Parameters:
 out-MarkupOutputinstance where the HTML contents to render will be saved.
 
- 
renderHorizontalFitSection
public void renderHorizontalFitSection(MarkupOutput out)
Deprecated.this section has been moved to the Page Setup tabTabPageSetupTransform.Generates the HTML output for the horizontal fit section on this tab instance.- Parameters:
 out-MarkupOutputinstance where the HTML contents to render will be saved.
 
- 
renderGraphFormatSection
public void renderGraphFormatSection(MarkupOutput out)
Deprecated.this section has been moved toTabDocumentExportTransform.Generates the HTML output for the horizontal fit section on this tab instance.- Parameters:
 out-MarkupOutputinstance where the HTML contents to render will be saved.
 
- 
renderPDFSection
public void renderPDFSection(MarkupOutput out)
Deprecated.this section has been moved toTabDocumentExportTransform.Generates the HTML output for the horizontal fit section on this tab instance.- Parameters:
 out-MarkupOutputinstance where the HTML contents to render will be saved.
 
- 
renderJavascriptLinks
public void renderJavascriptLinks(MarkupOutput out)
Deprecated.Description copied from class:AbstractTabTransformUsed to dynamically include links to js files. Extend with the list of files your transform requires.- Overrides:
 renderJavascriptLinksin classAbstractTabTransform- Parameters:
 out-MarkupOutputinstance where the HTML contents to render will be saved.
 
- 
getSupportedBeanType
public java.lang.Class getSupportedBeanType()
Deprecated.Returns the supported bean type. This transform supports any of theTabBeaninstances- Specified by:
 getSupportedBeanTypein interfaceTransform- Overrides:
 getSupportedBeanTypein classAbstractTabTransform- Returns:
 - the class of the bean supported by this transform.
 
 
- 
getDescription
public java.lang.String getDescription()
Deprecated.Returns the textual description of the transform- Specified by:
 getDescriptionin interfaceTransform- Overrides:
 getDescriptionin classAbstractTabTransform- Returns:
 - the description of the transform
 
 
- 
initializeCss
public void initializeCss()
Deprecated.Initializes the Css Classes to use. For each one of the css classes to use, the prefix indicated on the formal parameter is added to the name of the class to use.- Overrides:
 initializeCssin classAbstractTabTransform
 
- 
initializeJavaScriptAttributes
public void initializeJavaScriptAttributes()
Deprecated.For JavaScript, certain properties are required to be added to the HTML tags to generate for its integration with the code generated for the feature to work in DHTML environments. This method assigns values to these attributes, so they can be displayed together with the tags they represent. If a value is set to be null, it won't be included on the HTML tag definition. By default, it includes the definition of values for properties such asstyFrame,tyFrameandscriptClassFrame.- Overrides:
 initializeJavaScriptAttributesin classAbstractTabTransform
 
- 
initializeTransform
public void initializeTransform(Transformable data)
Deprecated.Description copied from class:AbstractTabTransformThis method initialize the private and protected fields of the transform. In particular it invokes theinitializeJavaScriptAttribute()method.- Specified by:
 initializeTransformin interfaceAppTransform- Overrides:
 initializeTransformin classAbstractTabTransform- Parameters:
 data-Transformableinstance to be transformed.
 
 - 
 
 -