Package com.microstrategy.web.app.transforms

Class AbstractColorGradientEditorTransform

java.lang.Object

com.microstrategy.web.transform.AbstractTransform

com.microstrategy.web.transform.AbstractLayoutTransform

com.microstrategy.web.app.transforms.AbstractAppTransform

com.microstrategy.web.app.transforms.AbstractEditorTransform

com.microstrategy.web.app.transforms.AbstractColorGradientEditorTransform

All Implemented Interfaces:

AppTransform, Transform

Direct Known Subclasses:

ColorGradientEditorTransform, RWDColorGradientEditorTransform

public abstract class AbstractColorGradientEditorTransform
extends AbstractEditorTransform

Since:

MicroStrategy Web 8.1.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 int	_angle
protected java.lang.String	_color1
protected java.lang.String	_color2
protected int	_currentPreview
protected int	_shadingStyle
protected int	_transitionType
protected int	_xOffset
protected int	_yOffset
FormalParameter	colorPickerName	Indicates the id of a system picker that contains the possible color 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 color options.
protected static java.lang.String	PROPERTY_ANGLE
protected static java.lang.String	PROPERTY_SHADING_STYLE
protected static java.lang.String	PROPERTY_TRANSITION_TYPE
protected static java.lang.String	PROPERTY_XOFFSET
protected static java.lang.String	PROPERTY_YOFFSET
protected static java.lang.String	SHADING_STYLE_CUSTOM
protected static java.lang.String	SHADING_STYLE_DIAGONALDOWN
protected static java.lang.String	SHADING_STYLE_DIAGONALUP
protected static java.lang.String	SHADING_STYLE_FROMCENTER
protected static java.lang.String	SHADING_STYLE_FROMCORNER
protected static java.lang.String	SHADING_STYLE_HORIZONTAL
protected static java.lang.String	SHADING_STYLE_VERTICAL

Fields inherited from class com.microstrategy.web.app.transforms.AbstractEditorTransform

_helpTopic, _helpType, applyJS, applyLabel, applyLabelID, canAutoSize, cancelJS, cancelLabel, cancelLabelID, closeEvent, closeImage, closeJS, closeLabel, closeLabelID, dhtmlClose, disableOKButton, editorContentsStyle, editorElements, editorLayoutFile, editorSubType, FP_APPLY_JS, FP_APPLY_LABEL, FP_APPLY_LABEL_ID, FP_CAN_AUTO_SIZE, FP_CANCEL_JS, FP_CANCEL_LABEL, FP_CANCEL_LABEL_ID, FP_CLOSE_EVENT, FP_CLOSE_IMAGE, FP_CLOSE_JS, FP_CLOSE_LABEL, FP_CLOSE_LABEL_ID, FP_DHTML_CLOSE, FP_DISABLE_OK_BUTTON, FP_EDITOR_CONTENTS_STYLE, FP_EDITOR_ELEMENTS, FP_EDITOR_LAYOUT_FILE, FP_EDITOR_SUBTYPE, FP_HELP_PAGE, FP_HELP_TOPIC, FP_HELP_TYPE, FP_INCLUDE_DYNAMIC_SCRIPT, FP_NAVIGATE_ON_SUBMIT, FP_OK_JS, FP_OK_LABEL, FP_OK_LABEL_ID, FP_RENDER_FORM, FP_TITLE_LABEL, FP_TITLE_LABEL_ID, FP_USE_JS_IN_BONE, helpPage, helpTopic, helpType, includeDynamicScript, navigateOnSubmit, okJS, okLabel, okLabelID, renderForm, titleLabel, titleLabelID

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
AbstractColorGradientEditorTransform()

Method Summary

Modifier and Type	Method	Description
ShortcutList	getColorPicker()	This method returns a ShortcutList representing the color picker.
protected abstract void	getCurrentGradientValues()
java.lang.String	getDescription()	This method returns the description of the transform.
void	initializeTransform(Transformable data)	This method initialize the private and protected fields of the transform.
void	renderColorDropdown(MarkupOutput out, java.lang.String cmdId, java.lang.String cmdValue, ShortcutList picker)	This method renders dropdown for color selections.
protected void	renderColorPicker(MarkupOutput out)	This method renders the HTML content of the color picker.
protected void	renderCustomShadingSection(MarkupOutput out)	This method renders the custom shading section.
void	renderEditorContents(MarkupOutput out)	This is the main entry to render the editor content.
protected abstract void	renderShadingStylesSection(MarkupOutput out)
protected void	renderSingleShadingStyle(MarkupOutput out, java.lang.String label, java.lang.String value, boolean selected)	This method renders a input radio button for a single shading style.
protected void	renderVariantsSection(MarkupOutput out)	This method renders the variants section.
protected void	setBoneProperties()	This method sets the bone properties for the corresponding bone.

Methods inherited from class com.microstrategy.web.app.transforms.AbstractEditorTransform

generateForm, getDivTagAroundContents, getEditorTitle, getOnSubmitJS, getWebBeanErrorInfo, initEditor, initHelp, renderEditor, renderEditorElement, renderJavascript, setFocusFieldId, transformForRequestInError, 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, getArgumentName, 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, getSupportedBeanType, getTagsFactory, getTimeFormat, getUnitsLabel, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, initializeImages, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, 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, 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.Transform

canTransform, getFormalParams, getPreview, isPreviewAvailable, isResolved, supports, supports

Field Detail

_color1

protected java.lang.String _color1

_color2

protected java.lang.String _color2

_transitionType

protected int _transitionType

_shadingStyle

protected int _shadingStyle

_angle

protected int _angle

_xOffset

protected int _xOffset

_yOffset

protected int _yOffset

_currentPreview

protected int _currentPreview

colorPickerName

public FormalParameter colorPickerName

Indicates the id of a system picker that contains the possible color options

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

PROPERTY_SHADING_STYLE

protected static final java.lang.String PROPERTY_SHADING_STYLE

See Also:

Constant Field Values

PROPERTY_TRANSITION_TYPE

protected static final java.lang.String PROPERTY_TRANSITION_TYPE

See Also:

Constant Field Values

PROPERTY_ANGLE

protected static final java.lang.String PROPERTY_ANGLE

See Also:

Constant Field Values

PROPERTY_XOFFSET

protected static final java.lang.String PROPERTY_XOFFSET

See Also:

Constant Field Values

PROPERTY_YOFFSET

protected static final java.lang.String PROPERTY_YOFFSET

See Also:

Constant Field Values

SHADING_STYLE_HORIZONTAL

protected static final java.lang.String SHADING_STYLE_HORIZONTAL

See Also:

Constant Field Values

SHADING_STYLE_VERTICAL

protected static final java.lang.String SHADING_STYLE_VERTICAL

See Also:

Constant Field Values

SHADING_STYLE_DIAGONALUP

protected static final java.lang.String SHADING_STYLE_DIAGONALUP

See Also:

Constant Field Values

SHADING_STYLE_DIAGONALDOWN

protected static final java.lang.String SHADING_STYLE_DIAGONALDOWN

See Also:

Constant Field Values

SHADING_STYLE_FROMCORNER

protected static final java.lang.String SHADING_STYLE_FROMCORNER

See Also:

Constant Field Values

SHADING_STYLE_FROMCENTER

protected static final java.lang.String SHADING_STYLE_FROMCENTER

See Also:

Constant Field Values

SHADING_STYLE_CUSTOM

protected static final java.lang.String SHADING_STYLE_CUSTOM

See Also:

Constant Field Values

Constructor Detail

AbstractColorGradientEditorTransform

public AbstractColorGradientEditorTransform()

Method Detail

initializeTransform

public void initializeTransform(Transformable data)

This method initialize the private and protected fields of the transform.

Specified by:

initializeTransform in interface AppTransform

Overrides:

initializeTransform in class AbstractEditorTransform

Parameters:

data - Transformable instance to be transformed.

setBoneProperties

protected void setBoneProperties()

This method sets the bone properties for the corresponding bone.

renderEditorContents

public void renderEditorContents(MarkupOutput out)

This is the main entry to render the editor content.

Specified by:

renderEditorContents in class AbstractEditorTransform

Parameters:

out - MarkupOutput instance where to create the HTML output

getDescription

public java.lang.String getDescription()

This method returns the description of the transform.

Returns:

The textual description of the transform.

renderSingleShadingStyle

protected void renderSingleShadingStyle(MarkupOutput out,
                                        java.lang.String label,
                                        java.lang.String value,
                                        boolean selected)

This method renders a input radio button for a single shading style.

Parameters:

out - a MarkupOutput to which the HTML content is rendered to.

label - a String representing the label of the shadding style.

value - a String representing the value of the shadding style.

selected - a boolean indicating whether the radio button is selected.

renderColorDropdown

public void renderColorDropdown(MarkupOutput out,
                                java.lang.String cmdId,
                                java.lang.String cmdValue,
                                ShortcutList picker)

This method renders dropdown for color selections.

Parameters:

out - a MarkupOutput object to which the HTML content is rendered.

cmdId - a String representing the command ID of the dropdown.

cmdValue - a String representing the command value of the dropdown.

picker - a ShortcutList representing the list of color available for selection.

renderColorPicker

protected void renderColorPicker(MarkupOutput out)

This method renders the HTML content of the color picker.

Parameters:

out - a MarkupOutput to which the content is renderd.

getColorPicker

public ShortcutList getColorPicker()

This method returns a ShortcutList representing the color picker.

Returns:

a ShortcutList of color picker.

renderCustomShadingSection

protected void renderCustomShadingSection(MarkupOutput out)

This method renders the custom shading section.

Parameters:

out - a MarkupOutput to where the content is rendered.

renderVariantsSection

protected void renderVariantsSection(MarkupOutput out)

This method renders the variants section.

Parameters:

out - a MarkupOutput to which the content is rendered.

getCurrentGradientValues

protected abstract void getCurrentGradientValues()

renderShadingStylesSection

protected abstract void renderShadingStylesSection(MarkupOutput out)