public class

TabLayoutTransform

extends AbstractTabTransform
implements LayoutTransform
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.TabLayoutTransform

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 background/fill color options.
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractTabTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public FormalParameter colorPickerName Indicates the id of a system picker that contains the possible color options for fill colors
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractTabTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
TabLayoutTransform()
Public Methods
ShortcutList getColorPicker()
Returns the background color picker.
void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.
void renderContentsBody(MarkupOutput out)
Method that renders the main contents of the transform, according to the information available on the bean.
void renderTabColorSection(MarkupOutput out)
Displays the interface for allowing the user to modify the fill color setting on the currently selected tab.
void setColorPicker(ShortcutList picker)

Register the color picker for background, i.e.

Protected Methods
void renderMasterPageHeaderFooterSection(MarkupOutput out)
Generates the HTML output for the master page header/footer in the layout editor tab.
void renderNameSection(MarkupOutput out)
Generates the HTML output for the Name of the object in the layout editor tab.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractTabTransform
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.LayoutTransform
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 background/fill color options. Value is colorPickerId.

Constant Value: "colorPickerName"

Fields

public FormalParameter colorPickerName

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

Public Constructors

public TabLayoutTransform ()

Public Methods

public ShortcutList getColorPicker ()

Returns the background color picker. If a non-null instance have been registered through the setColorPicker method, it will return that one, otherwise, it will search for a system picker with the name specified in FP_COLOR_PICKER_NAME.

Returns
  • ShortcutList to use for the color-picker.

public void initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform. In particular it invokes the initializeJavaScriptAttribute() method.

Parameters
data Transformable instance to be transformed.

public void renderContentsBody (MarkupOutput out)

Method that renders the main contents of the transform, according to the information available on the bean. This method can be customized if users would like to obtain a different output for the same given bean.

Parameters
out MarkupOutput instance where the HTML contents to render will be saved.

public void renderTabColorSection (MarkupOutput out)

Displays the interface for allowing the user to modify the fill color setting on the currently selected tab.

Parameters
out MarkupOutput instance where the HTML contents to render will be saved.

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.

Protected Methods

protected void renderMasterPageHeaderFooterSection (MarkupOutput out)

Generates the HTML output for the master page header/footer in the layout editor tab.

Parameters
out MarkupOutput instance where the HTML contents to render will be saved.

protected void renderNameSection (MarkupOutput out)

Generates the HTML output for the Name of the object in the layout editor tab.

Parameters
out MarkupOutput instance where the HTML contents to render will be saved.