Class FormatTabColorLinesTransform
- 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.FormatTabColorLinesTransform
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
public class FormatTabColorLinesTransform extends AbstractFormatTabTransform implements LayoutTransform
This class transforms a
FormatColorLinesTabBean
allowing users to modify the corresponding color lines properties of a control, such as borders, color, etc. 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 three sections:
- Fill
- Borders
- Line and Shape Settings
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:
Contents / ContentsBody ------------------------------------- | | | FillSection | | -- FillColorSection | | | ------------------------------------- | | | BordersSection | | -- BorderSettingsSection | | - AllBorderSettingsSection | | - CustomBorderSettingsSection | | - LeftBorderSection | | - RightBorderSection | | - TopBorderSection | | - BottomBorderSection | | | ------------------------------------- | | | LineSettingsSection | | -- LineSettingsStyleSection | | -- LineSettingsColorSection | | -- LineSettingsWeightSection | | | -------------------------------------
- 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
allBorderStylePickerName
Indicates the id of a system picker that contains the possible all border style optionsFormalParameter
borderColorPickerName
Indicates the id of a system picker that contains the possible color options for bordersFormalParameter
borderStylePickerName
Indicates the id of a system picker that contains the possible border style optionsFormalParameter
colorPickerName
Indicates the id of a system picker that contains the possible color options for fill colorsstatic java.lang.String
FP_ALL_BORDER_STYLE_PICKER_NAME
Constant specifying the name of the formal parameter for defining the id of a system picker that contains the list of all-borders options.static java.lang.String
FP_BORDER_COLOR_PICKER_NAME
Constant specifying the name of the formal parameter for defining the id of a system picker that contains the possible border color options.static java.lang.String
FP_BORDER_STYLE_PICKER_NAME
Constant specifying the name of the formal parameter for defining the id of a system picker that contains the list of border options.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 background/fill color options.static java.lang.String
FP_IS_DOC_PROPS
Constant specifying the name of the formal parameter that determines whether we are showing the tab for the Document Properties Editor.static java.lang.String
FP_Line_COLOR_PICKER_NAME
Constant specifying the name of the formal parameter for defining the id of a system picker that contains the possible line color options.static java.lang.String
FP_LINE_STYLE_PICKER_NAME
Constant specifying the name of the formal parameter for defining the id of a system picker that contains the list of line options.FormalParameter
isDocumentProperties
Indicates whether we are showing the tab for the Document Properties Editor.FormalParameter
lineColorPickerName
Indicates the id of a system picker that contains the possible color options for linesFormalParameter
lineStylePickerName
Indicates the id of a system picker that contains the possible line style options-
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 FormatTabColorLinesTransform()
Default no-argument constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ShortcutList
getAllBorderPicker()
Returns the all-borders-style picker.protected java.util.Map
getAttributesFrame()
This method return a Map (name/value pairs) of attributes to use for the div enclosing the content of the Tab.ShortcutList
getBorderColorPicker()
Returns the border color picker.ShortcutList
getBorderPicker()
Returns the border picker.ShortcutList
getColorPicker()
Returns the background color picker.java.lang.String
getDescription()
Returns the textual description of the transformShortcutList
getLineColorPicker()
Returns the line color picker.ShortcutList
getLineStylePicker()
Returns the line style picker.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.protected boolean
isGridBordersFormattingSelected()
Returns true if the grid borders are enabled for this bean.void
renderAllBorderSettingsSection(MarkupOutput out)
Displays the interface for allowing the user to modify the border settings on the currently selected target object(s), when the border level selected is All.void
renderBorderLevelsSection(MarkupOutput out)
Displays the interface for allowing the user to modify the level of border formatting setting on the currently selected target object(s).void
renderBorderSettingsSection(MarkupOutput out)
Displays the interface for allowing the user to customize the border settings on the currently selected target object(s).void
renderBordersSection(MarkupOutput out)
Generates the HTML output for the Borders section on this format tab instance.void
renderBottomBorderSection(MarkupOutput out)
Displays the interface for allowing the user to modify the bottom border formatting 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
renderCustomBorderSettingsSection(MarkupOutput out)
Displays the interface for allowing the user to modify the border settings on the currently selected target object(s), when the border level selected is Custom.void
renderFillColorSection(MarkupOutput out)
Displays the interface for allowing the user to modify the fill color setting on the currently selected target object(s).void
renderFillSection(MarkupOutput out)
Generates the HTML output for the Fill section on this format tab instance.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
renderLeftBorderSection(MarkupOutput out)
Displays the interface for allowing the user to modify the left border formatting setting on the currently selected target object(s).void
renderLineSettingsColorSection(MarkupOutput out)
Generates the HTML output for the line color setting options.void
renderLineSettingsSection(MarkupOutput out)
Generates the HTML output for the line settings section on this format tab instance.void
renderLineSettingsStyleSection(MarkupOutput out)
Generates the HTML output for the line style setting options.void
renderLineSettingsWeightSection(MarkupOutput out)
Generates the HTML output for the line weight setting options.void
renderRightBorderSection(MarkupOutput out)
Displays the interface for allowing the user to modify the right border formatting setting on the currently selected target object(s).protected void
renderSingleBorderLevel(MarkupOutput out, java.lang.String name, java.lang.String label, java.lang.String value, java.lang.String image, boolean selected)
Convenience method, for rendering a border level setting, consisting of a radio button, an image and a legend.protected void
renderSingleBorderSection(MarkupOutput out, java.lang.String currentColor, java.lang.String currentStyle, java.lang.String nameColor, java.lang.String nameStyle, java.lang.String label, boolean includeHiddenInput)
Convenience method, for rendering the settings that can be modified for an individual border, consisting on a label (optional), a combo box with border styles, and a color pickerprotected void
renderSingleBorderSection(MarkupOutput out, java.lang.String currentColor, java.lang.String currentStyle, java.lang.String nameColor, java.lang.String nameStyle, java.lang.String label, boolean includeHiddenInput, ShortcutList picker)
Convenience method, for rendering the settings that can be modified for an individual border, consisting on a label (optional), a combo box with border styles, and a color pickervoid
renderTopBorderSection(MarkupOutput out)
Displays the interface for allowing the user to modify the top border formatting setting on the currently selected target object(s).void
setAllBorderPicker(ShortcutList picker)
Register the all borders picker.void
setBorderColorPicker(ShortcutList picker)
Register the color picker for borders This allows the transform to use a ShortcutList that is not defined inside the pageConfig.void
setBorderPicker(ShortcutList picker)
Register the regular borders picker.void
setColorPicker(ShortcutList picker)
Register the color picker for background, i.e.void
setLineColorPicker(ShortcutList picker)
Register the color picker for lines This allows the transform to use a ShortcutList that is not defined inside the pageConfig.void
setLineStylePicker(ShortcutList picker)
Register the line style picker.-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractTabTransform
addJSValidationInfo, AddJSValidationInfo, addPicker, getArgumentName, getAttributesBody, 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
-
borderStylePickerName
public FormalParameter borderStylePickerName
Indicates the id of a system picker that contains the possible border style options
-
allBorderStylePickerName
public FormalParameter allBorderStylePickerName
Indicates the id of a system picker that contains the possible all border style options
-
lineStylePickerName
public FormalParameter lineStylePickerName
Indicates the id of a system picker that contains the possible line style options
-
colorPickerName
public FormalParameter colorPickerName
Indicates the id of a system picker that contains the possible color options for fill colors
-
borderColorPickerName
public FormalParameter borderColorPickerName
Indicates the id of a system picker that contains the possible color options for borders- Since:
- MicroStrategy Web 8.0.1
-
lineColorPickerName
public FormalParameter lineColorPickerName
Indicates the id of a system picker that contains the possible color options for lines- Since:
- MicroStrategy Web 8.0.1
-
isDocumentProperties
public FormalParameter isDocumentProperties
Indicates whether we are showing the tab for the Document Properties Editor.
-
FP_BORDER_STYLE_PICKER_NAME
public static final java.lang.String FP_BORDER_STYLE_PICKER_NAME
Constant specifying the name of the formal parameter for defining the id of a system picker that contains the list of border options. Value is borderStylePickerName.- See Also:
- Constant Field Values
-
FP_ALL_BORDER_STYLE_PICKER_NAME
public static final java.lang.String FP_ALL_BORDER_STYLE_PICKER_NAME
Constant specifying the name of the formal parameter for defining the id of a system picker that contains the list of all-borders options. Value is allBorderStylePickerName.- See Also:
- Constant Field Values
-
FP_LINE_STYLE_PICKER_NAME
public static final java.lang.String FP_LINE_STYLE_PICKER_NAME
Constant specifying the name of the formal parameter for defining the id of a system picker that contains the list of line options. Value is lineStylePickerName.- 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 background/fill color options. Value is colorPickerId.- See Also:
- Constant Field Values
-
FP_BORDER_COLOR_PICKER_NAME
public static final java.lang.String FP_BORDER_COLOR_PICKER_NAME
Constant specifying the name of the formal parameter for defining the id of a system picker that contains the possible border color options. Value is borderColorPickerId.- Since:
- MicroStrategy Web 8.0.1
- See Also:
- Constant Field Values
-
FP_Line_COLOR_PICKER_NAME
public static final java.lang.String FP_Line_COLOR_PICKER_NAME
Constant specifying the name of the formal parameter for defining the id of a system picker that contains the possible line color options. Value is lineColorPickerId.- Since:
- MicroStrategy Web 8.0.1
- See Also:
- Constant Field Values
-
FP_IS_DOC_PROPS
public static final java.lang.String FP_IS_DOC_PROPS
Constant specifying the name of the formal parameter that determines whether we are showing the tab for the Document Properties Editor.- See Also:
- Constant Field Values
-
-
Method Detail
-
getAttributesFrame
protected java.util.Map getAttributesFrame()
This method return a Map (name/value pairs) of attributes to use for the div enclosing the content of the Tab. These attributes include those required for javascript and formatting (for example, "sty", "ty" and "scriptclass"). Extends the parent method by yet adding one more property that indicates if the current object being targetted is a Document.- Overrides:
getAttributesFrame
in classAbstractTabTransform
- Returns:
- Map with HTML attributes for the body div.
-
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
renderFillSection()
,renderBordersSection()
andrenderLineSettingsSection
.- Specified by:
renderContentsBody
in classAbstractTabTransform
- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
isGridBordersFormattingSelected
protected boolean isGridBordersFormattingSelected()
Returns true if the grid borders are enabled for this bean. This might affect the sections rendered, for example, if the grid borders are enabled, the fill section is not be displayed.- Returns:
- boolean true if the grid borders are enabled.
-
renderFillSection
public void renderFillSection(MarkupOutput out)
Generates the HTML output for the Fill section on this format tab instance. Calls
This method will not generate any content if therenderColorLinesSectionTitle()
andrenderFillColorSection
.isGridBordersFormattingSelected
returns true.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderFillColorSection
public void renderFillColorSection(MarkupOutput out)
Displays the interface for allowing the user to modify the fill color setting on the currently selected target object(s).- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderBordersSection
public void renderBordersSection(MarkupOutput out)
Generates the HTML output for the Borders section on this format tab instance. CallsrenderColorLinesSectionTitle()
,renderBorderLevelsSection()
andrenderBorderSettingsSection
.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderBorderLevelsSection
public void renderBorderLevelsSection(MarkupOutput out)
Displays the interface for allowing the user to modify the level of border formatting setting on the currently selected target object(s).- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderBorderSettingsSection
public void renderBorderSettingsSection(MarkupOutput out)
Displays the interface for allowing the user to customize the border settings on the currently selected target object(s). It assumes a DHTML environment since the different settings for each one of the border levels available will be included as part of the HTML to send to the user, but they will be hidden if their corresponding border level setting is not selected. CallsrenderAllBorderSettingsSection()
andrenderCustomBorderSettingsSection()
. There's no method for the border level ofnone
since nothing is displayed in that case.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderAllBorderSettingsSection
public void renderAllBorderSettingsSection(MarkupOutput out)
Displays the interface for allowing the user to modify the border settings on the currently selected target object(s), when the border level selected is All.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderCustomBorderSettingsSection
public void renderCustomBorderSettingsSection(MarkupOutput out)
Displays the interface for allowing the user to modify the border settings on the currently selected target object(s), when the border level selected is Custom. CallsrenderLeftBorderSection()
,renderRightBorderSection()
,renderTopBorderSection()
andrenderBottomBorderSection()
- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderLeftBorderSection
public void renderLeftBorderSection(MarkupOutput out)
Displays the interface for allowing the user to modify the left border formatting setting on the currently selected target object(s).- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderRightBorderSection
public void renderRightBorderSection(MarkupOutput out)
Displays the interface for allowing the user to modify the right border formatting setting on the currently selected target object(s).- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderTopBorderSection
public void renderTopBorderSection(MarkupOutput out)
Displays the interface for allowing the user to modify the top border formatting setting on the currently selected target object(s).- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderBottomBorderSection
public void renderBottomBorderSection(MarkupOutput out)
Displays the interface for allowing the user to modify the bottom border formatting setting on the currently selected target object(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)
-
getSupportedBeanType
public java.lang.Class getSupportedBeanType()
Returns the supported bean type. This transform supports any of theFormatColorLinesTabBean
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
-
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
-
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
-
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
-
setAllBorderPicker
public void setAllBorderPicker(ShortcutList picker)
Register the all borders picker. This allows the transform to use a ShortcutList that is not defined inside the pageConfig.
- Parameters:
picker
- The allBorderPicker to set.
-
getAllBorderPicker
public ShortcutList getAllBorderPicker()
Returns the all-borders-style picker. If a non-null instance have been registered through thesetAllBorderPicker
method, it will return that one, otherwise, it will search for a system picker with the name specified inFP_ALL_BORDER_STYLE_PICKER_NAME
.- Returns:
- ShortcutList to use for the line-style picker.
-
setBorderPicker
public void setBorderPicker(ShortcutList picker)
Register the regular borders picker. This allows the transform to use a ShortcutList that is not defined inside the pageConfig.
- Parameters:
picker
- The borderPicker to set.
-
getBorderPicker
public ShortcutList getBorderPicker()
Returns the border picker. If a non-null instance have been registered through thesetBorderPicker
method, it will return that one, otherwise, it will search for a system picker with the name specified inFP_BORDER_PICKER_NAME
.- Returns:
- ShortcutList to use for the line-style picker.
-
setColorPicker
public void setColorPicker(ShortcutList picker)
Register the color picker for background, i.e. Fill color This allows the transform to use a ShortcutList that is not defined inside the pageConfig.
- Parameters:
picker
- The colorPicker to set.
-
setBorderColorPicker
public void setBorderColorPicker(ShortcutList picker)
Register the color picker for borders This allows the transform to use a ShortcutList that is not defined inside the pageConfig.
- Parameters:
picker
- The borderColorPicker to set.- Since:
- MicroStrategy Web 8.0.1
-
setLineColorPicker
public void setLineColorPicker(ShortcutList picker)
Register the color picker for lines This allows the transform to use a ShortcutList that is not defined inside the pageConfig.
- Parameters:
picker
- The lineColorPicker to set.- Since:
- MicroStrategy Web 8.0.1
-
getColorPicker
public ShortcutList getColorPicker()
Returns the background 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.
-
getBorderColorPicker
public ShortcutList getBorderColorPicker()
Returns the border color picker. If a non-null instance have been registered through thesetBorderColorPicker
method, it will return that one, otherwise, it will search for a system picker with the name specified inFP_BORDER_COLOR_PICKER_NAME
.- Returns:
- ShortcutList to use for the border color-picker.
- Since:
- MicroStrategy Web 8.0.1
-
getLineColorPicker
public ShortcutList getLineColorPicker()
Returns the line color picker. If a non-null instance have been registered through thesetLineColorPicker
method, it will return that one, otherwise, it will search for a system picker with the name specified inFP_LINE_COLOR_PICKER_NAME
.- Returns:
- ShortcutList to use for the line-color-picker.
- Since:
- MicroStrategy Web 8.0.1
-
setLineStylePicker
public void setLineStylePicker(ShortcutList picker)
Register the line style picker. This allows the transform to use a ShortcutList that is not defined inside the pageConfig.
- Parameters:
picker
- The lineStylePicker to set.
-
getLineStylePicker
public ShortcutList getLineStylePicker()
Returns the line style picker. If a non-null instance have been registered through thesetLineStylePicker
method, it will return that one, otherwise, it will search for a system picker with the name specified inFP_LINE_STYLE_PICKER_NAME
.- Returns:
- ShortcutList to use for the line-style picker.
-
renderSingleBorderLevel
protected void renderSingleBorderLevel(MarkupOutput out, java.lang.String name, java.lang.String label, java.lang.String value, java.lang.String image, boolean selected)
Convenience method, for rendering a border level setting, consisting of a radio button, an image and a legend.- Parameters:
out
-MarkupOutput
instance where the HTML generated will be savedname
- String with the name of the control to generatelabel
- String with the text of the label to display next to the controlvalue
- String with the value the control will have if selectedimage
- String with the location of the image to display next to the option generated.selected
- boolean
-
renderSingleBorderSection
protected void renderSingleBorderSection(MarkupOutput out, java.lang.String currentColor, java.lang.String currentStyle, java.lang.String nameColor, java.lang.String nameStyle, java.lang.String label, boolean includeHiddenInput)
Convenience method, for rendering the settings that can be modified for an individual border, consisting on a label (optional), a combo box with border styles, and a color picker- Parameters:
out
-MarkupOutput
instance where the HTML generated will be saved.currentColor
- String with the value of the current color selectedcurrentStyle
- String with the value of the current style selectednameColor
- String with the name the color control will havenameStyle
- String with the name the style control will havelabel
- String with the text to be displayed next to the controlincludeHiddenInput
- boolean value indicating if hidden inputs will be added to the final contents or not.
-
renderSingleBorderSection
protected void renderSingleBorderSection(MarkupOutput out, java.lang.String currentColor, java.lang.String currentStyle, java.lang.String nameColor, java.lang.String nameStyle, java.lang.String label, boolean includeHiddenInput, ShortcutList picker)
Convenience method, for rendering the settings that can be modified for an individual border, consisting on a label (optional), a combo box with border styles, and a color picker- Parameters:
out
-MarkupOutput
instance where the HTML generated will be saved.currentColor
- String with the value of the current color selectedcurrentStyle
- String with the value of the current style selectednameColor
- String with the name the color control will havenameStyle
- String with the name the style control will havelabel
- String with the text to be displayed next to the controlincludeHiddenInput
- boolean value indicating if hidden inputs will be added to thepicker
-ShortcutList
instance with the different options to be displayed for style. Color picker options will come from thegetColorPicker()
method.
-
renderLineSettingsSection
public void renderLineSettingsSection(MarkupOutput out)
Generates the HTML output for the line settings section on this format tab instance. Calls
This method will not generate any content if therenderLineSettingsStyleSection()
,renderLineSettingsColorSection
andrenderLineSettingsWeightSection
.isGridBordersFormattingSelected
returns true.- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderLineSettingsStyleSection
public void renderLineSettingsStyleSection(MarkupOutput out)
Generates the HTML output for the line style setting options.
- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderLineSettingsColorSection
public void renderLineSettingsColorSection(MarkupOutput out)
Generates the HTML output for the line color setting options.
- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
renderLineSettingsWeightSection
public void renderLineSettingsWeightSection(MarkupOutput out)
Generates the HTML output for the line weight setting options.
- Parameters:
out
-MarkupOutput
instance where the HTML contents to render will be saved.
-
-