Class TabPropertiesLayoutTransform
- 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.TabPropertiesLayoutTransform
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
public class TabPropertiesLayoutTransform extends AbstractTabTransform implements LayoutTransform
Title: TabPropertiesLayoutTransform.
This class transforms a
TabBean
allowing users to view/modify the layout of a control (for example, position, size, visibility). 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 the following sections:
- Visible
- PageBreak
- Position Section
- Size Section
Each one Each one of these sections has its ownrender
method. Furthermore each section generates individual settings which might be divided into 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 changes depending on the selection. By default is as:
Contents / ContentsBody ------------------------------------- | | | Position Section | | | ------------------------------------- | | | Size Section | | | -------------------------------------
For sub-sections we have:Contents / ContentsBody ------------------------------------- | | | SubSection Size Section | | | ------------------------------------- | | | PageBreak Section | | | -------------------------------------
And for grids, the default layout is:Contents / ContentsBody ------------------------------------- | | | Position Section | | | ------------------------------------- | | | Size Section | | | ------------------------------------- | | | Grid 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 TabPropertiesLayoutTransform()
-
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.protected TabBean
getTabBean()
Returns the TabBean for this tab.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.boolean
isControl()
boolean
isCrossTab()
Returns true if the selection in the report-writing document whose properties are being edited is a template or a cross-tab unitEnumRWUnitTypes.RWUNIT_GRIDGRAPH
)boolean
isSubSection()
Returns true if the selection in the report-writing document whose properties are being edited is a subsection or not (of type EnumRWUnitTypes.RWUNIT_SUBSECTION)void
renderContentsBody(MarkupOutput out)
This is the entry point for the Tranform, and generates the body of the Tab.void
renderDataSourceOptions(MarkupOutput out)
If the targetBean of theTabBean
is a RWBean, it renders a comboBox that allows users the change the dataset for the current control.void
renderGridSection(MarkupOutput out)
Generates the HTML output for the Grid section on this properties tab instance.void
renderGridSectionDetails(MarkupOutput out)
Generates the HTML output for the grid section details in the Grid section on this properties tab instance.void
renderItemSection(MarkupOutput out)
void
renderJavascriptLinks(MarkupOutput out)
Used to dynamically include links to js files.void
renderLeftAndTopSection(MarkupOutput out)
Generates the HTML output for the Left and Top section in the Position section on this properties tab instance.void
renderLengthSection(MarkupOutput out)
Generates the HTML output for the Length section in the Size section on this properties tab instance.void
renderPageBreakSection(MarkupOutput out)
Generates the HTML output for the Page Break section on this properties tab instance.void
renderPositionSection(MarkupOutput out)
Generates the HTML output for the Position section on this properties tab instance.void
renderResizeSection(MarkupOutput out)
Generates the HTML output for the resize section of the object in the size section on this properties tab instance.void
renderSizeSection(MarkupOutput out)
Generates the HTML output for the Size section on this properties tab instance.void
renderSubSectionSizeSection(MarkupOutput out)
Generates the HTML output for the Size section on this properties tab instance.void
renderTitleHeightSection(MarkupOutput out)
void
renderWidthandHeightSection(MarkupOutput out)
Generates the HTML output for the Width and Height section in the Size 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, 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
-
renderContentsBody
public void renderContentsBody(MarkupOutput out)
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
renderSubSectionSizeSection()
,renderPageBreakSection()
,renderGridSection()
,renderPositionSection()
,renderResizeSection()
and/orrenderSizeSection()
based on what object the user is trying to set properties to.- Specified by:
renderContentsBody
in classAbstractTabTransform
- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderGridSection
public void renderGridSection(MarkupOutput out)
Generates the HTML output for the Grid section on this properties tab instance.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderItemSection
public void renderItemSection(MarkupOutput out)
- Since:
- MicroStrategy Web 8.1.0
-
renderPositionSection
public void renderPositionSection(MarkupOutput out)
Generates the HTML output for the Position section on this properties tab instance. CallsrenderPositionSectionTitle()
,renderLeftAndTopSection
.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderGridSectionDetails
public void renderGridSectionDetails(MarkupOutput out)
Generates the HTML output for the grid section details in the Grid section on this properties tab instance.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderLeftAndTopSection
public void renderLeftAndTopSection(MarkupOutput out)
Generates the HTML output for the Left and Top section in the Position section on this properties tab instance.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderSizeSection
public void renderSizeSection(MarkupOutput out)
Generates the HTML output for the Size section on this properties tab instance. CallsrenderSizeSectionTitle()
,renderWidthandHeightSection
- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderWidthandHeightSection
public void renderWidthandHeightSection(MarkupOutput out)
Generates the HTML output for the Width and Height section in the Size section on this properties tab instance.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderTitleHeightSection
public void renderTitleHeightSection(MarkupOutput out)
- Since:
- MicroStrategy Web 8.1.0
-
renderLengthSection
public void renderLengthSection(MarkupOutput out)
Generates the HTML output for the Length section in the Size section on this properties tab instance.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderResizeSection
public void renderResizeSection(MarkupOutput out)
Generates the HTML output for the resize section of the object in the size section on this properties tab instance.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderSubSectionSizeSection
public void renderSubSectionSizeSection(MarkupOutput out)
Generates the HTML output for the Size section on this properties tab instance.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderPageBreakSection
public void renderPageBreakSection(MarkupOutput out)
Generates the HTML output for the Page Break section on this properties tab instance.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderDataSourceOptions
public void renderDataSourceOptions(MarkupOutput out)
If the targetBean of theTabBean
is a RWBean, it renders a comboBox that allows users the change the dataset for the current control.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
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 any of theTabBean
instances- 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
-
initializeTransform
public void initializeTransform(Transformable data)
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.
-
getTabBean
protected TabBean getTabBean()
Description copied from class:AbstractTabTransform
Returns the TabBean for this tab.- Overrides:
getTabBean
in classAbstractTabTransform
- Returns:
- TabBean for this tab.
-
isSubSection
public boolean isSubSection()
Returns true if the selection in the report-writing document whose properties are being edited is a subsection or not (of type EnumRWUnitTypes.RWUNIT_SUBSECTION)- Returns:
- true if the selection is a subsection
-
isCrossTab
public boolean isCrossTab()
Returns true if the selection in the report-writing document whose properties are being edited is a template or a cross-tab unitEnumRWUnitTypes.RWUNIT_GRIDGRAPH
)- Returns:
- true if the selection is a template or a cross-tab unit.
-
isControl
public boolean isControl()
- Since:
- MicroStrategy Web 8.1.0
-
-