public class

FormatEditorTabManagerTransform

extends TabManagerTransform
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.TabManagerTransform
             ↳ com.microstrategy.web.app.transforms.FormatEditorTabManagerTransform

Class Overview

This transform takes care of rendering FormatTabManagerBean instances, overwritting the original TabManagerTransform implementation by allowing all the available children to render their HTML tab contents, and hiding with css styles and JavaScript all but the one currently selected by the user.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.TabManagerTransform
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.TabManagerTransform
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
FormatEditorTabManagerTransform()
Public Methods
String getDescription()
Returns the textual description of the transform
Class getSupportedBeanType()
Returns the supported bean type.
FormatTabManagerBean getTabManagerBean()
Get the FormatTabManagerBean instance being transformed
void initializeTransform(Transformable data)
Initializes transform formal parameters
void renderControlBar(MarkupOutput out)
Renders the tab control HTML for being able to switch from one TabBean child tab to another.
void renderGridZones(MarkupOutput out)
Render the drop downs for the grid zone object and zone selector.
void renderPanelStackZones(MarkupOutput out)
Render the drop downs for the grid zone object and zone selector.
Protected Methods
void initEditor(Editor editor)
Initialize the editor with the global settings.
boolean isAllMetricsSelected()
Utility method for checking if the All Metrics target has been selected.
void renderJavascript(MarkupOutput out)
Generate the JavaScript code required by this editor manager for the proper behavior on the client.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.TabManagerTransform
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.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Public Constructors

public FormatEditorTabManagerTransform ()

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 transform supports FormatTabManagerBean instances

Returns
  • the class of the bean supported by this transform.

public FormatTabManagerBean getTabManagerBean ()

Get the FormatTabManagerBean instance being transformed

Returns

public void initializeTransform (Transformable data)

Initializes transform formal parameters

Parameters
data the bean being transformed by this class

public void renderControlBar (MarkupOutput out)

Renders the tab control HTML for being able to switch from one TabBean child tab to another. Generates an HTML table for holding the different TabBean titles of the tabs that are available for this TabManagerBean instance. Calls for the renderGridZones(MarkupOutput) method in case the editor is targetting a grid.

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

public void renderGridZones (MarkupOutput out)

Render the drop downs for the grid zone object and zone selector.

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

public void renderPanelStackZones (MarkupOutput out)

Render the drop downs for the grid zone object and zone selector.

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

Protected Methods

protected void initEditor (Editor editor)

Initialize the editor with the global settings. Extends the parent method by indicating a special Apply label in case the editor is targetting a grid.

Parameters
editor Editor instance to initialize according to the information to be displayed by this transform

protected boolean isAllMetricsSelected ()

Utility method for checking if the All Metrics target has been selected. If the user requests the "Metrics" field to be formatted it will go in as an axis,position location as if it were a regular template unit. The transform does not handle All Metrics like this since it uses other values, so this method maps these two and determines if All Metrics is actually being selected.

Returns
  • boolean indicating if All Metrics is currently selected by the user as target position for the editor.

protected void renderJavascript (MarkupOutput out)

Generate the JavaScript code required by this editor manager for the proper behavior on the client. Extends the parent method by adding extra property values needed for handling the current selected target if a grid is selected for formatting.

Parameters
out MarkupOutput instance where the HTML output will be saved.