Package com.microstrategy.web.app.transforms

Class TabDocumentAdvancedTransform

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.TabDocumentAdvancedTransform

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

public class TabDocumentAdvancedTransform
extends AbstractTabTransform
implements LayoutTransform

Deprecated.

- Since we now use the JUIL architecture, these transforms are no longer being used.

This class transforms a TabBean allowing users to view/modify advanced properties of a document. As with other TabTransforms, this one assumes its TabManagerBean will take care of rendering the required HTML & Javascript allowing users to switch between different formatting TabBean instances.

This Transform implements LayoutTransform, 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 changes depending on the selection. By default is as:

     Contents / ContentsBody
     -------------------------------------
     |                                   |
     |  Data Section                     |
     |                                   |
     -------------------------------------
 

Since:

MicroStrategy Web 9.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
TabDocumentAdvancedTransform()	Deprecated.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescription()	Deprecated. Returns the textual description of the transform
java.lang.Class	getSupportedBeanType()	Deprecated. Returns the supported bean type.
void	initializeCss()	Deprecated. Initializes the Css Classes to use.
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.
void	renderContentsBody(MarkupOutput out)	Deprecated. This is the entry point for the Tranform, and generates the body of the Tab.
void	renderDataSection(MarkupOutput out)	Deprecated. Renders the Data section
void	renderJavascriptLinks(MarkupOutput out)	Deprecated. Used to dynamically include links to js files.
void	renderRemoveNullGroups(MarkupOutput out)	Deprecated. Renders the input for removing groups that contain null elements.
void	renderTrimNoSectionData(MarkupOutput out)	Deprecated. Renders the input for trimming sections that contain no data

Methods inherited from class com.microstrategy.web.app.transforms.AbstractTabTransform

addJSValidationInfo, AddJSValidationInfo, addPicker, getArgumentName, getAttributesBody, getAttributesFrame, getDropDownTag, getFieldSetTag, getLabelTag, getPickerId, getTabBean, getTabManagerBean, initializeTransform, 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

Constructor Detail

TabDocumentAdvancedTransform

public TabDocumentAdvancedTransform()

Deprecated.

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 renderDataSection().

Specified by:

renderContentsBody in class AbstractTabTransform

Parameters:

out - MarkupOutput instance where the HTML contents to render will be saved.

renderDataSection

public void renderDataSection(MarkupOutput out)

Deprecated.

Renders the Data section

Parameters:

out - MarkupOutput

renderRemoveNullGroups

public void renderRemoveNullGroups(MarkupOutput out)

Deprecated.

Renders the input for removing groups that contain null elements.

Parameters:

out - MarkupOutput

renderTrimNoSectionData

public void renderTrimNoSectionData(MarkupOutput out)

Deprecated.

Renders the input for trimming sections that contain no data

Parameters:

out - MarkupOutput

renderJavascriptLinks

public void renderJavascriptLinks(MarkupOutput out)

Deprecated.

Description copied from class: AbstractTabTransform

Used to dynamically include links to js files. Extend with the list of files your transform requires.

Overrides:

renderJavascriptLinks in class AbstractTabTransform

Parameters:

out - MarkupOutput instance where the HTML contents to render will be saved.

See Also:

AbstractTabTransform.renderJavascriptLinks(com.microstrategy.web.beans.MarkupOutput)

getSupportedBeanType

public java.lang.Class getSupportedBeanType()

Deprecated.

Description copied from class: AbstractTabTransform

Returns the supported bean type. This transform supports any of the TabBean instances

Specified by:

getSupportedBeanType in interface Transform

Overrides:

getSupportedBeanType in class AbstractTabTransform

Returns:

the class of the bean supported by this transform.

See Also:

Transform.getSupportedBeanType()

getDescription

public java.lang.String getDescription()

Deprecated.

Description copied from class: AbstractTabTransform

Returns the textual description of the transform

Specified by:

getDescription in interface Transform

Overrides:

getDescription in class AbstractTabTransform

Returns:

the description of the transform

See Also:

Transform.getDescription()

initializeCss

public void initializeCss()

Deprecated.

Description copied from class: AbstractTabTransform

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:

initializeCss in class AbstractTabTransform

See Also:

AbstractAppTransform.initializeCss()

initializeJavaScriptAttributes

public void initializeJavaScriptAttributes()

Deprecated.

Description copied from class: AbstractTabTransform

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 as styFrame, tyFrame and scriptClassFrame.

Overrides:

initializeJavaScriptAttributes in class AbstractTabTransform

See Also:

AbstractTabTransform.initializeJavaScriptAttributes()