Package com.microstrategy.web.app.transforms

Class TabLayoutTransform

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

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

public class TabLayoutTransform
extends AbstractTabTransform
implements LayoutTransform

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

Modifier and Type	Field	Description
FormalParameter	colorPickerName	Indicates the id of a system picker that contains the possible color options for fill colors
static java.lang.String	FP_COLOR_PICKER_NAME	Constant specifying the name of the formal parameter for defining the id of a system picker that contains the possible background/fill color options.

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
TabLayoutTransform()

Method Summary

Modifier and Type	Method	Description
ShortcutList	getColorPicker()	Returns the background color picker.
void	initializeTransform(Transformable data)	This method initialize the private and protected fields of the transform.
void	renderContentsBody(MarkupOutput out)	Method that renders the main contents of the transform, according to the information available on the bean.
protected void	renderMasterPageHeaderFooterSection(MarkupOutput out)	Generates the HTML output for the master page header/footer in the layout editor tab.
protected void	renderNameSection(MarkupOutput out)	Generates the HTML output for the Name of the object in the layout editor tab.
void	renderTabColorSection(MarkupOutput out)	Displays the interface for allowing the user to modify the fill color setting on the currently selected tab.
void	setColorPicker(ShortcutList picker)	Register the color picker for background, i.e.

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

addJSValidationInfo, AddJSValidationInfo, addPicker, getArgumentName, getAttributesBody, getAttributesFrame, getDescription, getDropDownTag, getFieldSetTag, getLabelTag, getPickerId, getSupportedBeanType, getTabBean, getTabManagerBean, initializeCss, initializeJavaScriptAttributes, isCurrentTab, isIFrameEnabled, renderColorDropdown, renderContents, renderDropdown, renderFlashWarning, renderJavascriptLinks, 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, getDescription, getFormalParams, getID, getPreview, getSupportedBeanType, isPreviewAvailable, isResolved, supports, supports, transform

Field Detail

colorPickerName

public FormalParameter colorPickerName

Indicates the id of a system picker that contains the possible color options for fill colors

FP_COLOR_PICKER_NAME

public static final java.lang.String FP_COLOR_PICKER_NAME

Constant specifying the name of the formal parameter for defining the id of a system picker that contains the possible background/fill color options. Value is colorPickerId.

See Also:

Constant Field Values

Constructor Detail

TabLayoutTransform

public TabLayoutTransform()

Method Detail

renderContentsBody

public void renderContentsBody(MarkupOutput out)

Description copied from class: AbstractTabTransform

Method that renders the main contents of the transform, according to the information available on the bean. This method can be customized if users would like to obtain a different output for the same given bean.

Specified by:

renderContentsBody in class AbstractTabTransform

Parameters:

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

renderNameSection

protected void renderNameSection(MarkupOutput out)

Generates the HTML output for the Name of the object in the layout editor tab.

Parameters:

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

renderMasterPageHeaderFooterSection

protected void renderMasterPageHeaderFooterSection(MarkupOutput out)

Generates the HTML output for the master page header/footer in the layout editor tab.

Parameters:

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

renderTabColorSection

public void renderTabColorSection(MarkupOutput out)

Displays the interface for allowing the user to modify the fill color setting on the currently selected tab.

Parameters:

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

getColorPicker

public ShortcutList getColorPicker()

Returns the background color picker. If a non-null instance have been registered through the setColorPicker method, it will return that one, otherwise, it will search for a system picker with the name specified in FP_COLOR_PICKER_NAME.

Returns:

ShortcutList to use for the color-picker.

setColorPicker

public void setColorPicker(ShortcutList picker)

Register the color picker for background, i.e. Fill color This allows the transform to use a ShortcutList that is not defined inside the pageConfig.

Parameters:

picker - The colorPicker to set.

initializeTransform

public void initializeTransform(Transformable data)

Description copied from class: AbstractTabTransform

This method initialize the private and protected fields of the transform. In particular it invokes the initializeJavaScriptAttribute() method.

Specified by:

initializeTransform in interface AppTransform

Overrides:

initializeTransform in class AbstractTabTransform

Parameters:

data - Transformable instance to be transformed.