Class TabGraphTitlesTransform
- 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.TabGraphTitlesTransform
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
public class TabGraphTitlesTransform extends AbstractTabTransform implements LayoutTransform
This class transforms a
TabBean
allowing users to view/modify formatting properties for the graph titles (mainly font properties). 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 several sections:
- Titles Combo (a combo box with the list of available titles)
- Font Name
- Font Style
- Font Size
- Effects
- Font Color
- Sample
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:
ContentsBody ----------------------------------------------------- | TitlesCombo | ----------------------------------------------------- | | | | | | | | | FontSection | StyleSection | SizeSection | | | | | | | | | ----------------------------------------------------- | | | | EffectsSection | ColorSection | | | | | |--------------------------------| | | | | | SampleSection | | | | -----------------------------------------------------
- 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 FormalParameter
colorPickerName
Indicates the id of a system picker that contains the possible color optionsFormalParameter
fillColorPickerName
Indicates the id of a system picker that contains the possible fill color optionsFormalParameter
fillEffectPickerName
Indicates the name of the system picker that contains the fill effects that shall be displayed to the user as possible options for fill formatting.FormalParameter
fontColorPickerName
Indicates the id of a system picker that contains the possible color options for fontFormalParameter
fontNamePickerName
Indicates the name of the system picker that contains the font names that shall be displayed to the user as possible options for font formatting.FormalParameter
fontSizePickerName
Indicates the name of the system picker that contains the font sizes that shall be displayed to the user as possible options for font formatting.FormalParameter
fontStylePickerName
Indicates the name of the system picker that contains the font styles that shall be displayed to the user as possible options for font formatting.static java.lang.String
FP_COLOR_PICKER_NAME
Constant specifying the name of the formal parameter for defining the id of a system picker that contains the possible color options.static java.lang.String
FP_FILL_COLOR_PICKER_NAME
Constant specifying the name of the formal parameter for defining the id of a system picker that contains the possible color options.static java.lang.String
FP_FILL_EFFECT_PICKER_NAME
Constant specifying the name of the formal parameter for defining the name of the system picker that provides the fill effect options.static java.lang.String
FP_FONT_COLOR_PICKER_NAME
Constant specifying the name of the formal parameter for defining the id of a system picker that contains the possible color options for font.static java.lang.String
FP_FONT_NAME_PICKER_NAME
Constant specifying the name of the formal parameter for defining the name of the system picker that provides the font name options.static java.lang.String
FP_FONT_SIZE_PICKER_NAME
Constant specifying the name of the formal parameter for defining the name of the system picker that provides the font size options.static java.lang.String
FP_FONT_STYLE_PICKER_NAME
Constant specifying the name of the formal parameter for defining the name of the system picker that provides the font style options.static java.lang.String
FP_TITLE_LIST
Constant specifying the name of the formal parameter for defining the list of titles that will be rendered by this transform as possible format options.FormalParameter
titleList
Indicates which titles that will be rendered by this format tab as options, as long as the current graph major type supports them.-
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 TabGraphTitlesTransform()
Default no-argument constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ShortcutList
getColorPicker()
Returns the color picker.java.lang.String
getDescription()
Returns the textual description of the transformShortcutList
getFillColorPicker()
Returns the fill color picker.ShortcutList
getFillEffectsPicker()
Returns the font style picker.ShortcutList
getFontColorPicker()
Returns the font color picker.ShortcutList
getFontNamePicker()
Returns the font name picker.ShortcutList
getFontSizePicker()
Returns the font size picker.ShortcutList
getFontStylePicker()
Returns the font style picker.java.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
renderColorSection(MarkupOutput out)
Generates the HTML output for the Color section on this tab instance, that allows users to select the font color to use for formatting the currently selected target(s).void
renderContentsBody(MarkupOutput out)
This is the entry point for the Tranform, and generates the body of the Tab.void
renderContentSection(MarkupOutput out)
Generates the HTML output for the Content section on this tab instance, that allows users to specify the text they want to have displayed on a given location on the graph.void
renderEffectsSection(MarkupOutput out)
Generates the HTML output for the Effects section on this tab instance, that allows users to select the font effects (underline, strikeout) to use for formatting the currently selected target(s).void
renderFillColorSection(MarkupOutput out)
Generates the HTML output for the Line Color section on this tab instance, that allows users to select the font color to use for formatting the currently selected target(s).void
renderFillEffectSection(MarkupOutput out)
Generates the HTML output for the Fill Effect section on this tab instance, that allows users to select the effect to use for formatting the currently selected target(s).void
renderFontBoxStyle(MarkupOutput out)
void
renderFontSection(MarkupOutput out)
Generates the HTML output for the Font section on this tab instance, that allows users to select the font name to use for formatting the currently selected target(s).void
renderJavascriptLinks(MarkupOutput out)
Render any JavaScript information required for this tab to work correctly on client side.void
renderLineColorSection(MarkupOutput out)
Generates the HTML output for the Line Color section on this tab instance, that allows users to select the font color to use for formatting the currently selected target(s).void
renderMacroInformation(MarkupOutput out)
Called fromrenderContentSection(com.microstrategy.web.beans.MarkupOutput)
, generates an information image icon which will display the macro options that can be typed in on the content text box.void
renderPositionSection(MarkupOutput out)
Generates the HTML output for the Legend Position section on this tab instance, that allows users to define where the legends should be located on the graph image.void
renderSampleSection(MarkupOutput out)
Generates the HTML output for the Sample section on this tab instance, that allows users to preview how the formatting changes will update the selected target(s).void
renderShowSection(MarkupOutput out)
Generates the HTML output for the Show section on this tab instance, that allows users to select whether the title should be shown or not.void
renderSizeSection(MarkupOutput out)
Generates the HTML output for the Size section on this tab instance, that allows users to select the font size to use for formatting the currently selected target(s).void
renderStyleSection(MarkupOutput out)
Generates the HTML output for the Style section on this tab instance, that allows users to select the font style to use for formatting the currently selected target(s).void
renderTitlesCombo(MarkupOutput out)
Convenience method that displays the HTML required for rendering the title of a section.void
renderTooltipsSection(MarkupOutput out)
void
renderTransparencySection(MarkupOutput out)
void
setColorPicker(ShortcutList picker)
Register the color picker.void
setFillColorPicker(ShortcutList picker)
Register the fill color picker.void
setFontColorPicker(ShortcutList picker)
Register the font color picker.void
setFontNamePicker(ShortcutList fontNamePicker)
Register the font name picker.void
setFontSizePicker(ShortcutList picker)
Register the font size picker.void
setFontStylePicker(ShortcutList picker)
Register the font style picker.-
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
-
titleList
public FormalParameter titleList
Indicates which titles that will be rendered by this format tab as options, as long as the current graph major type supports them. Value is a series of title identifiers (fromEnumDSSXMLGraphObjectID
) separated by commas.
-
colorPickerName
public FormalParameter colorPickerName
Indicates the id of a system picker that contains the possible color options
-
fillColorPickerName
public FormalParameter fillColorPickerName
Indicates the id of a system picker that contains the possible fill color options- Since:
- MicroStrategy Web 8.1.0
-
fontColorPickerName
public FormalParameter fontColorPickerName
Indicates the id of a system picker that contains the possible color options for font- Since:
- MicroStrategy Web 8.0.1
-
fontNamePickerName
public FormalParameter fontNamePickerName
Indicates the name of the system picker that contains the font names that shall be displayed to the user as possible options for font formatting.
-
fontSizePickerName
public FormalParameter fontSizePickerName
Indicates the name of the system picker that contains the font sizes that shall be displayed to the user as possible options for font formatting.
-
fontStylePickerName
public FormalParameter fontStylePickerName
Indicates the name of the system picker that contains the font styles that shall be displayed to the user as possible options for font formatting.
-
fillEffectPickerName
public FormalParameter fillEffectPickerName
Indicates the name of the system picker that contains the fill effects that shall be displayed to the user as possible options for fill formatting.- Since:
- MicroStrategy Web 8.1.0
-
FP_TITLE_LIST
public static final java.lang.String FP_TITLE_LIST
Constant specifying the name of the formal parameter for defining the list of titles that will be rendered by this transform as possible format options. Value is titleList.- See Also:
- Constant Field Values
-
FP_COLOR_PICKER_NAME
public static final java.lang.String FP_COLOR_PICKER_NAME
Constant specifying the name of the formal parameter for defining the id of a system picker that contains the possible color options. Value is colorPickerName.- See Also:
- Constant Field Values
-
FP_FILL_COLOR_PICKER_NAME
public static final java.lang.String FP_FILL_COLOR_PICKER_NAME
Constant specifying the name of the formal parameter for defining the id of a system picker that contains the possible color options. Value is colorPickerName.- Since:
- MicroStrategy Web 8.1.0
- See Also:
- Constant Field Values
-
FP_FONT_COLOR_PICKER_NAME
public static final java.lang.String FP_FONT_COLOR_PICKER_NAME
Constant specifying the name of the formal parameter for defining the id of a system picker that contains the possible color options for font. Value is fontColorPickerName.- Since:
- MicroStrategy Web 8.0.1
- See Also:
- Constant Field Values
-
FP_FONT_NAME_PICKER_NAME
public static final java.lang.String FP_FONT_NAME_PICKER_NAME
Constant specifying the name of the formal parameter for defining the name of the system picker that provides the font name options. Value is fontNamePickerName.- See Also:
- Constant Field Values
-
FP_FONT_SIZE_PICKER_NAME
public static final java.lang.String FP_FONT_SIZE_PICKER_NAME
Constant specifying the name of the formal parameter for defining the name of the system picker that provides the font size options. Value is fontSizePickerName.- See Also:
- Constant Field Values
-
FP_FONT_STYLE_PICKER_NAME
public static final java.lang.String FP_FONT_STYLE_PICKER_NAME
Constant specifying the name of the formal parameter for defining the name of the system picker that provides the font style options. Value is fontStylePickerName.- See Also:
- Constant Field Values
-
FP_FILL_EFFECT_PICKER_NAME
public static final java.lang.String FP_FILL_EFFECT_PICKER_NAME
Constant specifying the name of the formal parameter for defining the name of the system picker that provides the fill effect options. Value is fillEffectPickerName.- Since:
- MicroStrategy Web 8.1.0
- 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
renderTitlesCombo
,renderFontSection()
,renderStyleSection()
,renderSizeSection()
,renderEffectsSection()
,renderColorSection()
andrenderSampleSection()
- Specified by:
renderContentsBody
in classAbstractTabTransform
- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderTitlesCombo
public void renderTitlesCombo(MarkupOutput out)
Convenience method that displays the HTML required for rendering the title of a section.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderShowSection
public void renderShowSection(MarkupOutput out)
Generates the HTML output for the Show section on this tab instance, that allows users to select whether the title should be shown or not.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderTooltipsSection
public void renderTooltipsSection(MarkupOutput out)
- Since:
- MicroStrategy Web 8.1.0
-
renderMacroInformation
public void renderMacroInformation(MarkupOutput out)
Called fromrenderContentSection(com.microstrategy.web.beans.MarkupOutput)
, generates an information image icon which will display the macro options that can be typed in on the content text box.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.- Since:
- MicroStrategy Web 8.0.1
-
renderContentSection
public void renderContentSection(MarkupOutput out)
Generates the HTML output for the Content section on this tab instance, that allows users to specify the text they want to have displayed on a given location on the graph.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderPositionSection
public void renderPositionSection(MarkupOutput out)
Generates the HTML output for the Legend Position section on this tab instance, that allows users to define where the legends should be located on the graph image.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderFontSection
public void renderFontSection(MarkupOutput out)
Generates the HTML output for the Font section on this tab instance, that allows users to select the font name to use for formatting the currently selected target(s).- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderStyleSection
public void renderStyleSection(MarkupOutput out)
Generates the HTML output for the Style section on this tab instance, that allows users to select the font style to use for formatting the currently selected target(s).- 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 tab instance, that allows users to select the font size to use for formatting the currently selected target(s).- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderEffectsSection
public void renderEffectsSection(MarkupOutput out)
Generates the HTML output for the Effects section on this tab instance, that allows users to select the font effects (underline, strikeout) to use for formatting the currently selected target(s).- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderColorSection
public void renderColorSection(MarkupOutput out)
Generates the HTML output for the Color section on this tab instance, that allows users to select the font color to use for formatting the currently selected target(s).- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderLineColorSection
public void renderLineColorSection(MarkupOutput out)
Generates the HTML output for the Line Color section on this tab instance, that allows users to select the font color to use for formatting the currently selected target(s).- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.- Since:
- MicroStrategy Web 8.0.1
-
renderFillColorSection
public void renderFillColorSection(MarkupOutput out)
Generates the HTML output for the Line Color section on this tab instance, that allows users to select the font color to use for formatting the currently selected target(s).- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.- Since:
- MicroStrategy Web 8.0.1
-
renderFillEffectSection
public void renderFillEffectSection(MarkupOutput out)
Generates the HTML output for the Fill Effect section on this tab instance, that allows users to select the effect to use for formatting the currently selected target(s).- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.- Since:
- MicroStrategy Web 8.1.0
-
renderTransparencySection
public void renderTransparencySection(MarkupOutput out)
- Since:
- MicroStrategy Web 8.1.0
-
renderFontBoxStyle
public void renderFontBoxStyle(MarkupOutput out)
- Since:
- MicroStrategy Web 9.0.0
-
renderSampleSection
public void renderSampleSection(MarkupOutput out)
Generates the HTML output for the Sample section on this tab instance, that allows users to preview how the formatting changes will update the selected target(s).- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
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.
-
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
-
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
-
setFontNamePicker
public void setFontNamePicker(ShortcutList fontNamePicker)
Register the font name picker. This allows the transform to use a ShortcutList that is not defined inside the pageConfig.
- Parameters:
fontNamePicker
- The fontNamePicker to set.
-
getFontNamePicker
public ShortcutList getFontNamePicker()
Returns the font name picker. If a non-null instance have been registered through thesetFontNamePicker
method, it will return that one, otherwise, it will search for a system picker with the name specified infontNamePickerName
.- Returns:
- ShortcutList to use for the font-name picker.
-
setFontSizePicker
public void setFontSizePicker(ShortcutList picker)
Register the font size picker. This allows the transform to use a ShortcutList that is not defined inside the pageConfig.
- Parameters:
picker
- The fontSizePicker to set.
-
getFontSizePicker
public ShortcutList getFontSizePicker()
Returns the font size picker. If a non-null instance have been registered through thesetFontSizePicker
method, it will return that one, otherwise, it will search for a system picker with the name specified infontSizePickerName
.- Returns:
- ShortcutList to use for the font-size picker.
-
setFontStylePicker
public void setFontStylePicker(ShortcutList picker)
Register the font style picker. This allows the transform to use a ShortcutList that is not defined inside the pageConfig.
- Parameters:
picker
- The fontStylePicker to set.
-
getFontStylePicker
public ShortcutList getFontStylePicker()
Returns the font style picker. If a non-null instance have been registered through thesetFontStylePicker
method, it will return that one, otherwise, it will search for a system picker with the name specified infontStylePickerName
.- Returns:
- ShortcutList to use for the font-style picker.
-
getFillEffectsPicker
public ShortcutList getFillEffectsPicker()
Returns the font style picker. If a non-null instance have been registered through thesetFontStylePicker
method, it will return that one, otherwise, it will search for a system picker with the name specified infillEffectPickerName
.- Returns:
- ShortcutList to use for the font-style picker.
- Since:
- MicroStrategy Web 8.1.0
-
setColorPicker
public void setColorPicker(ShortcutList picker)
Register the color picker. This allows the transform to use a ShortcutList that is not defined inside the pageConfig.
- Parameters:
picker
- The colorPicker to set.
-
setFillColorPicker
public void setFillColorPicker(ShortcutList picker)
Register the fill color picker. This allows the transform to use a ShortcutList that is not defined inside the pageConfig.
- Parameters:
picker
- The colorPicker to set.- Since:
- MicroStrategy Web 8.1.0
-
setFontColorPicker
public void setFontColorPicker(ShortcutList picker)
Register the font color picker. This allows the transform to use a ShortcutList that is not defined inside the pageConfig.
- Parameters:
picker
- The colorPicker to set.- Since:
- MicroStrategy Web 8.0.1
-
getColorPicker
public ShortcutList getColorPicker()
Returns the color picker. If a non-null instance have been registered through thesetColorPicker
method, it will return that one, otherwise, it will search for a system picker with the name specified incolorPickerName
.- Returns:
- ShortcutList to use for the color-picker.
-
getFillColorPicker
public ShortcutList getFillColorPicker()
Returns the fill color picker. If a non-null instance have been registered through thesetColorPicker
method, it will return that one, otherwise, it will search for a system picker with the name specified infillColorPickerName
.- Returns:
- ShortcutList to use for the color-picker.
- Since:
- MicroStrategy Web 8.1.0
-
getFontColorPicker
public ShortcutList getFontColorPicker()
Returns the font color picker. If a non-null instance have been registered through thesetColorPicker
method, it will return that one, otherwise, it will search for a system picker with the name specified incolorPickerName
.- Returns:
- ShortcutList to use for the color-picker.
- Since:
- MicroStrategy Web 8.0.1
-
-