Class TabPropertiesGridTransform
- 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.TabPropertiesGridTransform
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
public class TabPropertiesGridTransform extends AbstractTabTransform implements LayoutTransform
This class transforms a
TabBean
allowing users to view/modify properties of a grid (like header options, shows thresholds, etc). As with other TabTransforms, this one assumes itsTabManagerBean
will take care of rendering the required HTML & Javascript allowing users to switch between different formattingTabBean
instances.The output of this transform is divided into two sections:
- Headers Section
- View Section
Each one of these sections has its ownrender
method. 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 ------------------------------------- | | | Headers Section | | | ------------------------------------- | | | View 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 TabPropertiesGridTransform()
Default constructor.
-
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.void
initializeCss()
Initializes the Css Classes to use.void
initializeJavaScriptAttributes()
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
initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.void
renderAttributeFormsOption(MarkupOutput out)
Generates the HTML output for Show Attribute Forms option.void
renderBandingOption(MarkupOutput out)
Generates the HTML output for Show Banding option.void
renderColumnOptions(MarkupOutput out)
Generates the HTML output for the column headers section options.void
renderContentsBody(MarkupOutput out)
Generates the HTML output for the Generic section on this properties tab instance.void
renderDrillSection(MarkupOutput out)
Generates the HTML output for the Drill section on this properties tab instance.void
renderExecutionFullScreenMode(MarkupOutput out)
void
renderHeadersSection(MarkupOutput out)
Generates the HTML output for the Headers section on this properties tab instance.void
renderHideNullsOption(MarkupOutput out)
void
renderIncrementalFetchSection(MarkupOutput out)
void
renderJavascriptLinks(MarkupOutput out)
Used to dynamically include links to js files.void
renderOutlineOption(MarkupOutput out)
Generates the HTML output for Show Outline mode option.void
renderRowOptions(MarkupOutput out)
Generates the HTML output for the row headers section options.void
renderThresholdsOption(MarkupOutput out)
Generates the HTML output for Show Thresholds option.void
renderTitleOverlapOption(MarkupOutput out)
Generates the HTML output for Title Overlap option.void
renderViewSection(MarkupOutput out)
Generates the HTML output for the View section on this properties tab instance.-
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
-
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 theinitializeJavaScriptAttribute()
method.- Specified by:
initializeTransform
in interfaceAppTransform
- Overrides:
initializeTransform
in classAbstractTabTransform
- Parameters:
data
-Transformable
instance to be transformed.
-
renderContentsBody
public void renderContentsBody(MarkupOutput out)
Generates the HTML output for the Generic section on this properties tab instance. CallsrenderHeadersSection()
andrenderViewSection()
.- Specified by:
renderContentsBody
in classAbstractTabTransform
- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderDrillSection
public void renderDrillSection(MarkupOutput out)
Generates the HTML output for the Drill section on this properties tab instance.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.- Since:
- MicroStrategy Web 9.0.0
-
renderIncrementalFetchSection
public void renderIncrementalFetchSection(MarkupOutput out)
-
renderExecutionFullScreenMode
public void renderExecutionFullScreenMode(MarkupOutput out)
- Since:
- MicroStrategy Web 8.1.0
-
renderViewSection
public void renderViewSection(MarkupOutput out)
Generates the HTML output for the View section on this properties tab instance.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderThresholdsOption
public void renderThresholdsOption(MarkupOutput out)
Generates the HTML output for Show Thresholds option.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderAttributeFormsOption
public void renderAttributeFormsOption(MarkupOutput out)
Generates the HTML output for Show Attribute Forms option.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderBandingOption
public void renderBandingOption(MarkupOutput out)
Generates the HTML output for Show Banding option.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderOutlineOption
public void renderOutlineOption(MarkupOutput out)
Generates the HTML output for Show Outline mode option.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderTitleOverlapOption
public void renderTitleOverlapOption(MarkupOutput out)
Generates the HTML output for Title Overlap option.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.- Since:
- MicroStrategy Web 9.0.0
-
renderHeadersSection
public void renderHeadersSection(MarkupOutput out)
Generates the HTML output for the Headers section on this properties tab instance.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderRowOptions
public void renderRowOptions(MarkupOutput out)
Generates the HTML output for the row headers section options.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderColumnOptions
public void renderColumnOptions(MarkupOutput out)
Generates the HTML output for the column headers section options.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderHideNullsOption
public void renderHideNullsOption(MarkupOutput out)
-
renderJavascriptLinks
public void renderJavascriptLinks(MarkupOutput out)
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 classAbstractTabTransform
- 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()
Returns the supported bean type. This transform supports aTabBean
instance- Specified by:
getSupportedBeanType
in interfaceTransform
- Overrides:
getSupportedBeanType
in classAbstractTabTransform
- 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 classAbstractTabTransform
- Returns:
- the description of the transform
-
initializeCss
public void initializeCss()
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 classAbstractTabTransform
-
initializeJavaScriptAttributes
public void initializeJavaScriptAttributes()
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
,tyFrame
andscriptClassFrame
.- Overrides:
initializeJavaScriptAttributes
in classAbstractTabTransform
-
-