public class

TabGraphTitlesTransform

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

Class Overview

This class transforms a TabBean allowing users to view/modify formatting properties for the graph titles (mainly font properties). 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 can be divided into several sections:

  • Titles Combo (a combo box with the list of available titles)
  • Font Name
  • Font Style
  • Font Size
  • Effects
  • Font Color
  • Sample
    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: 
         ContentsBody
     -----------------------------------------------------
     | TitlesCombo                                       |
     -----------------------------------------------------
     |                  |                |               |
     |                  |                |               |
     |   FontSection    |  StyleSection  |  SizeSection  |
     |                  |                |               |
     |                  |                |               |
     -----------------------------------------------------
     |                  |                                |
     |  EffectsSection  |  ColorSection                  |
     |                  |                                |
     |                  |--------------------------------|
     |                  |                                |
     |                  |  SampleSection                 |
     |                  |                                |
     -----------------------------------------------------

    • Summary

    Constants
    String FP_COLOR_PICKER_NAME Constant specifying the name of the formal parameter for defining the id of a system picker that contains the possible color options.
    String FP_FILL_COLOR_PICKER_NAME Constant specifying the name of the formal parameter for defining the id of a system picker that contains the possible color options.
    String FP_FILL_EFFECT_PICKER_NAME Constant specifying the name of the formal parameter for defining the name of the system picker that provides the fill effect options.
    String FP_FONT_COLOR_PICKER_NAME Constant specifying the name of the formal parameter for defining the id of a system picker that contains the possible color options for font.
    String FP_FONT_NAME_PICKER_NAME Constant specifying the name of the formal parameter for defining the name of the system picker that provides the font name options.
    String FP_FONT_SIZE_PICKER_NAME Constant specifying the name of the formal parameter for defining the name of the system picker that provides the font size options.
    String FP_FONT_STYLE_PICKER_NAME Constant specifying the name of the formal parameter for defining the name of the system picker that provides the font style options.
    String FP_TITLE_LIST Constant specifying the name of the formal parameter for defining the list of titles that will be rendered by this transform as possible format options.
    [Expand]
    Inherited Constants
    From class com.microstrategy.web.app.transforms.AbstractTabTransform
    From class com.microstrategy.web.app.transforms.AbstractAppTransform
    Fields
    public FormalParameter colorPickerName Indicates the id of a system picker that contains the possible color options
    public FormalParameter fillColorPickerName Indicates the id of a system picker that contains the possible fill color options
    public FormalParameter fillEffectPickerName Indicates the name of the system picker that contains the fill effects that shall be displayed to the user as possible options for fill formatting.
    public FormalParameter fontColorPickerName Indicates the id of a system picker that contains the possible color options for font
    public FormalParameter fontNamePickerName Indicates the name of the system picker that contains the font names that shall be displayed to the user as possible options for font formatting.
    public FormalParameter fontSizePickerName Indicates the name of the system picker that contains the font sizes that shall be displayed to the user as possible options for font formatting.
    public FormalParameter fontStylePickerName Indicates the name of the system picker that contains the font styles that shall be displayed to the user as possible options for font formatting.
    public FormalParameter titleList Indicates which titles that will be rendered by this format tab as options, as long as the current graph major type supports them.
    [Expand]
    Inherited Fields
    From class com.microstrategy.web.app.transforms.AbstractTabTransform
    From class com.microstrategy.web.app.transforms.AbstractAppTransform
    Public Constructors
    TabGraphTitlesTransform()
    Default no-argument constructor.
    Public Methods
    ShortcutList getColorPicker()
    Returns the color picker.
    String getDescription()
    Returns the textual description of the transform
    ShortcutList getFillColorPicker()
    Returns the fill color picker.
    ShortcutList getFillEffectsPicker()
    Returns the font style picker.
    ShortcutList getFontColorPicker()
    Returns the font color picker.
    ShortcutList getFontNamePicker()
    Returns the font name picker.
    ShortcutList getFontSizePicker()
    Returns the font size picker.
    ShortcutList getFontStylePicker()
    Returns the font style picker.
    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.
    void renderColorSection(MarkupOutput out)
    Generates the HTML output for the Color section on this tab instance, that allows users to select the font color to use for formatting the currently selected target(s).
    void renderContentSection(MarkupOutput out)
    Generates the HTML output for the Content section on this tab instance, that allows users to specify the text they want to have displayed on a given location on the graph.
    void renderContentsBody(MarkupOutput out)

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

    void renderEffectsSection(MarkupOutput out)
    Generates the HTML output for the Effects section on this tab instance, that allows users to select the font effects (underline, strikeout) to use for formatting the currently selected target(s).
    void renderFillColorSection(MarkupOutput out)
    Generates the HTML output for the Line Color section on this tab instance, that allows users to select the font color to use for formatting the currently selected target(s).
    void renderFillEffectSection(MarkupOutput out)
    Generates the HTML output for the Fill Effect section on this tab instance, that allows users to select the effect to use for formatting the currently selected target(s).
    void renderFontBoxStyle(MarkupOutput out)
    void renderFontSection(MarkupOutput out)
    Generates the HTML output for the Font section on this tab instance, that allows users to select the font name to use for formatting the currently selected target(s).
    void renderJavascriptLinks(MarkupOutput out)
    Render any JavaScript information required for this tab to work correctly on client side.
    void renderLineColorSection(MarkupOutput out)
    Generates the HTML output for the Line Color section on this tab instance, that allows users to select the font color to use for formatting the currently selected target(s).
    void renderMacroInformation(MarkupOutput out)
    Called from renderContentSection(MarkupOutput), generates an information image icon which will display the macro options that can be typed in on the content text box.
    void renderPositionSection(MarkupOutput out)
    Generates the HTML output for the Legend Position section on this tab instance, that allows users to define where the legends should be located on the graph image.
    void renderSampleSection(MarkupOutput out)
    Generates the HTML output for the Sample section on this tab instance, that allows users to preview how the formatting changes will update the selected target(s).
    void renderShowSection(MarkupOutput out)
    Generates the HTML output for the Show section on this tab instance, that allows users to select whether the title should be shown or not.
    void renderSizeSection(MarkupOutput out)
    Generates the HTML output for the Size section on this tab instance, that allows users to select the font size to use for formatting the currently selected target(s).
    void renderStyleSection(MarkupOutput out)
    Generates the HTML output for the Style section on this tab instance, that allows users to select the font style to use for formatting the currently selected target(s).
    void renderTitlesCombo(MarkupOutput out)
    Convenience method that displays the HTML required for rendering the title of a section.
    void renderTooltipsSection(MarkupOutput out)
    void renderTransparencySection(MarkupOutput out)
    void setColorPicker(ShortcutList picker)

    Register the color picker.

    void setFillColorPicker(ShortcutList picker)

    Register the fill color picker.

    void setFontColorPicker(ShortcutList picker)

    Register the font color picker.

    void setFontNamePicker(ShortcutList fontNamePicker)

    Register the font name picker.

    void setFontSizePicker(ShortcutList picker)

    Register the font size picker.

    void setFontStylePicker(ShortcutList picker)

    Register the font style picker.

    [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_COLOR_PICKER_NAME

    Constant specifying the name of the formal parameter for defining the id of a system picker that contains the possible color options. Value is colorPickerName.

    Constant Value: "colorPickerName"

    public static final String FP_FILL_COLOR_PICKER_NAME

    Constant specifying the name of the formal parameter for defining the id of a system picker that contains the possible color options. Value is colorPickerName.

    Constant Value: "fillColorPickerName"

    public static final String FP_FILL_EFFECT_PICKER_NAME

    Constant specifying the name of the formal parameter for defining the name of the system picker that provides the fill effect options. Value is fillEffectPickerName.

    Constant Value: "fillEffectPickerName"

    public static final String FP_FONT_COLOR_PICKER_NAME

    Constant specifying the name of the formal parameter for defining the id of a system picker that contains the possible color options for font. Value is fontColorPickerName.

    Constant Value: "fontColorPickerName"

    public static final String FP_FONT_NAME_PICKER_NAME

    Constant specifying the name of the formal parameter for defining the name of the system picker that provides the font name options. Value is fontNamePickerName.

    Constant Value: "fontNamePickerName"

    public static final String FP_FONT_SIZE_PICKER_NAME

    Constant specifying the name of the formal parameter for defining the name of the system picker that provides the font size options. Value is fontSizePickerName.

    Constant Value: "fontSizePickerName"

    public static final String FP_FONT_STYLE_PICKER_NAME

    Constant specifying the name of the formal parameter for defining the name of the system picker that provides the font style options. Value is fontStylePickerName.

    Constant Value: "fontStylePickerName"

    public static final String FP_TITLE_LIST

    Constant specifying the name of the formal parameter for defining the list of titles that will be rendered by this transform as possible format options. Value is titleList.

    Constant Value: "titleList"

    Fields

    public FormalParameter colorPickerName

    Indicates the id of a system picker that contains the possible color options

    public FormalParameter fillColorPickerName

    Indicates the id of a system picker that contains the possible fill color options

    public FormalParameter fillEffectPickerName

    Indicates the name of the system picker that contains the fill effects that shall be displayed to the user as possible options for fill formatting.

    public FormalParameter fontColorPickerName

    Indicates the id of a system picker that contains the possible color options for font

    public FormalParameter fontNamePickerName

    Indicates the name of the system picker that contains the font names that shall be displayed to the user as possible options for font formatting.

    public FormalParameter fontSizePickerName

    Indicates the name of the system picker that contains the font sizes that shall be displayed to the user as possible options for font formatting.

    public FormalParameter fontStylePickerName

    Indicates the name of the system picker that contains the font styles that shall be displayed to the user as possible options for font formatting.

    public FormalParameter titleList

    Indicates which titles that will be rendered by this format tab as options, as long as the current graph major type supports them. Value is a series of title identifiers (from EnumDSSXMLGraphObjectID) separated by commas.

    Public Constructors

    public TabGraphTitlesTransform ()

    Default no-argument constructor. Initializes formal parameters.

    Public Methods

    public ShortcutList getColorPicker ()

    Returns the color picker. If a non-null instance have been registered through the setColorPicker method, it will return that one, otherwise, it will search for a system picker with the name specified in colorPickerName.

    Returns
    • ShortcutList to use for the color-picker.

    public String getDescription ()

    Returns the textual description of the transform

    Returns
    • the description of the transform

    public ShortcutList getFillColorPicker ()

    Returns the fill color picker. If a non-null instance have been registered through the setColorPicker method, it will return that one, otherwise, it will search for a system picker with the name specified in fillColorPickerName.

    Returns
    • ShortcutList to use for the color-picker.

    public ShortcutList getFillEffectsPicker ()

    Returns the font style picker. If a non-null instance have been registered through the setFontStylePicker method, it will return that one, otherwise, it will search for a system picker with the name specified in fillEffectPickerName.

    Returns
    • ShortcutList to use for the font-style picker.

    public ShortcutList getFontColorPicker ()

    Returns the font color picker. If a non-null instance have been registered through the setColorPicker method, it will return that one, otherwise, it will search for a system picker with the name specified in colorPickerName.

    Returns
    • ShortcutList to use for the color-picker.

    public ShortcutList getFontNamePicker ()

    Returns the font name picker. If a non-null instance have been registered through the setFontNamePicker method, it will return that one, otherwise, it will search for a system picker with the name specified in fontNamePickerName.

    Returns
    • ShortcutList to use for the font-name picker.

    public ShortcutList getFontSizePicker ()

    Returns the font size picker. If a non-null instance have been registered through the setFontSizePicker method, it will return that one, otherwise, it will search for a system picker with the name specified in fontSizePickerName.

    Returns
    • ShortcutList to use for the font-size picker.

    public ShortcutList getFontStylePicker ()

    Returns the font style picker. If a non-null instance have been registered through the setFontStylePicker method, it will return that one, otherwise, it will search for a system picker with the name specified in fontStylePickerName.

    Returns
    • ShortcutList to use for the font-style picker.

    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.

    Parameters
    data Transformable instance to be transformed.

    public void renderColorSection (MarkupOutput out)

    Generates the HTML output for the Color section on this tab instance, that allows users to select the font color to use for formatting the currently selected target(s).

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

    public void renderContentSection (MarkupOutput out)

    Generates the HTML output for the Content section on this tab instance, that allows users to specify the text they want to have displayed on a given location on the graph.

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

    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 renderTitlesCombo, renderFontSection(), renderStyleSection(), renderSizeSection(), renderEffectsSection(), renderColorSection() and renderSampleSection()

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

    public void renderEffectsSection (MarkupOutput out)

    Generates the HTML output for the Effects section on this tab instance, that allows users to select the font effects (underline, strikeout) to use for formatting the currently selected target(s).

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

    public void renderFillColorSection (MarkupOutput out)

    Generates the HTML output for the Line Color section on this tab instance, that allows users to select the font color to use for formatting the currently selected target(s).

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

    public void renderFillEffectSection (MarkupOutput out)

    Generates the HTML output for the Fill Effect section on this tab instance, that allows users to select the effect to use for formatting the currently selected target(s).

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

    public void renderFontBoxStyle (MarkupOutput out)

    public void renderFontSection (MarkupOutput out)

    Generates the HTML output for the Font section on this tab instance, that allows users to select the font name to use for formatting the currently selected target(s).

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

    public void renderJavascriptLinks (MarkupOutput out)

    Render any JavaScript information required for this tab to work correctly on client side.

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

    public void renderLineColorSection (MarkupOutput out)

    Generates the HTML output for the Line Color section on this tab instance, that allows users to select the font color to use for formatting the currently selected target(s).

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

    public void renderMacroInformation (MarkupOutput out)

    Called from renderContentSection(MarkupOutput), generates an information image icon which will display the macro options that can be typed in on the content text box.

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

    public void renderPositionSection (MarkupOutput out)

    Generates the HTML output for the Legend Position section on this tab instance, that allows users to define where the legends should be located on the graph image.

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

    public void renderSampleSection (MarkupOutput out)

    Generates the HTML output for the Sample section on this tab instance, that allows users to preview how the formatting changes will update the selected target(s).

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

    public void renderShowSection (MarkupOutput out)

    Generates the HTML output for the Show section on this tab instance, that allows users to select whether the title should be shown or not.

    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 tab instance, that allows users to select the font size to use for formatting the currently selected target(s).

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

    public void renderStyleSection (MarkupOutput out)

    Generates the HTML output for the Style section on this tab instance, that allows users to select the font style to use for formatting the currently selected target(s).

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

    public void renderTitlesCombo (MarkupOutput out)

    Convenience method that displays the HTML required for rendering the title of a section.

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

    public void renderTooltipsSection (MarkupOutput out)

    public void renderTransparencySection (MarkupOutput out)

    public void setColorPicker (ShortcutList picker)

    Register the color picker. This allows the transform to use a ShortcutList that is not defined inside the pageConfig.

    Parameters
    picker The colorPicker to set.

    public void setFillColorPicker (ShortcutList picker)

    Register the fill color picker. This allows the transform to use a ShortcutList that is not defined inside the pageConfig.

    Parameters
    picker The colorPicker to set.

    public void setFontColorPicker (ShortcutList picker)

    Register the font color picker. This allows the transform to use a ShortcutList that is not defined inside the pageConfig.

    Parameters
    picker The colorPicker to set.

    public void setFontNamePicker (ShortcutList fontNamePicker)

    Register the font name picker. This allows the transform to use a ShortcutList that is not defined inside the pageConfig.

    Parameters
    fontNamePicker The fontNamePicker to set.

    public void setFontSizePicker (ShortcutList picker)

    Register the font size picker. This allows the transform to use a ShortcutList that is not defined inside the pageConfig.

    Parameters
    picker The fontSizePicker to set.

    public void setFontStylePicker (ShortcutList picker)

    Register the font style picker. This allows the transform to use a ShortcutList that is not defined inside the pageConfig.

    Parameters
    picker The fontStylePicker to set.