Class TabPageSetupTransform
- 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.TabPageSetupTransform
-
- All Implemented Interfaces:
AppTransform,LayoutTransform,Transform
public class TabPageSetupTransform extends AbstractTabTransform implements LayoutTransform
This class transforms a
TabBeanallowing users to view/modify general page output properties (like graphs format, PDF settings, horizontal fit). As with other TabTransforms, this one assumes itsTabManagerBeanwill take care of rendering the required HTML & Javascript allowing users to switch between different formattingTabBeaninstances.The output of this transform is divided into two sections:
- Paper size section.
- Scaling Section
Each one of these sections has its ownrendermethod. 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 ------------------------------------- | | | Paper size Section | | | ------------------------------------- | | | Scaling 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 Modifier and Type Field Description static java.lang.StringLAYOUT_WIDTH_MODE_AUTO_OPTIONstatic java.lang.StringLAYOUT_WIDTH_MODE_FIXED_OPTIONstatic java.lang.StringPROPERTY_NAME_LAYOUT_WIDTH_MODEstatic java.lang.StringPROPERTY_NAME_PAPER_HEIGHTstatic java.lang.StringPROPERTY_NAME_PAPER_ORIENTATIONstatic java.lang.StringPROPERTY_NAME_PAPER_TYPEstatic java.lang.StringPROPERTY_NAME_PAPER_WIDTHstatic java.lang.StringPROPERTY_NAME_SCALE_HEADER_FOOTERstatic java.lang.StringPROPERTY_NAME_SCALE_PAGES_TALLstatic java.lang.StringPROPERTY_NAME_SCALE_PAGES_WIDEstatic java.lang.StringPROPERTY_NAME_SCALE_PERCENTAGEstatic java.lang.StringPROPERTY_NAME_SCALINGstatic java.lang.StringPROPERTY_NAME_SECTION_HORIZONTAL_OVERFLOWstatic java.lang.StringPROPERTY_NAME_USE_PAGEWIDTH_AS_LAYOUTWIDTHstatic java.lang.StringPROPERTYSET_NAME_FORMATTING_PAGEstatic java.lang.StringSCALING_FIT_TO_PAGE_OPTIONstatic java.lang.StringSCALING_SHRINK_FONT_OPTION-
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 TabPageSetupTransform()Default empty constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.StringgetDescription()Returns the textual description of the transformjava.lang.ClassgetSupportedBeanType()Returns the supported bean type.voidinitializeCss()Initializes the Css Classes to use.voidinitializeJavaScriptAttributes()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.voidinitializeTransform(Transformable data)This method initialize the private and protected fields of the transform.voidrenderContentsBody(MarkupOutput out)This is the entry point for the Tranform, and generates the body of the Tab.voidrenderHorizontalFitSection(MarkupOutput out)Generates the HTML output for the horizontal fit section on this tab instance.static voidrenderHorizontalFitSection(MarkupOutput out, AbstractTabTransform t, java.lang.String cssPrefix, java.lang.String beanName, java.lang.String propValue)Generates the HTML output for the horizontal fit section on this tab instance.voidrenderJavascriptLinks(MarkupOutput out)Used to dynamically include links to js files.voidrenderPaperSizeSection(MarkupOutput out)Generates the HTML output for the Page setup section on this tab instance.voidrenderScalingSection(MarkupOutput out)Generates the HTML output for the Scaling section on this 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, 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
-
-
-
-
Field Detail
-
PROPERTYSET_NAME_FORMATTING_PAGE
public static final java.lang.String PROPERTYSET_NAME_FORMATTING_PAGE
- See Also:
- Constant Field Values
-
PROPERTY_NAME_PAPER_TYPE
public static final java.lang.String PROPERTY_NAME_PAPER_TYPE
- See Also:
- Constant Field Values
-
PROPERTY_NAME_PAPER_WIDTH
public static final java.lang.String PROPERTY_NAME_PAPER_WIDTH
- See Also:
- Constant Field Values
-
PROPERTY_NAME_PAPER_HEIGHT
public static final java.lang.String PROPERTY_NAME_PAPER_HEIGHT
- See Also:
- Constant Field Values
-
PROPERTY_NAME_PAPER_ORIENTATION
public static final java.lang.String PROPERTY_NAME_PAPER_ORIENTATION
- See Also:
- Constant Field Values
-
PROPERTY_NAME_SCALING
public static final java.lang.String PROPERTY_NAME_SCALING
- See Also:
- Constant Field Values
-
PROPERTY_NAME_SCALE_PERCENTAGE
public static final java.lang.String PROPERTY_NAME_SCALE_PERCENTAGE
- See Also:
- Constant Field Values
-
PROPERTY_NAME_SCALE_PAGES_WIDE
public static final java.lang.String PROPERTY_NAME_SCALE_PAGES_WIDE
- See Also:
- Constant Field Values
-
PROPERTY_NAME_SCALE_PAGES_TALL
public static final java.lang.String PROPERTY_NAME_SCALE_PAGES_TALL
- See Also:
- Constant Field Values
-
PROPERTY_NAME_SCALE_HEADER_FOOTER
public static final java.lang.String PROPERTY_NAME_SCALE_HEADER_FOOTER
- See Also:
- Constant Field Values
-
PROPERTY_NAME_USE_PAGEWIDTH_AS_LAYOUTWIDTH
public static final java.lang.String PROPERTY_NAME_USE_PAGEWIDTH_AS_LAYOUTWIDTH
- See Also:
- Constant Field Values
-
PROPERTY_NAME_LAYOUT_WIDTH_MODE
public static final java.lang.String PROPERTY_NAME_LAYOUT_WIDTH_MODE
- Since:
- MicroStrategy Web 8.0.2
- See Also:
- Constant Field Values
-
SCALING_SHRINK_FONT_OPTION
public static final java.lang.String SCALING_SHRINK_FONT_OPTION
- See Also:
- Constant Field Values
-
SCALING_FIT_TO_PAGE_OPTION
public static final java.lang.String SCALING_FIT_TO_PAGE_OPTION
- See Also:
- Constant Field Values
-
PROPERTY_NAME_SECTION_HORIZONTAL_OVERFLOW
public static final java.lang.String PROPERTY_NAME_SECTION_HORIZONTAL_OVERFLOW
- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
LAYOUT_WIDTH_MODE_AUTO_OPTION
public static final java.lang.String LAYOUT_WIDTH_MODE_AUTO_OPTION
- Since:
- MicroStrategy Web 8.0.2
- See Also:
- Constant Field Values
-
LAYOUT_WIDTH_MODE_FIXED_OPTION
public static final java.lang.String LAYOUT_WIDTH_MODE_FIXED_OPTION
- Since:
- MicroStrategy Web 8.0.2
- See Also:
- Constant Field Values
-
-
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
renderPaperSizeSection()andrenderScalingSection().- Specified by:
renderContentsBodyin classAbstractTabTransform- Parameters:
out-MarkupOutputinstance where the HTML contents to render will be saved.
-
renderHorizontalFitSection
public void renderHorizontalFitSection(MarkupOutput out)
Generates the HTML output for the horizontal fit section on this tab instance.- Parameters:
out-MarkupOutputinstance where the HTML contents to render will be saved.- Since:
- MicroStrategy Web 9.0.0
-
renderScalingSection
public void renderScalingSection(MarkupOutput out)
Generates the HTML output for the Scaling section on this tab instance.- Parameters:
out-MarkupOutputinstance where the HTML contents to render will be saved.
-
renderPaperSizeSection
public void renderPaperSizeSection(MarkupOutput out)
Generates the HTML output for the Page setup section on this tab instance.- Parameters:
out-MarkupOutputinstance where the HTML contents to render will be saved.
-
renderJavascriptLinks
public void renderJavascriptLinks(MarkupOutput out)
Description copied from class:AbstractTabTransformUsed to dynamically include links to js files. Extend with the list of files your transform requires.- Overrides:
renderJavascriptLinksin classAbstractTabTransform- Parameters:
out-MarkupOutputinstance where the HTML contents to render will be saved.
-
getSupportedBeanType
public java.lang.Class getSupportedBeanType()
Returns the supported bean type. This transform supports any of theTabBeaninstances- Specified by:
getSupportedBeanTypein interfaceTransform- Overrides:
getSupportedBeanTypein 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:
getDescriptionin interfaceTransform- Overrides:
getDescriptionin 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:
initializeCssin 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,tyFrameandscriptClassFrame.- Overrides:
initializeJavaScriptAttributesin classAbstractTabTransform
-
initializeTransform
public void initializeTransform(Transformable data)
Description copied from class:AbstractTabTransformThis method initialize the private and protected fields of the transform. In particular it invokes theinitializeJavaScriptAttribute()method.- Specified by:
initializeTransformin interfaceAppTransform- Overrides:
initializeTransformin classAbstractTabTransform- Parameters:
data-Transformableinstance to be transformed.
-
renderHorizontalFitSection
public static void renderHorizontalFitSection(MarkupOutput out, AbstractTabTransform t, java.lang.String cssPrefix, java.lang.String beanName, java.lang.String propValue)
Generates the HTML output for the horizontal fit section on this tab instance.- Parameters:
out-MarkupOutputinstance where the HTML contents to render will be saved.t-AbstractTabTransformto be used for rendering html.cssPrefix- String the css prefixbeanName- String the name to be used for acessing the client-side bone.propValue- String the value of the PROPERTY_NAME_SECTION_HORIZONTAL_OVERFLOW property.- Since:
- MicroStrategy Web 9.0.0
-
-