Class FormatTabFontTransform
- 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.FormatTabFontTransform
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
public class FormatTabFontTransform extends AbstractFormatTabTransform implements LayoutTransform
This class transforms a
FormatTabBean
allowing users to modify the corresponding font properties displayed for the text 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 several sections, such as:
- 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 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 is divided as follows:
Contents / ContentsBody ----------------------------------------------------- | | | | | | | | | 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 protected FormalParameter
colorPickerName
Indicates the id of a system picker that contains the possible color optionsprotected 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.protected 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.protected 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_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_FORMAT_TARGET
Constant specifying the name of the formal paramter for determining the formatting target, e.g., grid, rw, thresholds, etc.-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractFormatTabTransform
formatTarget
-
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 FormatTabFontTransform()
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
getFontNamePicker()
Returns the font name picker.ShortcutList
getFontSizePicker()
Returns the font size picker.ShortcutList
getFontStylePicker()
Returns the font style picker.protected 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
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
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
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)
Extends the parent method by adding the JavaScript file this transform needs for its correct behavior on the client side.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
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
setColorPicker(ShortcutList picker)
Register the 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, 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
-
fontNamePickerName
protected 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
protected 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
protected 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.
-
colorPickerName
protected FormalParameter colorPickerName
Indicates the id of a system picker that contains the possible color options
-
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_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_FORMAT_TARGET
public static final java.lang.String FP_FORMAT_TARGET
Constant specifying the name of the formal paramter for determining the formatting target, e.g., grid, rw, thresholds, etc.- Since:
- MicroStrategy Web 9.0.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
renderFontSection()
,renderStyleSection()
,renderSizeSection()
,renderEffectsSection()
,renderColorSection()
andrenderSampleSection()
- Specified by:
renderContentsBody
in classAbstractTabTransform
- 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.
-
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)
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)
-
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
-
getFormatTabBean
protected FormatTabBean getFormatTabBean()
Obtain theFormatTabBean
instance currently being transformed.- Returns:
- the
FormatTabBean
being transformed.
-
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, 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 inFP_FONT_NAME_PICKER_NAME
.- 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 inFP_FONT_SIZE_PICKER_NAME
.- 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 inFP_FONT_STYLE_PICKER_NAME
.- Returns:
- ShortcutList to use for the font-style picker.
-
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.
-
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 inFP_COLOR_PICKER_NAME
.- Returns:
- ShortcutList to use for the color-picker.
-
-