public abstract class

AbstractColorGradientEditorTransform

extends AbstractEditorTransform
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
Known Direct Subclasses

Summary

Constants
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.
String PROPERTY_ANGLE
String PROPERTY_SHADING_STYLE
String PROPERTY_TRANSITION_TYPE
String PROPERTY_XOFFSET
String PROPERTY_YOFFSET
String SHADING_STYLE_CUSTOM
String SHADING_STYLE_DIAGONALDOWN
String SHADING_STYLE_DIAGONALUP
String SHADING_STYLE_FROMCENTER
String SHADING_STYLE_FROMCORNER
String SHADING_STYLE_HORIZONTAL
String SHADING_STYLE_VERTICAL
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected int _angle
protected String _color1
protected String _color2
protected int _currentPreview
protected int _shadingStyle
protected int _transitionType
protected int _xOffset
protected int _yOffset
public FormalParameter colorPickerName Indicates the id of a system picker that contains the possible color options
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
AbstractColorGradientEditorTransform()
Public Methods
ShortcutList getColorPicker()
This method returns a ShortcutList representing the color picker.
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, String cmdId, String cmdValue, ShortcutList picker)
This method renders dropdown for color selections.
void renderEditorContents(MarkupOutput out)
This is the main entry to render the editor content.
Protected Methods
abstract void getCurrentGradientValues()
void renderColorPicker(MarkupOutput out)
This method renders the HTML content of the color picker.
void renderCustomShadingSection(MarkupOutput out)
This method renders the custom shading section.
abstract void renderShadingStylesSection(MarkupOutput out)
void renderSingleShadingStyle(MarkupOutput out, String label, String value, boolean selected)
This method renders a input radio button for a single shading style.
void renderVariantsSection(MarkupOutput out)
This method renders the variants section.
void setBoneProperties()
This method sets the bone properties for the corresponding bone.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.transform.Transform

Constants

public static final 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.

Constant Value: "colorPickerName"

protected static final String PROPERTY_ANGLE

Constant Value: "angle"

protected static final String PROPERTY_SHADING_STYLE

Constant Value: "shadingStyle"

protected static final String PROPERTY_TRANSITION_TYPE

Constant Value: "transitionType"

protected static final String PROPERTY_XOFFSET

Constant Value: "xOffset"

protected static final String PROPERTY_YOFFSET

Constant Value: "yOffset"

protected static final String SHADING_STYLE_CUSTOM

Constant Value: "Custom"

protected static final String SHADING_STYLE_DIAGONALDOWN

Constant Value: "DiagonalDown"

protected static final String SHADING_STYLE_DIAGONALUP

Constant Value: "DiagonalUp"

protected static final String SHADING_STYLE_FROMCENTER

Constant Value: "FromCenter"

protected static final String SHADING_STYLE_FROMCORNER

Constant Value: "FromCorner"

protected static final String SHADING_STYLE_HORIZONTAL

Constant Value: "Horizontal"

protected static final String SHADING_STYLE_VERTICAL

Constant Value: "Vertical"

Fields

protected int _angle

protected String _color1

protected String _color2

protected int _currentPreview

protected int _shadingStyle

protected int _transitionType

protected int _xOffset

protected int _yOffset

public FormalParameter colorPickerName

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

Public Constructors

public AbstractColorGradientEditorTransform ()

Public Methods

public ShortcutList getColorPicker ()

This method returns a ShortcutList representing the color picker.

Returns
  • a ShortcutList of color picker.

public String getDescription ()

This method returns the description of the transform.

public void initializeTransform (Transformable data)

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

Parameters
data Transformable instance to be transformed.

public void renderColorDropdown (MarkupOutput out, String cmdId, 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.

public void renderEditorContents (MarkupOutput out)

This is the main entry to render the editor content.

Parameters
out MarkupOutput instance where to create the HTML output

Protected Methods

protected abstract void getCurrentGradientValues ()

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.

protected void renderCustomShadingSection (MarkupOutput out)

This method renders the custom shading section.

Parameters
out a MarkupOutput to where the content is rendered.

protected abstract void renderShadingStylesSection (MarkupOutput out)

protected void renderSingleShadingStyle (MarkupOutput out, String label, 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.

protected void renderVariantsSection (MarkupOutput out)

This method renders the variants section.

Parameters
out a MarkupOutput to which the content is rendered.

protected void setBoneProperties ()

This method sets the bone properties for the corresponding bone.