public class

TabPropertiesGeneralTransform

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

Class Overview

This class transforms a TabBean allowing users to view/modify general properties (like name, type, tooltip) of a control. 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 two sections:

  • Generic Properties Section like name, type etc.
  • Navigation Section, to enable hyperlinks on a control.
    Each one of these sections has its own render method. Furthermore each section generates individual settings which have been 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 is divided as follows:
         Contents / ContentsBody
         -------------------------------------
         |                                   |
         |  Generic Properties Section       |
         |                                   |
         -------------------------------------
         |                                   |
         |  Navigation 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
    From class com.microstrategy.web.app.transforms.AbstractAppTransform
    Public Constructors
    TabPropertiesGeneralTransform()
    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 renderContentsBody(MarkupOutput out)

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

    void renderGenericSection(MarkupOutput out)
    Generates the HTML output for the Generic section on this properties tab instance.
    void renderHTMLSection(MarkupOutput out)

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

    void renderHTMLTypeSection(MarkupOutput out)
    Displays the interface for allowing the user to modify type of the html object.
    void renderHyperlinkSection(MarkupOutput out)
    Displays the interface for allowing the user to modify the hyperlink setting on the currently selected target object(s).
    void renderJavascriptLinks(MarkupOutput out)
    Used to dynamically include links to js files.
    void renderNameSection(MarkupOutput out)
    Generates the HTML output for the Name of the object in the generic section on this properties tab instance.
    void renderNavigationSection(MarkupOutput out)

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

    void renderPortalSection(MarkupOutput out)

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

    void renderPortalStateSection(MarkupOutput out)
    Displays the interface for allowing the user to modify the properties of the portal window.
    void renderTooltipSection(MarkupOutput out)
    Generates the HTML output for the tooltip of the object in the generic section on this properties tab instance.
    void renderTypeSection(MarkupOutput out)
    Generates the HTML output for the Type of the object in the generic section on this properties tab instance.
    void renderVisibleHTMLViewModeSection(MarkupOutput out)
    Renders the check box for the 'Visible in Web View Mode' option
    void renderVisibleSection(MarkupOutput out)
    Generates the HTML output for the visible section of the object in the position section on this properties tab instance.
    [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

    Public Constructors

    public TabPropertiesGeneralTransform ()

    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 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 renderGenericSection() and renderNavigationSection().

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

    public void renderGenericSection (MarkupOutput out)

    Generates the HTML output for the Generic section on this properties tab instance. Calls renderNameSection(), renderTypeSection, renderTooltipSection() and renderVisibleSection().

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

    public void renderHTMLSection (MarkupOutput out)

    Generates the HTML output for the HTML section on this generic properties tab instance. This section allows an html container to be rendered as html text or as an iframe.

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

    public void renderHTMLTypeSection (MarkupOutput out)

    Displays the interface for allowing the user to modify type of the html object. The type could be just html text or it could contain an iframe.

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

    public void renderHyperlinkSection (MarkupOutput out)

    Displays the interface for allowing the user to modify the hyperlink setting on the currently selected target object(s).

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

    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 renderNameSection (MarkupOutput out)

    Generates the HTML output for the Name of the object in the generic section on this properties tab instance.

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

    public void renderNavigationSection (MarkupOutput out)

    Generates the HTML output for the Navigation section on this generic properties tab instance. This section allows a control to be used an hyperlink in a document.

    This section is unavailable if the selection is a template or a section.

    Calls renderTabSectionTitle and renderHyperlinkSection.

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

    public void renderPortalSection (MarkupOutput out)

    Generates the HTML output for the portal section on this generic properties tab instance. This section allows an object to be rendered as a portal with a window around it. The user can use the window to minimize, maximize and delete the object. Currently it applies only to grid objects.

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

    public void renderPortalStateSection (MarkupOutput out)

    Displays the interface for allowing the user to modify the properties of the portal window. You can change properties like if you want to see the portal, the title on the portal and the state of the portal.

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

    public void renderTooltipSection (MarkupOutput out)

    Generates the HTML output for the tooltip of the object in the generic section on this properties tab instance.

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

    public void renderTypeSection (MarkupOutput out)

    Generates the HTML output for the Type of the object in the generic section on this properties tab instance.

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

    public void renderVisibleHTMLViewModeSection (MarkupOutput out)

    Renders the check box for the 'Visible in Web View Mode' option

    Parameters
    out MarkupOutput

    public void renderVisibleSection (MarkupOutput out)

    Generates the HTML output for the visible section of the object in the position section on this properties tab instance.

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