Class FormatTabAlignmentTransform
- 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.AbstractFormatTabTransform
-
- com.microstrategy.web.app.transforms.FormatTabAlignmentTransform
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
public class FormatTabAlignmentTransform extends AbstractFormatTabTransform implements LayoutTransform
This class transforms a
FormatTabBean
allowing users to modify the corresponding alignment properties of a control. 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 main sections:
- Text Alignment
- Text Control
Each one of these sections has its ownrender
method. Furthermore each section generates individual settings which are 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 is divided as follows:
ContentsBody ------------------------------------- | TextAlignmentSection | | - HorizontalAlignmentSection | | - VerticalAlignmentSection | | | | | ------------------------------------- | TextControlSection | | - TextControlWordWrapSection | | - TextControlVerticalTextSection| ------------------------------------- | PaddingSection | | - TextPaddingSection | -------------------------------------
- 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.AbstractFormatTabTransform
formatTarget, FP_FORMAT_TARGET
-
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 FormatTabAlignmentTransform()
Default no-argument constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getDescription()
Returns the textual description of the transformprotected FormatTabBean
getFormatTabBean()
Obtain theFormatTabBean
instance currently being transformed.java.lang.Class
getSupportedBeanType()
Returns the supported bean type.void
initializeCss()
Initializes the Css classes to use.void
initializeImages()
Initializes the name of the images to use on this transform's output.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
initializeWebComponent(Transformable data)
Initialize the web component to be used by the transform.void
renderBottomPaddingSection(MarkupOutput out)
Displays the interface for allowing the user to modify the bottom padding setting on the currently selected target object(s).void
renderContentsBody(MarkupOutput out)
This is the entry point for the Tranform, and generates the body of the Tab.void
renderHorizontalAlignmentSection(MarkupOutput out)
Generates the HTML that allows the user to modify the horizontal alignment setting.void
renderJavascriptLinks(MarkupOutput out)
Extends the parent method by adding the JavaScript file this transform needs for its correct behavior on the client side.void
renderLeftPaddingSection(MarkupOutput out)
Displays the interface for allowing the user to modify the left padding setting on the currently selected target object(s).void
renderPaddingSection(MarkupOutput out)
Generates the HTML output for the Padding section on this format tab instance.void
renderRightPaddingSection(MarkupOutput out)
Displays the interface for allowing the user to modify the right padding setting on the currently selected target object(s).void
renderTextAlignmentSection(MarkupOutput out)
Generates the HTML output for the Text Alignment section.void
renderTextControlSection(MarkupOutput out)
Generates the HTML output for the Text Control section on this format tab instance.void
renderTextControlVerticalTextSection(MarkupOutput out)
Generates the HTML that allows the user to modify the vertical text setting.void
renderTextControlWordWrapSection(MarkupOutput out)
Generates the HTML that allows the user to modify the word wrap setting.void
renderTopPaddingSection(MarkupOutput out)
Displays the interface for allowing the user to modify the top padding setting on the currently selected target object(s).void
renderVerticalAlignmentSection(MarkupOutput out)
Generates the HTML that allows the user to modify the vertical alignment setting .-
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, 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
renderTextAlignmentSection(com.microstrategy.web.beans.MarkupOutput)
andrenderTextControlSection(com.microstrategy.web.beans.MarkupOutput)
.- Specified by:
renderContentsBody
in classAbstractTabTransform
- Parameters:
out
-MarkupOutput
instance where the HTML contents gets generated.
-
renderTextAlignmentSection
public void renderTextAlignmentSection(MarkupOutput out)
Generates the HTML output for the Text Alignment section.
It calls
AbstractTabTransform.renderTabSectionTitle(com.microstrategy.web.beans.MarkupOutput, java.lang.String)
,renderHorizontalAlignmentSection(com.microstrategy.web.beans.MarkupOutput)
and if it's a crossTab objectrenderVerticalAlignmentSection(com.microstrategy.web.beans.MarkupOutput)
.- Parameters:
out
-MarkupOutput
instance where the HTML contents gets generated.
-
renderHorizontalAlignmentSection
public void renderHorizontalAlignmentSection(MarkupOutput out)
Generates the HTML that allows the user to modify the horizontal alignment setting.- Parameters:
out
-MarkupOutput
instance where the HTML contents gets generated.
-
renderVerticalAlignmentSection
public void renderVerticalAlignmentSection(MarkupOutput out)
Generates the HTML that allows the user to modify the vertical alignment setting .- Parameters:
out
-MarkupOutput
instance where the HTML contents gets generated.
-
renderPaddingSection
public void renderPaddingSection(MarkupOutput out)
Generates the HTML output for the Padding section on this format tab instance. CallsrenderTabSectionTitle()
,renderLeftPaddingSection()
,renderRightPaddingSection()
,renderTopPaddingSection()
andrenderBottomPaddingSection()
.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.- Since:
- MicroStrategy Web 9.0.0
-
renderLeftPaddingSection
public void renderLeftPaddingSection(MarkupOutput out)
Displays the interface for allowing the user to modify the left padding setting on the currently selected target object(s).- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.- Since:
- MicroStrategy Web 9.0.0
-
renderRightPaddingSection
public void renderRightPaddingSection(MarkupOutput out)
Displays the interface for allowing the user to modify the right padding setting on the currently selected target object(s).- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.- Since:
- MicroStrategy Web 9.0.0
-
renderTopPaddingSection
public void renderTopPaddingSection(MarkupOutput out)
Displays the interface for allowing the user to modify the top padding setting on the currently selected target object(s).- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.- Since:
- MicroStrategy Web 9.0.0
-
renderBottomPaddingSection
public void renderBottomPaddingSection(MarkupOutput out)
Displays the interface for allowing the user to modify the bottom padding setting on the currently selected target object(s).- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.- Since:
- MicroStrategy Web 9.0.0
-
renderTextControlSection
public void renderTextControlSection(MarkupOutput out)
Generates the HTML output for the Text Control section on this format tab instance. CallsrenderTextControlWordWrapSection()
.- Parameters:
out
-MarkupOutput
instance where the HTML contents gets generated.
-
renderTextControlWordWrapSection
public void renderTextControlWordWrapSection(MarkupOutput out)
Generates the HTML that allows the user to modify the word wrap setting.- Parameters:
out
-MarkupOutput
instance where the HTML contents gets generated.
-
renderTextControlVerticalTextSection
public void renderTextControlVerticalTextSection(MarkupOutput out)
Generates the HTML that allows the user to modify the vertical text setting.- Parameters:
out
-MarkupOutput
instance where the HTML contents gets generated.- Since:
- MicroStrategy Web 9.0.0
-
renderJavascriptLinks
public void renderJavascriptLinks(MarkupOutput out)
Extends the parent method by adding the JavaScript file this transform needs for its correct behavior on the client side.- Overrides:
renderJavascriptLinks
in classAbstractTabTransform
- Parameters:
out
-MarkupOutput
instance where the HTML generated 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 theFormatTabBean
instances- Specified by:
getSupportedBeanType
in interfaceTransform
- Overrides:
getSupportedBeanType
in classAbstractTabTransform
- Returns:
FormatTabBean.class
-
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
-
getFormatTabBean
protected FormatTabBean getFormatTabBean()
Obtain theFormatTabBean
instance currently being transformed.- Returns:
- the
FormatTabBean
being transformed.
-
initializeImages
public void initializeImages()
Initializes the name of the images to use on this transform's output. For each one of the images defined to be displayed, the resource folder information is added to its path and file name as specified on the formal parameters for the images.- Overrides:
initializeImages
in classAbstractAppTransform
-
initializeTransform
public void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.- Specified by:
initializeTransform
in interfaceAppTransform
- Overrides:
initializeTransform
in classAbstractTabTransform
- Parameters:
data
-Transformable
instance to be transformed.
-
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
-
initializeWebComponent
public void initializeWebComponent(Transformable data)
Initialize the web component to be used by the transform.- Specified by:
initializeWebComponent
in interfaceAppTransform
- Overrides:
initializeWebComponent
in classAbstractAppTransform
- Parameters:
data
- the bean to transform.- See Also:
AbstractAppTransform.initializeWebComponent(com.microstrategy.web.beans.Transformable)
-
-