public class

ColorPickerEditorTransform

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.ColorPickerEditorTransform

Class Overview

This transform renders the color picker editor transform.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public FormalParameter pickerName Indicates the name of a toolbar defined in the pageConfig that contains the color picker basic colors.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
ColorPickerEditorTransform()
Default constructor.
Public Methods
String getDescription()
Returns the textual description of the transform
Class getSupportedBeanType()
Returns the supported bean type.
void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.
void renderEditorContents(MarkupOutput out)
Generates the graphical output for the Editor
Protected Methods
Tag generateAdvancedColors()
Renders the advanced colors section of color picker editor.
Tag generateBasicColors()
Renders the basic colors section of color picker editor.
Tag generateColorPane(int[] colors)
Renders an individual color pane.
Tag generateSmoothColorBox()
Renders the smooth color picker box.
Tag generateSmoothColorSlider()
Renders the smooth color slider.
Tag generateUserColors()
Renders the user palette colors section of color picker editor.
[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

Fields

public FormalParameter pickerName

Indicates the name of a toolbar defined in the pageConfig that contains the color picker basic colors. Comment for pickerName

Public Constructors

public ColorPickerEditorTransform ()

Default constructor. Adds the formal parameters defined in the transform.

Public Methods

public String getDescription ()

Returns the textual description of the transform

Returns
  • the description of the transform

public Class getSupportedBeanType ()

Returns the supported bean type. This abstract Transform supports all WebComponents so every sub-class should override this method to return the class of the Bean the Transform is expecting, for example:

 public class CustomReportClass extends AbstractAppTransform {

    public Class getSupportedBeanType() {
        //This Transform is expected to work only with a ReportBean,
        //therefore this method needs to return this class:
        return ReportBean.class;
    }

 }
 

Returns
  • a root class/interface supported by this 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 renderEditorContents (MarkupOutput out)

Generates the graphical output for the Editor

Parameters
out MarkupOutput instance where to create the HTML output

Protected Methods

protected Tag generateAdvancedColors ()

Renders the advanced colors section of color picker editor.

Returns
  • a div tag containing the advanced colors

protected Tag generateBasicColors ()

Renders the basic colors section of color picker editor.

Returns
  • a span tag containing the basic colors

protected Tag generateColorPane (int[] colors)

Renders an individual color pane.

Parameters
colors int[] an integer array holding the red, green and blue components of the color to display.
Returns
  • an empty span tag with the background color set.

protected Tag generateSmoothColorBox ()

Renders the smooth color picker box.

Returns
  • a span tag containing the smaller color panes

protected Tag generateSmoothColorSlider ()

Renders the smooth color slider.

Returns
  • a span tag containing the slider

protected Tag generateUserColors ()

Renders the user palette colors section of color picker editor.

Returns
  • a span tag containing the user palette colors