Class FormatEditorTabManagerTransform
- java.lang.Object
-
- com.microstrategy.web.transform.AbstractTransform
-
- com.microstrategy.web.transform.AbstractLayoutTransform
-
- com.microstrategy.web.app.transforms.AbstractAppTransform
-
- com.microstrategy.web.app.transforms.AbstractEditorTransform
-
- com.microstrategy.web.app.transforms.TabManagerTransform
-
- com.microstrategy.web.app.transforms.FormatEditorTabManagerTransform
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
public class FormatEditorTabManagerTransform extends TabManagerTransform
This transform takes care of renderingFormatTabManagerBean
instances, overwritting the originalTabManagerTransform
implementation by allowing all the available children to render their HTML tab contents, and hiding with css styles and JavaScript all but the one currently selected by the user.- 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.TabManagerTransform
_tabManagerBean, autoSubmitJS, FP_AUTO_SUBMIT_JS, FP_HIDE_UNAVAILABLE, FP_IGNORE_SINGLE_TAB, FP_PRIMARY_BONE, FP_TAB_HEIGHT, hideUnavailable, ignoreSingleTab, primaryBone, tabHeight
-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractEditorTransform
_helpTopic, _helpType, applyJS, applyLabel, applyLabelID, canAutoSize, cancelJS, cancelLabel, cancelLabelID, closeEvent, closeImage, closeJS, closeLabel, closeLabelID, dhtmlClose, disableOKButton, editorContentsStyle, editorElements, editorLayoutFile, editorSubType, FP_APPLY_JS, FP_APPLY_LABEL, FP_APPLY_LABEL_ID, FP_CAN_AUTO_SIZE, FP_CANCEL_JS, FP_CANCEL_LABEL, FP_CANCEL_LABEL_ID, FP_CLOSE_EVENT, FP_CLOSE_IMAGE, FP_CLOSE_JS, FP_CLOSE_LABEL, FP_CLOSE_LABEL_ID, FP_DHTML_CLOSE, FP_DISABLE_OK_BUTTON, FP_EDITOR_CONTENTS_STYLE, FP_EDITOR_ELEMENTS, FP_EDITOR_LAYOUT_FILE, FP_EDITOR_SUBTYPE, FP_HELP_PAGE, FP_HELP_TOPIC, FP_HELP_TYPE, FP_INCLUDE_DYNAMIC_SCRIPT, FP_NAVIGATE_ON_SUBMIT, FP_OK_JS, FP_OK_LABEL, FP_OK_LABEL_ID, FP_RENDER_FORM, FP_TITLE_LABEL, FP_TITLE_LABEL_ID, FP_USE_JS_IN_BONE, helpPage, helpTopic, helpType, includeDynamicScript, navigateOnSubmit, okJS, okLabel, okLabelID, renderForm, titleLabel, titleLabelID
-
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 FormatEditorTabManagerTransform()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getDescription()
Returns the textual description of the transformjava.lang.Class
getSupportedBeanType()
Returns the supported bean type.FormatTabManagerBean
getTabManagerBean()
Get theFormatTabManagerBean
instance being transformedprotected void
initEditor(Editor editor)
Initialize the editor with the global settings.void
initializeTransform(Transformable data)
Initializes transform formal parametersprotected boolean
isAllMetricsSelected()
Utility method for checking if the All Metrics target has been selected.void
renderControlBar(MarkupOutput out)
Renders the tab control HTML for being able to switch from oneTabBean
child tab to another.void
renderGridZones(MarkupOutput out)
Render the drop downs for the grid zone object and zone selector.protected void
renderJavascript(MarkupOutput out)
Generate the JavaScript code required by this editor manager for the proper behavior on the client.void
renderPanelStackZones(MarkupOutput out)
Render the drop downs for the grid zone object and zone selector.-
Methods inherited from class com.microstrategy.web.app.transforms.TabManagerTransform
getCurrentTabName, getTitleForChildTab, initHelp, renderChildrenTabBody, renderCurrentTabBody, renderEditorContents, renderTabContainerBody, renderTabManagerControlBarBody, setAttributesTabSetContainer, setTabSetStyle, transformForRequestSuccessful
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractEditorTransform
generateForm, getDivTagAroundContents, getEditorTitle, getOnSubmitJS, getWebBeanErrorInfo, renderEditor, renderEditorElement, setFocusFieldId, transformForRequestInError
-
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, 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, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, initializeImages, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, 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, 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
-
initializeTransform
public void initializeTransform(Transformable data)
Initializes transform formal parameters- Specified by:
initializeTransform
in interfaceAppTransform
- Overrides:
initializeTransform
in classTabManagerTransform
- Parameters:
data
- the bean being transformed by this class
-
renderControlBar
public void renderControlBar(MarkupOutput out)
Renders the tab control HTML for being able to switch from oneTabBean
child tab to another. Generates an HTML table for holding the differentTabBean
titles of the tabs that are available for thisTabManagerBean
instance. Calls for therenderGridZones(com.microstrategy.web.beans.MarkupOutput)
method in case the editor is targetting a grid.- Overrides:
renderControlBar
in classTabManagerTransform
- Parameters:
out
-MarkupOutput
instance where the HTML to render will be saved
-
isAllMetricsSelected
protected boolean isAllMetricsSelected()
Utility method for checking if the All Metrics target has been selected. If the user requests the "Metrics" field to be formatted it will go in as an axis,position location as if it were a regular template unit. The transform does not handle All Metrics like this since it uses other values, so this method maps these two and determines if All Metrics is actually being selected.- Returns:
- boolean indicating if All Metrics is currently selected by the user as target position for the editor.
-
renderGridZones
public void renderGridZones(MarkupOutput out)
Render the drop downs for the grid zone object and zone selector.- Parameters:
out
-MarkupOutput
instance where the HTML to render will be saved
-
renderPanelStackZones
public void renderPanelStackZones(MarkupOutput out)
Render the drop downs for the grid zone object and zone selector.- Parameters:
out
-MarkupOutput
instance where the HTML to render will be saved- Since:
- MicroStrategy Web 8.1.0
-
initEditor
protected void initEditor(Editor editor)
Initialize the editor with the global settings. Extends the parent method by indicating a special Apply label in case the editor is targetting a grid.- Overrides:
initEditor
in classAbstractEditorTransform
- Parameters:
editor
-Editor
instance to initialize according to the information to be displayed by this transform
-
renderJavascript
protected void renderJavascript(MarkupOutput out)
Generate the JavaScript code required by this editor manager for the proper behavior on the client. Extends the parent method by adding extra property values needed for handling the current selected target if a grid is selected for formatting.- Overrides:
renderJavascript
in classTabManagerTransform
- Parameters:
out
-MarkupOutput
instance where the HTML output will be saved.
-
getTabManagerBean
public FormatTabManagerBean getTabManagerBean()
Get theFormatTabManagerBean
instance being transformed- Returns:
- the current
FormatTabManagerBean
instance being transformed
-
getSupportedBeanType
public java.lang.Class getSupportedBeanType()
Returns the supported bean type. This transform supportsFormatTabManagerBean
instances- Specified by:
getSupportedBeanType
in interfaceTransform
- Overrides:
getSupportedBeanType
in classTabManagerTransform
- Returns:
- the class of the bean supported by this transform.
-
getDescription
public java.lang.String getDescription()
Returns the textual description of the transform- Specified by:
getDescription
in interfaceTransform
- Overrides:
getDescription
in classTabManagerTransform
- Returns:
- the description of the transform
-
-