Class TabGraphGeneralTransform
- 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.TabGraphGeneralTransform
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
public class TabGraphGeneralTransform extends AbstractTabTransform implements LayoutTransform
This class transforms a
TabBean
allowing users to view/modify general graph properties (like graph type, subtype, categories, etc) of a graph. 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 can be divided into thre main sections:
- Graph Styles (type and subtype)
- Maximum Settings (for categories and series)
- Other (like settings for fonts and series orientation)
Each one of these sections has its ownrender
method. Furthermore each section generates individual settings which have been 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:
Contents / ContentsBody ----------------------------------------------------- | | | Graph Styles | | | | | ----------------------------------------------------- | | | Maximum Settings | | | | | ----------------------------------------------------- | | | Other Settings | | | | | -----------------------------------------------------
- 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.String
FP_SUB_TYPES_PICKER_NAME
Constant specifying the name of the subTypesPickerName formal parameter.static java.lang.String
FP_TYPES_PICKER_NAME
Constant specifying the name of the typesPickerName formal parameter.FormalParameter
subTypesPickerName
Indicates the name of the system picker (defined in the page-config) that contains the list graph sub-types that shall be displayed to the user.FormalParameter
typesPickerName
Indicates the name of the system picker (defined in the page-config) that contains the list graph types that shall be displayed to the user.-
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 TabGraphGeneralTransform()
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 WebGraphProperties
getGraphProperties()
ShortcutList
getSubTypesPicker()
Returns the graph sub-types picker.java.lang.Class
getSupportedBeanType()
Returns the supported bean type.ShortcutList
getTypesPicker()
Returns the graph types picker.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
renderAntiAliasing(MarkupOutput out)
void
renderContentsBody(MarkupOutput out)
This is the entry point for the Tranform, and generates the body of the Tab.void
renderCurvedLines(MarkupOutput out)
void
renderDropdown(MarkupOutput out, java.lang.String cmdId, java.lang.String cmdValue, ShortcutList picker, java.lang.String value)
This method renders a single dropdown list to be used within a tab.void
renderGraphStyles(MarkupOutput out)
Generates the HTML output for the Graph Styles section on this format tab instance.void
renderJavascriptLinks(MarkupOutput out)
Render any JavaScript information required for this tab to work correctly on client side.void
renderMaximumSettings(MarkupOutput out)
Generates the HTML output for the Maximum Settings section on this format tab instance.void
renderRoundedEffect(MarkupOutput out)
void
setSubTypesPicker(ShortcutList picker)
Register the sub-types picker.void
setTypesPicker(ShortcutList picker)
Register the major types picker.-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractTabTransform
addJSValidationInfo, AddJSValidationInfo, addPicker, getArgumentName, getAttributesBody, getAttributesFrame, getDropDownTag, getFieldSetTag, getLabelTag, getPickerId, getTabBean, getTabManagerBean, initializeTransform, isCurrentTab, isIFrameEnabled, renderColorDropdown, renderContents, 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
-
-
-
-
Field Detail
-
typesPickerName
public FormalParameter typesPickerName
Indicates the name of the system picker (defined in the page-config) that contains the list graph types that shall be displayed to the user.
-
subTypesPickerName
public FormalParameter subTypesPickerName
Indicates the name of the system picker (defined in the page-config) that contains the list graph sub-types that shall be displayed to the user.
-
FP_TYPES_PICKER_NAME
public static final java.lang.String FP_TYPES_PICKER_NAME
Constant specifying the name of the typesPickerName formal parameter.- See Also:
- Constant Field Values
-
FP_SUB_TYPES_PICKER_NAME
public static final java.lang.String FP_SUB_TYPES_PICKER_NAME
Constant specifying the name of the subTypesPickerName formal parameter.- 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
renderGraphStyles()
,renderMaximumSettings()
andrenderOtherSettings()
.- Specified by:
renderContentsBody
in classAbstractTabTransform
- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
getGraphProperties
protected WebGraphProperties getGraphProperties()
- Since:
- MicroStrategy Web 8.0.1
-
renderGraphStyles
public void renderGraphStyles(MarkupOutput out)
Generates the HTML output for the Graph Styles section on this format tab instance. Includes major and subtype option combo boxes.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderMaximumSettings
public void renderMaximumSettings(MarkupOutput out)
Generates the HTML output for the Maximum Settings section on this format tab instance. Includes categories and series.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderRoundedEffect
public void renderRoundedEffect(MarkupOutput out)
- Since:
- MicroStrategy Web 8.1.0
-
renderCurvedLines
public void renderCurvedLines(MarkupOutput out)
- Since:
- MicroStrategy Web 8.1.0
-
renderAntiAliasing
public void renderAntiAliasing(MarkupOutput out)
- Since:
- MicroStrategy Web 8.1.0
-
renderJavascriptLinks
public void renderJavascriptLinks(MarkupOutput out)
Render any JavaScript information required for this tab to work correctly on client side.- Overrides:
renderJavascriptLinks
in classAbstractTabTransform
- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
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
-
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
-
setTypesPicker
public void setTypesPicker(ShortcutList picker)
Register the major types picker. This allows the transform to use a
ShortcutList
that is not defined inside the pageConfig.- Parameters:
picker
- the major type picker to set.
-
getTypesPicker
public ShortcutList getTypesPicker()
Returns the graph types picker. If a non-null instance have been registered through thesetTypesPicker
method, it will return that one, otherwise, it will search for a system picker with the name specified intypesPickerName
.- Returns:
ShortcutList
to use for the graph types picker.
-
setSubTypesPicker
public void setSubTypesPicker(ShortcutList picker)
Register the sub-types picker. This allows the transform to use a
ShortcutList
that is not defined inside the pageConfig.- Parameters:
picker
- the minor type picker to set.
-
getSubTypesPicker
public ShortcutList getSubTypesPicker()
Returns the graph sub-types picker. If a non-null instance have been registered through thesetSubTypesPicker(com.microstrategy.web.app.ShortcutList)
method, it will return that one, otherwise, it will search for a system picker with the name specified insubTypesPickerName
.- Returns:
- ShortcutList to use for the graph sub-types picker.
-
renderDropdown
public void renderDropdown(MarkupOutput out, java.lang.String cmdId, java.lang.String cmdValue, ShortcutList picker, java.lang.String value)
Description copied from class:AbstractTabTransform
This method renders a single dropdown list to be used within a tab.- Overrides:
renderDropdown
in classAbstractTabTransform
- Parameters:
out
- MarkupOutput where the content should be generatedcmdId
- the dropdown's command idcmdValue
- the dropdown's current command value.picker
- the ShortcutList for the picker.value
- the dropdown current value.- Since:
- MicroStrategy Web 8.1.0
-
-