public class

TabPropertiesLayoutTransform

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

Class Overview

Title: TabPropertiesLayoutTransform.

This class transforms a TabBean allowing users to view/modify the layout of a control (for example, position, size, visibility). As with other TabTransforms, this one assumes its TabManagerBean will take care of rendering the required HTML & Javascript allowing users to switch between different formatting TabBean instances.

The output of this transform is divided into the following sections:

Visible

PageBreak

Position Section

Size Section
Each one Each one of these sections has its own render method. Furthermore each section generates individual settings which might be divided into their own render method.

This Transform implements LayoutTransform, therefore its render methods can be invoked using a custom layout-xml. When this is the case, the layout-xml specified in the style-catalog controls which methods are called and in which order. Otherwise, the default output of this transform changes depending on the selection. By default is as:

     Contents / ContentsBody
     -------------------------------------
     |                                   |
     |  Position Section                 |
     |                                   |
     -------------------------------------
     |                                   |
     |  Size Section                     |
     |                                   |
     -------------------------------------

For sub-sections we have:

     Contents / ContentsBody
     -------------------------------------
     |                                   |
     |  SubSection Size Section          |
     |                                   |
     -------------------------------------
     |                                   |
     |  PageBreak Section                |
     |                                   |
     -------------------------------------

And for grids, the default layout is:

     Contents / ContentsBody
     -------------------------------------
     |                                   |
     |  Position Section                 |
     |                                   |
     -------------------------------------
     |                                   |
     |  Size Section                     |
     |                                   |
     -------------------------------------
     |                                   |
     |  Grid Section                     |
     |                                   |
     -------------------------------------

Summary

[Expand]

Inherited Constants

From class com.microstrategy.web.app.transforms.AbstractTabTransform

From class com.microstrategy.web.app.transforms.AbstractAppTransform

[Expand]

Inherited Fields

From class com.microstrategy.web.app.transforms.AbstractTabTransform

protected String	cssBody	Property with the name of the css class to use for the body of this instance transform output.
protected String	cssFrame	Property with the name of the css class to use for the frame of this instance transform output.
protected String	cssPicker	Property with the name of the css class to use for the div including a single picker of this instance transform output.
protected String	cssPickers	Property with the name of the css class to use for the div including all pickers of this instance transform output.
protected String	scriptClassBody	Property with the value of the scriptClass attribute for the body of this instance transform output
protected String	scriptClassFrame	Property with the value of the scriptClass attribute for the frame of this instance transform output
protected String	styBody	Property with the value of the sty attribute for the body of this instance transform output
protected String	styFrame	Property with the value of the sty attribute for the frame of this instance transform output
public FormalParameter	tabHeight	Indicates the height of the tabs on the editor.
protected String	tyBody	Property with the value of the ty attribute for the body of this instance transform output
protected String	tyFrame	Property with the value of the ty attribute for the frame of this instance transform output

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
	TabPropertiesLayoutTransform()

Public Methods
String	getDescription() Returns the textual description of the transform
Class	getSupportedBeanType() Returns the supported bean type.
void	initializeCss() Initializes the Css Classes to use.
void	initializeJavaScriptAttributes() For JavaScript, certain properties are required to be added to the HTML tags to generate for its integration with the code generated for the feature to work in DHTML environments.
void	initializeTransform(Transformable data) This method initialize the private and protected fields of the transform.
boolean	isControl()
boolean	isCrossTab() Returns true if the selection in the report-writing document whose properties are being edited is a template or a cross-tab unit `RWUNIT_GRIDGRAPH`)
boolean	isSubSection() Returns true if the selection in the report-writing document whose properties are being edited is a subsection or not (of type EnumRWUnitTypes.RWUNIT_SUBSECTION)
void	renderContentsBody(MarkupOutput out) This is the entry point for the Tranform, and generates the body of the Tab.
void	renderDataSourceOptions(MarkupOutput out) If the targetBean of the `TabBean` is a RWBean, it renders a comboBox that allows users the change the dataset for the current control.
void	renderGridSection(MarkupOutput out) Generates the HTML output for the Grid section on this properties tab instance.
void	renderGridSectionDetails(MarkupOutput out) Generates the HTML output for the grid section details in the Grid section on this properties tab instance.
void	renderItemSection(MarkupOutput out)
void	renderJavascriptLinks(MarkupOutput out) Used to dynamically include links to js files.
void	renderLeftAndTopSection(MarkupOutput out) Generates the HTML output for the Left and Top section in the Position section on this properties tab instance.
void	renderLengthSection(MarkupOutput out) Generates the HTML output for the Length section in the Size section on this properties tab instance.
void	renderPageBreakSection(MarkupOutput out) Generates the HTML output for the Page Break section on this properties tab instance.
void	renderPositionSection(MarkupOutput out) Generates the HTML output for the Position section on this properties tab instance.
void	renderResizeSection(MarkupOutput out) Generates the HTML output for the resize section of the object in the size section on this properties tab instance.
void	renderSizeSection(MarkupOutput out) Generates the HTML output for the Size section on this properties tab instance.
void	renderSubSectionSizeSection(MarkupOutput out) Generates the HTML output for the Size section on this properties tab instance.
void	renderTitleHeightSection(MarkupOutput out)
void	renderWidthandHeightSection(MarkupOutput out) Generates the HTML output for the Width and Height section in the Size section on this properties tab instance.

Protected Methods
TabBean	getTabBean() Returns the TabBean for this tab.

[Expand]

Inherited Methods

From class com.microstrategy.web.app.transforms.AbstractTabTransform

void	AddJSValidationInfo(Tag inputTag, String type, String min, String max, String name, String errorMsg) This method is deprecated. please use `addJSValidationInfo(Tag, String, String, String, String, String)` instead
void	addJSValidationInfo(Tag inputTag, String type, String min, String max, String name, String errorMsg) Add the necessary JavaScript validation information
void	addPicker(ShortcutList picker)
String	getArgumentName(WebEvent event, int argumentId) Get the name of the argument assigned to the `WebEvent`, based on the indicated id.
Map	getAttributesBody() This method return a Map (name/value pairs) of attributes to use for the div enclosing the body of the Tab.
Map	getAttributesFrame() This method return a Map (name/value pairs) of attributes to use for the div enclosing the content of the Tab.
String	getDescription() Returns the textual description of the transform
Tag	getDropDownTag(String cmdId, String cmdValue, ShortcutList picker, String type)
Tag	getFieldSetTag(String title) Convenience method that builds and returns a fieldset html tag.
Tag	getLabelTag(String attFor, String labelDescriptor)
String	getPickerId(ShortcutList picker)
Class	getSupportedBeanType() Returns the supported bean type.
TabBean	getTabBean() Returns the TabBean for this tab.
TabManagerBean	getTabManagerBean() Returns the TabManagerBean for this Tab.
void	initializeCss() Initializes the Css Classes to use.
void	initializeJavaScriptAttributes() For JavaScript, certain properties are required to be added to the HTML tags to generate for its integration with the code generated for the feature to work in DHTML environments.
void	initializeTransform(Transformable data) This method initialize the private and protected fields of the transform.
boolean	isCurrentTab() This method returns true whenever this Tab is selected.
boolean	isIFrameEnabled() Whether iframe update technology is enabled for this Transform.
void	renderColorDropdown(MarkupOutput out, String cmdId, String cmdValue, ShortcutList picker) This method renders a single dropdown to be used with a color picker
void	renderContents(MarkupOutput out) Method that renders a frame for the main contents of the transform, according to the information available on the bean.
abstract void	renderContentsBody(MarkupOutput out) Method that renders the main contents of the transform, according to the information available on the bean.
void	renderDropdown(MarkupOutput out, String cmdId, String cmdValue, ShortcutList picker, String value) This method renders a single dropdown list to be used within a tab.
void	renderFlashWarning(MarkupOutput out) Generates the HTML with a label that reads '(Flash Only)'.
void	renderJavascriptLinks(MarkupOutput out) Used to dynamically include links to js files.
void	renderPickers(MarkupOutput out) This method needs to be overriden by those Transforms that has a picker.
void	renderSingleOption(MarkupOutput out, String cmdId, String propertyValue, String msg, boolean isDisabled)
void	renderSingleOption(MarkupOutput out, String cmdId, boolean checked, String msg, boolean isDisabled, boolean setCmdValue)
void	renderTabFrame(MarkupOutput out) Method that renders a frame for all the contents and sections of the bean that are to be displayed.
void	renderTabSectionTitle(MarkupOutput out, String title) This method is deprecated. please use getFieldSetTag instead
void	transformForRequestSuccessful(MarkupOutput out) Transforms the assosciated `TabBean` when its status is `WebBeanRequestSuccessful`.

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.

Public Constructors

public TabPropertiesLayoutTransform ()

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 any of the TabBean instances

Returns

the class of the bean supported by this transform.

public void initializeCss ()

Initializes the Css Classes to use. For each one of the css classes to use, the prefix indicated on the formal parameter is added to the name of the class to use.

public void initializeJavaScriptAttributes ()

For JavaScript, certain properties are required to be added to the HTML tags to generate for its integration with the code generated for the feature to work in DHTML environments. This method assigns values to these attributes, so they can be displayed together with the tags they represent. If a value is set to be null, it won't be included on the HTML tag definition. By default, it includes the definition of values for properties such as styFrame, tyFrame and scriptClassFrame.

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 boolean isControl ()

public boolean isCrossTab ()

Returns true if the selection in the report-writing document whose properties are being edited is a template or a cross-tab unit RWUNIT_GRIDGRAPH)

Returns

true if the selection is a template or a cross-tab unit.

public boolean isSubSection ()

Returns true if the selection in the report-writing document whose properties are being edited is a subsection or not (of type EnumRWUnitTypes.RWUNIT_SUBSECTION)

Returns

true if the selection is a subsection

public void renderContentsBody (MarkupOutput out)

This is the entry point for the Tranform, and generates the body of the Tab.

If a layout-xml is specified, this method will delegate the output generation to the Layout parser, otherwise it calls renderSubSectionSizeSection(), renderPageBreakSection(), renderGridSection(), renderPositionSection(), renderResizeSection() and/or renderSizeSection() based on what object the user is trying to set properties to.

Parameters

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

public void renderDataSourceOptions (MarkupOutput out)

If the targetBean of the TabBean is a RWBean, it renders a comboBox that allows users the change the dataset for the current control.

Parameters

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

public void renderGridSection (MarkupOutput out)

Generates the HTML output for the Grid section on this properties tab instance.

Parameters

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

public void renderGridSectionDetails (MarkupOutput out)

Generates the HTML output for the grid section details in the Grid section on this properties tab instance.

Parameters

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

public void renderItemSection (MarkupOutput out)

public void renderJavascriptLinks (MarkupOutput out)

Used to dynamically include links to js files. Extend with the list of files your transform requires.

Parameters

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

public void renderLeftAndTopSection (MarkupOutput out)

Generates the HTML output for the Left and Top section in the Position section on this properties tab instance.

Parameters

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

public void renderLengthSection (MarkupOutput out)

Generates the HTML output for the Length section in the Size section on this properties tab instance.

Parameters

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

public void renderPageBreakSection (MarkupOutput out)

Generates the HTML output for the Page Break section on this properties tab instance.

Parameters

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

public void renderPositionSection (MarkupOutput out)

Generates the HTML output for the Position section on this properties tab instance. Calls renderPositionSectionTitle(), renderLeftAndTopSection.

Parameters

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

public void renderResizeSection (MarkupOutput out)

Generates the HTML output for the resize section of the object in the size section on this properties tab instance.

Parameters

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

public void renderSizeSection (MarkupOutput out)

Generates the HTML output for the Size section on this properties tab instance. Calls renderSizeSectionTitle(), renderWidthandHeightSection

Parameters

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

public void renderSubSectionSizeSection (MarkupOutput out)

Generates the HTML output for the Size section on this properties tab instance.

Parameters

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

public void renderTitleHeightSection (MarkupOutput out)

public void renderWidthandHeightSection (MarkupOutput out)

Generates the HTML output for the Width and Height section in the Size section on this properties tab instance.

Parameters

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

Interfaces

Classes

TabPropertiesLayoutTransform

Class Overview

Summary

Public Constructors

public TabPropertiesLayoutTransform ()

Public Methods

public String getDescription ()

Returns

public Class getSupportedBeanType ()

Returns

public void initializeCss ()

public void initializeJavaScriptAttributes ()

public void initializeTransform (Transformable data)

Parameters

public boolean isControl ()

public boolean isCrossTab ()

Returns

public boolean isSubSection ()

Returns

public void renderContentsBody (MarkupOutput out)

Parameters

public void renderDataSourceOptions (MarkupOutput out)

Parameters

public void renderGridSection (MarkupOutput out)

Parameters

public void renderGridSectionDetails (MarkupOutput out)

Parameters

public void renderItemSection (MarkupOutput out)

public void renderJavascriptLinks (MarkupOutput out)

Parameters

See Also

public void renderLeftAndTopSection (MarkupOutput out)

Parameters

public void renderLengthSection (MarkupOutput out)

Parameters

public void renderPageBreakSection (MarkupOutput out)

Parameters

public void renderPositionSection (MarkupOutput out)

Parameters

public void renderResizeSection (MarkupOutput out)

Parameters

public void renderSizeSection (MarkupOutput out)

Parameters

public void renderSubSectionSizeSection (MarkupOutput out)

Parameters

public void renderTitleHeightSection (MarkupOutput out)

public void renderWidthandHeightSection (MarkupOutput out)

Parameters

Protected Methods

protected TabBean getTabBean ()

Returns