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

AccordionTabManagerTransform, DerivedElementFormatEditorTransform, FormatEditorTabManagerTransform, HelpOnCBTabManagerTransform, ObjectBrowserManagerTransform, SubtotalsEditorTabManagerTransform, ThresholdsFormatEditorTransform, TreeTabManagerTransform

Known Indirect Subclasses

PromptEditorTabManagerTransform

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

protected final String	CLASS_INPUT	This field is deprecated. This property is not used anymore by the transform.
protected final String	CLASS_MESSAGE	This field is deprecated. This property is not used anymore by the transform.
protected WebComponent	_bean	Instance of `WebComponent` being transformed.
protected ComponentBlock	_componentBlock
protected String	_cssPrefix	Property corresponding to the value of the `cssPrefix` formal parameter
protected String	_imgBlank	Field that containts the URL location of a blank image (used as the source of most <IMG> tags as the real URL is specified through css).
protected String	_imgWait	This field is deprecated. This value is not used anymore by the Transform as the wait image is included using css.
protected MarkupOutput	_selfOutput	This field is deprecated. this field is no longer used since partial update blocks are now generated via `ComponentBlock`
protected MarkupOutput	_subOutput	This field is deprecated. this field is no longer used since partial update blocks are now generated via `ComponentBlock`
public FormalParameter	appliesTo	This parameter informs the javascript the id of the bone the actions of this component applies to.
public FormalParameter	contextMenus	This formal parameter is used by the Transform to identify the context-menus definition.
public FormalParameter	cssFile	CSS file that includes the style definition.
public FormalParameter	cssPrefix	Prefix to append to all css class names.
public FormalParameter	debugErrorFlags	Indicates which extra debug information to include in case of an error.
public FormalParameter	debugFlags	Indicates which debug information to include.
public FormalParameter	dragMode	Indicates the drag mode that the component to render will have.
public FormalParameter	extraInput	Indicates any extra inputs to be included in the forms generated by the transform.
public FormalParameter	extraUrl	Indicates any extra parameters to be included in the links generated by the transform.
public FormalParameter	globalCssErrorMessage	This field is deprecated. The css class to use cannot be controlled through a formal parameter anymore.
public FormalParameter	globalCssErrorTitle	This field is deprecated. The css class to use cannot be controlled through a formal parameter anymore.
public FormalParameter	height	Indicates the default height of the component.
public FormalParameter	iframeEnabled	Indicates whether the transform supports iframe manipulations.
public FormalParameter	imgWait	This field is deprecated. This value is not used anymore by the Transform as the wait image is included using css.
protected int	indent	This field is deprecated. Indentation is not appended by Transforms anymore. Although it provided a somewhat better looking HTML source, it also affected performance by increasing the HTML size.
public FormalParameter	initialIndent	This field is deprecated. Indentation is not appended by Transforms anymore. Although it provided a somewhat better looking HTML source, it also affected performance by increasing the HTML size.
protected boolean	isDHTML	This field is deprecated. Use `isDhtml()`.
public FormalParameter	orientation	Indicates the orientation the dialog to render will have.
public FormalParameter	orientationsAllowed	Indicates the orientation modes allowed for the dialog to render.
public FormalParameter	partialIframeUpdate	This formal parameter specifies whether we should replace the whole contentst of the div shell (outerHTML) or the just the inner contents (innerHTML) of that shell div for the transform when the iframe update is going on.
public FormalParameter	processingButtonsFlags	Indicates which buttons to include on the wait page.
public FormalParameter	processingInfoFlags	Indicates which information to include on the wait page.
public FormalParameter	resizeLevel	Indicates whether the component can be resized vertically/horizontally or both or none.
public FormalParameter	scriptClass	Holds the name of the javaScript class (if any) to be associated with the component.
protected static final ScriptVariableJSONEncoder	scriptEndTagEncoder	reference to encoder that deals with tag encoding
public FormalParameter	type	This parameter is used when the output of this Transform generates a corresponding Microstrategy bone in the page, and it informs the javascript the type of bone it is.
public FormalParameter	useDHTML	Indicates whether to use DHTML on the output.
public FormalParameter	width	Indicates the default width of the component.

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

void	addFormalParam(FormalParameterImpl formal) This method is used to add a `FormalParameterImpl` object to the transform.
boolean	canTransform(Transformable data) Checks that the transform supports specified data object and that object is in the state supported by this transform.
static List<Integer>	getEvents(RequestKeys rkeys) Determines event(s) triggered from the request keys.
FormalParameters	getFormalParams() Returns the collection of formal parameters associated with this transform.
String	getID() Returns the unique name of the component to be used as the ID for its shell
MarkupOutput	getPreview() Produces a preview output for this transform.
boolean	isPreviewAvailable() Returns true if this transform supports preview functionality, false otherwise.
boolean	isResolved() Returns whether each required formal parameter has a value associated with it.
FormalParameterImpl	removeFormalParam(String name) Removes the formal parameter with the given name from the formal parameters collection.
void	setAnnotation(FormalParameter fp, FormalParameterAnnotation fpa) Used for internal housekeeping.
void	setDeprecated(FormalParameter fp, String desc) Used for internal housekeeping.
boolean	supports(Class type) Returns true if the transform supports objects of specified type.
boolean	supports(Transformable data) Returns true if the transform supports the specified data object.

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

abstract boolean	canTransform(Transformable data) Checks that the transform supports specified data object and that object is in the state supported by this transform.
abstract String	getDescription() Returns a textual description of the transform.
abstract FormalParameters	getFormalParams() Returns the collection of formal parameters associated with this transform.
abstract String	getID() Returns the unique name of the component to be used as the ID for its shell
abstract MarkupOutput	getPreview() This method is deprecated. This feature is not used
abstract Class	getSupportedBeanType() Returns a root class/interface supported by this transform.
abstract boolean	isPreviewAvailable() This method is deprecated. This feature is not used
abstract boolean	isResolved() Returns whether each required formal parameter has a value associated with it.
abstract boolean	supports(Class beanClass) Returns true if the transform supports objects of specified type.
abstract boolean	supports(Transformable data) Returns true if the transform supports the specified data object.
abstract void	transform(Transformable data, MarkupOutput transOut) Transforms the data object and appends result to the transOut.

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	`MarkupOutput`instance 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.

Interfaces

Classes

TabManagerTransform

Class Overview

Summary

Constants

public static final String FP_AUTO_SUBMIT_JS

public static final String FP_HIDE_UNAVAILABLE

public static final String FP_IGNORE_SINGLE_TAB

public static final String FP_PRIMARY_BONE

public static final String FP_TAB_HEIGHT

Fields

protected TabManagerBean _tabManagerBean

public FormalParameter autoSubmitJS

public FormalParameter hideUnavailable

public FormalParameter ignoreSingleTab

public FormalParameter primaryBone

public FormalParameter tabHeight

Public Constructors

public TabManagerTransform ()

Public Methods

public String getDescription ()

Returns

public Class getSupportedBeanType ()

Returns

public void initializeTransform (Transformable data)

Parameters

public void renderChildrenTabBody (MarkupOutput out)

Parameters

public void renderControlBar (MarkupOutput out)

Parameters

public void renderCurrentTabBody (MarkupOutput out)

public void renderEditorContents (MarkupOutput out)

Parameters

public void renderTabContainerBody (MarkupOutput out)

Parameters

public void renderTabManagerControlBarBody (MarkupOutput out)

Parameters

public void transformForRequestSuccessful (MarkupOutput out)

Parameters

Protected Methods

protected String getCurrentTabName ()

Returns

protected String getTitleForChildTab (TabBean bean)

Parameters

Returns

protected void initHelp (Editor editor)

protected void renderJavascript (MarkupOutput out)

Parameters

protected void setAttributesTabSetContainer (Tag tabSetContainer)

protected void setTabSetStyle (Tag tabSetContainer)