public class

FormatTabEffectsTransform

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

Class Overview

This class transforms a FormatTabBean allowing users to modify the corresponding effect properties 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 main sections:

  • Border 3D
  • Drop Shadows
  • Alpha Transparency
    Each one of these sections has its own render method. Furthermore each section generates individual settings which are 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:
         ContentsBody
         -------------------------------------
         |  Border3DSection                  |
         |    - Border3DStyle                |
         |    - Border3DWeight               |
         |                                   |
         |                                   |
         -------------------------------------
         |  DropShadowsSection               |
         |                                   |
         -------------------------------------
         |  AlphaTransparencySection         |
         |                                   |
         -------------------------------------
         |  RadiusSection                    |
         |                                   |
         -------------------------------------
     

  • Summary

    Constants
    String FP_IS_DOC_PROPS Constant specifying the name of the formal parameter that determines whether we are showing the tab for the Document Properties Editor.
    [Expand]
    Inherited Constants
    From class com.microstrategy.web.app.transforms.AbstractTabTransform
    From class com.microstrategy.web.app.transforms.AbstractAppTransform
    Fields
    public FormalParameter isDocumentProperties Indicates whether we are showing the tab for the Document Properties Editor.
    [Expand]
    Inherited Fields
    From class com.microstrategy.web.app.transforms.AbstractTabTransform
    From class com.microstrategy.web.app.transforms.AbstractAppTransform
    Public Constructors
    FormatTabEffectsTransform()
    Default no-argument constructor.
    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 initializeImages()
    Initializes the name of the images to use on this transform's output.
    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.
    void initializeWebComponent(Transformable data)
    Initialize the web component to be used by the transform.
    void renderAlphaEnableSection(MarkupOutput out)
    void renderAlphaSection(MarkupOutput out)
    void renderAlphaSettingSection(MarkupOutput out)
    void renderBorder3DEnableSection(MarkupOutput out)
    void renderBorder3DSection(MarkupOutput out)

    Generates the HTML output for the Text Alignment section.

    void renderBorder3DStyleSection(MarkupOutput out)
    Generates the HTML that allows the user to modify the 3D setting style.
    void renderBorder3DWeightSection(MarkupOutput out)
    Generates the HTML that allows the user to modify the vertical alignment setting .
    void renderContentsBody(MarkupOutput out)

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

    void renderDropShadowEnableSection(MarkupOutput out)
    void renderDropShadowSettingSection(MarkupOutput out)
    void renderDropShadowsSection(MarkupOutput out)
    Generates the HTML output for the Text Control section on this format tab instance.
    void renderJavascriptLinks(MarkupOutput out)
    Extends the parent method by adding the JavaScript file this transform needs for its correct behavior on the client side.
    void renderRadiusDepthSection(MarkupOutput out)
    void renderRadiusOptionsSection(MarkupOutput out)
    void renderRadiusSection(MarkupOutput out)
    Generates the HTML output for the radius control on this format tab instance.
    void renderRoundedCornersSection(MarkupOutput out)
    Protected Methods
    Map getAttributesFrame()
    This method return a Map (name/value pairs) of attributes to use for the div enclosing the content of the Tab.
    FormatTabBean getFormatTabBean()
    Obtain the FormatTabBean instance currently being transformed.
    [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

    Constants

    public static final String FP_IS_DOC_PROPS

    Constant specifying the name of the formal parameter that determines whether we are showing the tab for the Document Properties Editor.

    Constant Value: "isDocumentProperties"

    Fields

    public FormalParameter isDocumentProperties

    Indicates whether we are showing the tab for the Document Properties Editor.

    Public Constructors

    public FormatTabEffectsTransform ()

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

    Returns
    • FormatTabBean.class

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

    Initializes the name of the images to use on this transform's output. For each one of the images defined to be displayed, the resource folder information is added to its path and file name as specified on the formal parameters for the images.

    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.

    Parameters
    data Transformable instance to be transformed.

    public void initializeWebComponent (Transformable data)

    Initialize the web component to be used by the transform.

    Parameters
    data the bean to transform.

    public void renderAlphaEnableSection (MarkupOutput out)

    public void renderAlphaSection (MarkupOutput out)

    public void renderAlphaSettingSection (MarkupOutput out)

    public void renderBorder3DEnableSection (MarkupOutput out)

    public void renderBorder3DSection (MarkupOutput out)

    Parameters
    out MarkupOutput instance where the HTML contents gets generated.

    public void renderBorder3DStyleSection (MarkupOutput out)

    Generates the HTML that allows the user to modify the 3D setting style.

    Parameters
    out MarkupOutput instance where the HTML contents gets generated.

    public void renderBorder3DWeightSection (MarkupOutput out)

    Generates the HTML that allows the user to modify the vertical alignment setting .

    Parameters
    out MarkupOutput instance where the HTML contents gets generated.

    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 renderBorder3DSection(MarkupOutput), renderDropShadowsSection(MarkupOutput) and renderAlphaSection(MarkupOutput).

    Parameters
    out MarkupOutput instance where the HTML contents gets generated.

    public void renderDropShadowEnableSection (MarkupOutput out)

    public void renderDropShadowSettingSection (MarkupOutput out)

    public void renderDropShadowsSection (MarkupOutput out)

    Generates the HTML output for the Text Control section on this format tab instance. Calls renderTextControlWordWrapSection().

    Parameters
    out MarkupOutput instance where the HTML contents gets generated.

    public void renderJavascriptLinks (MarkupOutput out)

    Extends the parent method by adding the JavaScript file this transform needs for its correct behavior on the client side.

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

    public void renderRadiusDepthSection (MarkupOutput out)

    public void renderRadiusOptionsSection (MarkupOutput out)

    public void renderRadiusSection (MarkupOutput out)

    Generates the HTML output for the radius control on this format tab instance.

    Parameters
    out MarkupOutput instance where the HTML contents gets generated.

    public void renderRoundedCornersSection (MarkupOutput out)

    Protected Methods

    protected Map getAttributesFrame ()

    This method return a Map (name/value pairs) of attributes to use for the div enclosing the content of the Tab. These attributes include those required for javascript and formatting (for example, "sty", "ty" and "scriptclass"). Extends the parent method by yet adding one more property that indicates if the current object being targetted is a Document.

    Returns
    • Map with HTML attributes for the body div.

    protected FormatTabBean getFormatTabBean ()

    Obtain the FormatTabBean instance currently being transformed.

    Returns