public class

TabManagerTransform

extends AbstractEditorTransform
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.AbstractEditorTransform
           ↳ com.microstrategy.web.app.transforms.TabManagerTransform
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

This transform can be used as base for the transforms that will take care of rendering TabManagerBean instances. It considers the final output to be divided in these sections:

    TabManagerFrame / TabManagerFrameBody
     -------------------------------------
     |  Title / TitleBody                |
     -------------------------------------
     |  ControlBar / ControlBarBody      |
     |-----------------------------------|
     |  Contents / ContentsBody          |
     |                                   |
     |                                   |
     |                                   |
     |                                   |
     -------------------------------------
 
Therefore, there will exist the following methods for defining each one of the HTML contents of the sections:
 renderTabManagerFrame
  - renderTabManagerFrameBody
    + renderTabManagerTitle
      = renderTabManagerTitleBody
    + renderTabManagerContents
      = renderTabManagerContentsBody
        > renderTabManagerControlBar
          * renderTabManagerControlBarBody
        > renderTabManagerTabContainer
          * renderTabManagerTabContainerBody
 
The methods like renderTabManagerFrame, renderContents, etc take care of generating the HTML that will serve as a container or frame of the body of these different sections (for keeping formatting on the contents to display) then, they call their respective Body methods for obtaining the HTML that will be the most visible to the user.
These methods can be customized in children transforms or with formal parameters for achieving the desired results.

Summary

Constants
String FP_AUTO_SUBMIT_JS Constant specifying the script to invoke when editor need to submit changes automatically.
String FP_HIDE_UNAVAILABLE Used by formal parameter hideUnavailable.
String FP_IGNORE_SINGLE_TAB constant specifying the name of the render single tab property.
String FP_PRIMARY_BONE Constant specifying the name of the primpary bone property.
String FP_TAB_HEIGHT Constant specifying the name of the formal parameter for specifying the height of the tabs on the editor
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected TabManagerBean _tabManagerBean
public FormalParameter autoSubmitJS Indicates the script to invoke when editor need to submit changes automatically.
public FormalParameter hideUnavailable Determine whether not available tabs should be hidden.
public FormalParameter ignoreSingleTab Indicates whether to render a single tab or not
public FormalParameter primaryBone Inidicates wehther the eidtor is going to be primary bone or not
public FormalParameter tabHeight Indicates the height of the tabs on the editor.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
TabManagerTransform()
Default no-argument constructor.
Public Methods
String getDescription()
Returns the textual description of the transform
Class getSupportedBeanType()
Returns the supported bean type.
void initializeTransform(Transformable data)
Initializes transform formal parameters
void renderChildrenTabBody(MarkupOutput out)
Renders each of the TabBeans that are part of the TabManagerBean.
void renderControlBar(MarkupOutput out)
Renders the tab control HTML for being able to switch from one TabBean child tab to another.
void renderCurrentTabBody(MarkupOutput out)
void renderEditorContents(MarkupOutput out)
Transforms the assosciated TabManagerBean when its status is WebBeanRequestSuccessful.
void renderTabContainerBody(MarkupOutput out)
Generates the HTML that represents the body of the TabManagerBean instance being rendered, consisting on all the current available TabBean instances.
void renderTabManagerControlBarBody(MarkupOutput out)
Generates a table row with individual cells corresponding to each one of the TabBean child tab titles that are available to the user.
void transformForRequestSuccessful(MarkupOutput out)
Generates the graphical output for the Projects Bean
Protected Methods
String getCurrentTabName()
Obtains the Id/Name of the tab currently selected
String getTitleForChildTab(TabBean bean)
Obtain the title to use for the given child TabBean, based on its titleId or titleDescription properties
void initHelp(Editor editor)
void renderJavascript(MarkupOutput out)
Generate the JavaScript code required by this editor manager for the proper behavior on the client.
void setAttributesTabSetContainer(Tag tabSetContainer)
void setTabSetStyle(Tag tabSetContainer)
[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.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Constants

public static final String FP_AUTO_SUBMIT_JS

Constant specifying the script to invoke when editor need to submit changes automatically.

Constant Value: "autoSubmitJS"

public static final String FP_HIDE_UNAVAILABLE

Used by formal parameter hideUnavailable.

Constant Value: "hideUnavailable"

public static final String FP_IGNORE_SINGLE_TAB

constant specifying the name of the render single tab property.

Constant Value: "ignoreSingleTab"

public static final String FP_PRIMARY_BONE

Constant specifying the name of the primpary bone property.

Constant Value: "primaryBone"

public static final String FP_TAB_HEIGHT

Constant specifying the name of the formal parameter for specifying the height of the tabs on the editor

Constant Value: "tabHeight"

Fields

protected TabManagerBean _tabManagerBean

public FormalParameter autoSubmitJS

Indicates the script to invoke when editor need to submit changes automatically.

public FormalParameter hideUnavailable

Determine whether not available tabs should be hidden. Default to false.

public FormalParameter ignoreSingleTab

Indicates whether to render a single tab or not

public FormalParameter primaryBone

Inidicates wehther the eidtor is going to be primary bone or not

public FormalParameter tabHeight

Indicates the height of the tabs on the editor.

Public Constructors

public TabManagerTransform ()

Default no-argument constructor. Initializes formal parameters.

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 TabManagerBean instances

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

public void initializeTransform (Transformable data)

Initializes transform formal parameters

Parameters
data the bean being transformed by this class

public void renderChildrenTabBody (MarkupOutput out)

Renders each of the TabBeans that are part of the TabManagerBean. Loops through the list of child TabBeans and renders their output.

Parameters
out MarkupOutput

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 renderTabManagerControlBarBody

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

public void renderCurrentTabBody (MarkupOutput out)

public void renderEditorContents (MarkupOutput out)

Transforms the assosciated TabManagerBean when its status is WebBeanRequestSuccessful. Calls renderTabManagerFrame()

Parameters
out MarkupOutput instance where to create the HTML output

public void renderTabContainerBody (MarkupOutput out)

Generates the HTML that represents the body of the TabManagerBean instance being rendered, consisting on all the current available TabBean instances. HTML contents of the individual TabBean instances will then be hidden with css styles and JavaScript, for only showing one at the time (the currently selected by the user).

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

public void renderTabManagerControlBarBody (MarkupOutput out)

Generates a table row with individual cells corresponding to each one of the TabBean child tab titles that are available to the user.

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

public void transformForRequestSuccessful (MarkupOutput out)

Generates the graphical output for the Projects Bean

Parameters
out MarkupOutputinstance where to create the HTML output

Protected Methods

protected String getCurrentTabName ()

Obtains the Id/Name of the tab currently selected

Returns
  • null if not found...

protected String getTitleForChildTab (TabBean bean)

Obtain the title to use for the given child TabBean, based on its titleId or titleDescription properties

Parameters
bean TabBean instance from where its title will be obtained
Returns
  • String value with the title to use on the tab control for the given TabBean instance.

protected void initHelp (Editor 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 as well as the required library for it to work properly.

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

protected void setAttributesTabSetContainer (Tag tabSetContainer)

protected void setTabSetStyle (Tag tabSetContainer)