Class TabManagerTransform
- 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
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
- Direct Known Subclasses:
AccordionTabManagerTransform
,DerivedElementFormatEditorTransform
,FormatEditorTabManagerTransform
,HelpOnCBTabManagerTransform
,ObjectBrowserManagerTransform
,SubtotalsEditorTabManagerTransform
,ThresholdsFormatEditorTransform
,TreeTabManagerTransform
public class TabManagerTransform extends AbstractEditorTransform implements LayoutTransform
This transform can be used as base for the transforms that will take care of renderingTabManagerBean
instances. It considers the final output to be divided in these sections:TabManagerFrame / TabManagerFrameBody ------------------------------------- | Title / TitleBody | ------------------------------------- | ControlBar / ControlBarBody | |-----------------------------------| | Contents / ContentsBody | | | | | | | | | -------------------------------------
Therefore, there will exist the following methods for defining each one of the HTML contents of the sections:renderTabManagerFrame - renderTabManagerFrameBody + renderTabManagerTitle = renderTabManagerTitleBody + renderTabManagerContents = renderTabManagerContentsBody > renderTabManagerControlBar * renderTabManagerControlBarBody > renderTabManagerTabContainer * renderTabManagerTabContainerBody
The methods likerenderTabManagerFrame
,renderContents
, etc take care of generating the HTML that will serve as a container or frame of the body of these different sections (for keeping formatting on the contents to display) then, they call their respectiveBody
methods for obtaining the HTML that will be the most visible to the user.
These methods can be customized in children transforms or with formal parameters for achieving the desired results.- 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 Modifier and Type Field Description protected TabManagerBean
_tabManagerBean
FormalParameter
autoSubmitJS
Indicates the script to invoke when editor need to submit changes automatically.static java.lang.String
FP_AUTO_SUBMIT_JS
Constant specifying the script to invoke when editor need to submit changes automatically.static java.lang.String
FP_HIDE_UNAVAILABLE
Used by formal parameter hideUnavailable.static java.lang.String
FP_IGNORE_SINGLE_TAB
constant specifying the name of the render single tab property.static java.lang.String
FP_PRIMARY_BONE
Constant specifying the name of the primpary bone property.static java.lang.String
FP_TAB_HEIGHT
Constant specifying the name of the formal parameter for specifying the height of the tabs on the editorFormalParameter
hideUnavailable
Determine whether not available tabs should be hidden.FormalParameter
ignoreSingleTab
Indicates whether to render a single tab or notFormalParameter
primaryBone
Inidicates wehther the eidtor is going to be primary bone or notFormalParameter
tabHeight
Indicates the height of the tabs on the editor.-
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 TabManagerTransform()
Default no-argument constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.lang.String
getCurrentTabName()
Obtains the Id/Name of the tab currently selectedjava.lang.String
getDescription()
Returns the textual description of the transformjava.lang.Class
getSupportedBeanType()
Returns the supported bean type.protected java.lang.String
getTitleForChildTab(TabBean bean)
Obtain the title to use for the given child TabBean, based on its titleId or titleDescription propertiesprotected void
initHelp(Editor editor)
void
initializeTransform(Transformable data)
Initializes transform formal parametersvoid
renderChildrenTabBody(MarkupOutput out)
Renders each of theTabBeans
that are part of theTabManagerBean
.void
renderControlBar(MarkupOutput out)
Renders the tab control HTML for being able to switch from oneTabBean
child tab to another.void
renderCurrentTabBody(MarkupOutput out)
void
renderEditorContents(MarkupOutput out)
Transforms the assosciatedTabManagerBean
when its status isEnumRequestStatus.WebBeanRequestSuccessful
.protected void
renderJavascript(MarkupOutput out)
Generate the JavaScript code required by this editor manager for the proper behavior on the client.void
renderTabContainerBody(MarkupOutput out)
Generates the HTML that represents the body of theTabManagerBean
instance being rendered, consisting on all the current availableTabBean
instances.void
renderTabManagerControlBarBody(MarkupOutput out)
Generates a table row with individual cells corresponding to each one of theTabBean
child tab titles that are available to the user.protected void
setAttributesTabSetContainer(Tag tabSetContainer)
protected void
setTabSetStyle(Tag tabSetContainer)
void
transformForRequestSuccessful(MarkupOutput out)
Generates the graphical output for the Projects Bean-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractEditorTransform
generateForm, getDivTagAroundContents, getEditorTitle, getOnSubmitJS, getWebBeanErrorInfo, initEditor, 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
-
-
-
-
Field Detail
-
tabHeight
public FormalParameter tabHeight
Indicates the height of the tabs on the editor.
-
autoSubmitJS
public FormalParameter autoSubmitJS
Indicates the script to invoke when editor need to submit changes automatically.- Since:
- MicroStrategy Web 9.0.0
-
primaryBone
public FormalParameter primaryBone
Inidicates wehther the eidtor is going to be primary bone or not- Since:
- MicroStrategy Web 9.0.0
-
ignoreSingleTab
public FormalParameter ignoreSingleTab
Indicates whether to render a single tab or not- Since:
- MicroStrategy Web 9.0.0
-
hideUnavailable
public FormalParameter hideUnavailable
Determine whether not available tabs should be hidden. Default to false.- Since:
- MicroStrategy Web 9.0.0
-
FP_TAB_HEIGHT
public static final java.lang.String FP_TAB_HEIGHT
Constant specifying the name of the formal parameter for specifying the height of the tabs on the editor- See Also:
- Constant Field Values
-
FP_AUTO_SUBMIT_JS
public static final java.lang.String FP_AUTO_SUBMIT_JS
Constant specifying the script to invoke when editor need to submit changes automatically.- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
FP_PRIMARY_BONE
public static final java.lang.String FP_PRIMARY_BONE
Constant specifying the name of the primpary bone property.- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
FP_IGNORE_SINGLE_TAB
public static final java.lang.String FP_IGNORE_SINGLE_TAB
constant specifying the name of the render single tab property.- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
FP_HIDE_UNAVAILABLE
public static final java.lang.String FP_HIDE_UNAVAILABLE
Used by formal parameter hideUnavailable.- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
_tabManagerBean
protected TabManagerBean _tabManagerBean
-
-
Method Detail
-
initializeTransform
public void initializeTransform(Transformable data)
Initializes transform formal parameters- Specified by:
initializeTransform
in interfaceAppTransform
- Overrides:
initializeTransform
in classAbstractEditorTransform
- Parameters:
data
- the bean being transformed by this class
-
renderEditorContents
public void renderEditorContents(MarkupOutput out)
Transforms the assosciatedTabManagerBean
when its status isEnumRequestStatus.WebBeanRequestSuccessful
. CallsrenderTabManagerFrame()
- Specified by:
renderEditorContents
in classAbstractEditorTransform
- Parameters:
out
-MarkupOutput
instance where to create the HTML output
-
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 as well as the required library for it to work properly.- Overrides:
renderJavascript
in classAbstractEditorTransform
- Parameters:
out
-MarkupOutput
instance where the HTML output will be saved.
-
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. CallsrenderTabManagerControlBarBody
- Parameters:
out
-MarkupOutput
instance where the HTML to render will be saved
-
renderTabManagerControlBarBody
public void renderTabManagerControlBarBody(MarkupOutput out)
Generates a table row with individual cells corresponding to each one of theTabBean
child tab titles that are available to the user.- Parameters:
out
-MarkupOutput
instance where the HTML to render will be saved
-
renderTabContainerBody
public void renderTabContainerBody(MarkupOutput out)
Generates the HTML that represents the body of theTabManagerBean
instance being rendered, consisting on all the current availableTabBean
instances. HTML contents of the individualTabBean
instances will then be hidden with css styles and JavaScript, for only showing one at the time (the currently selected by the user).- Parameters:
out
-MarkupOutput
instance where the HTML to render will be saved
-
renderChildrenTabBody
public void renderChildrenTabBody(MarkupOutput out)
Renders each of theTabBeans
that are part of theTabManagerBean
. Loops through the list of child TabBeans and renders their output.- Parameters:
out
-MarkupOutput
-
renderCurrentTabBody
public void renderCurrentTabBody(MarkupOutput out)
- Since:
- MicroStrategy Web 9.0.0
-
getSupportedBeanType
public java.lang.Class getSupportedBeanType()
Returns the supported bean type. This transform supportsTabManagerBean
instances- Specified by:
getSupportedBeanType
in interfaceTransform
- Overrides:
getSupportedBeanType
in classAbstractAppTransform
- 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
- Returns:
- the description of the transform
-
transformForRequestSuccessful
public void transformForRequestSuccessful(MarkupOutput out)
Generates the graphical output for the Projects Bean- Overrides:
transformForRequestSuccessful
in classAbstractEditorTransform
- Parameters:
out
-MarkupOutput
instance where to create the HTML output- Since:
- MicroStrategy Web 9.0.0
- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
getTitleForChildTab
protected java.lang.String getTitleForChildTab(TabBean bean)
Obtain the title to use for the given child TabBean, based on its titleId or titleDescription properties
-
getCurrentTabName
protected java.lang.String getCurrentTabName()
Obtains the Id/Name of the tab currently selected- Returns:
- null if not found...
-
initHelp
protected void initHelp(Editor editor)
- Overrides:
initHelp
in classAbstractEditorTransform
- Since:
- MicroStrategy Web 9.0.0
-
setTabSetStyle
protected void setTabSetStyle(Tag tabSetContainer)
- Since:
- MicroStrategy Web 9.0.0
-
setAttributesTabSetContainer
protected void setAttributesTabSetContainer(Tag tabSetContainer)
- Since:
- MicroStrategy Web 9.0.0
-
-