public class

TabGraphOptionsTransform

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

Summary

Constants
String FP_BORDER_STYLE_PICKER_NAME Constant specifying the name of the borderStylePickerName formal parameter.
String FP_GAUGE_STYLE_PICKER_NAME Constant specifying the name of the gaugeStylePickerName formal parameter.
String FP_NEEDLE_STYLE_PICKER_NAME Constant specifying the name of the needleStylePickerName formal parameter.
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractTabTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public FormalParameter borderStylePickerName Indicates the name of the system picker (defined in the page-config) that contains the list border styles that shall be displayed to the user.
public FormalParameter gaugeStylePickerName Indicates the name of the system picker (defined in the page-config) that contains the list gauge styles that shall be displayed to the user.
public FormalParameter needleStylePickerName Indicates the name of the system picker (defined in the page-config) that contains the list needle styles that shall be displayed to the user.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractTabTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
TabGraphOptionsTransform()
Public Methods
ShortcutList getBorderStylePicker()
Returns the border style picker.
int getBorderThicknessLowerLimit()
Returns the lowest value can be set for Border Thickness.
int getBorderThicknessUpperLimit()
Returns the highest value can be set for Border Thickness.
String getCurrentBorderStyleValue()
Returns current value set for Border Style.
int getCurrentBorderThicknessValue()
Returns current value set for Border Thickness.
String getCurrentGaugeStyleValue()
Returns current value set for Gauge Style.
String getCurrentNeedleStyleValue()
Returns current value set for Needle Style.
int getCurrentRangeThicknessValue()
Returns current value set for Range Thickness.
int getCurrentStartAngleValue()
Returns current value set for Start Angle.
int getCurrentStopAngleValue()
Returns current value set for Stop Angle.
ShortcutList getGaugeStylePicker()
Returns the gauge style picker.
ShortcutList getNeedleStylePicker()
Returns the needle style picker.
int getRangeThicknessLowerLimit()
Returns the lowest value can be set for Range Thickness.
int getRangeThicknessUpperLimit()
Returns the highest value can be set for Range Thickness.
int getStartAngleLowerLimit()
Returns the lowest value can be set for Start Angle.
int getStartAngleUpperLimit()
Returns the highest value can be set for Start Angle.
int getStopAngleLowerLimit()
Returns the lowest value can be set for Stop Angle.
int getStopAngleUpperLimit()
Returns the highest value can be set for Stop Angle.
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 renderBorderStyle(TableTag table)

Generates the HTML output for the Border Style section.

void renderBorderThickness(TableTag table)

Generates the HTML output for the Border Thickness section.

void renderContentsBody(MarkupOutput out)

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

void renderDropDown(MarkupOutput out, ShortcutList picker, String currentValue, String controlName, String cmdId, String cssClass)

Generates the HTML output for a dropdown.

void renderDropDownWithLabel(TableTag tableTag, String label, ShortcutList picker, String currentValue, String controlName, String cmdId, String cssClass)

Generates the HTML output for a dropdown with its label.

void renderGaugeStyle(TableTag table)

Generates the HTML output for the Gauge Style section.

void renderJavascriptLinks(MarkupOutput out)
Render any JavaScript information required for this tab to work correctly on client side.
void renderNeedleStyle(TableTag table)

Generates the HTML output for the Needle Style section.

void renderRangeThickness(TableTag table)

Generates the HTML output for the Range Thickness section.

void renderSlider(MarkupOutput out, int upperLimit, int lowerLimit, int currentValue, String slideId, String slideCmdId, int increment, int slideStyle)

Generates the HTML output for a slider.

void renderSliderWithLabel(TableTag tableTag, String label, int upperLimit, int lowerLimit, int currentValue, String slideId, String slideCmdId, int increment, int slideStyle)

Generates the HTML output for a slider with its label.

void renderStartAngle(TableTag table)

Generates the HTML output for the Start Angle section.

void renderStopAngle(TableTag table)

Generates the HTML output for the Start Angle section.

void setBorderStylePicker(ShortcutList picker)

Register the major types picker.

void setGaugeStylePicker(ShortcutList picker)

Register the major types picker.

void setNeedleStylePicker(ShortcutList picker)

Register the major types 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_BORDER_STYLE_PICKER_NAME

Constant specifying the name of the borderStylePickerName formal parameter.

Constant Value: "borderStylePickerName"

public static final String FP_GAUGE_STYLE_PICKER_NAME

Constant specifying the name of the gaugeStylePickerName formal parameter.

Constant Value: "gaugeStylePickerName"

public static final String FP_NEEDLE_STYLE_PICKER_NAME

Constant specifying the name of the needleStylePickerName formal parameter.

Constant Value: "needleStylePickerName"

Fields

public FormalParameter borderStylePickerName

Indicates the name of the system picker (defined in the page-config) that contains the list border styles that shall be displayed to the user.

public FormalParameter gaugeStylePickerName

Indicates the name of the system picker (defined in the page-config) that contains the list gauge styles that shall be displayed to the user.

public FormalParameter needleStylePickerName

Indicates the name of the system picker (defined in the page-config) that contains the list needle styles that shall be displayed to the user.

Public Constructors

public TabGraphOptionsTransform ()

Public Methods

public ShortcutList getBorderStylePicker ()

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

Returns

public int getBorderThicknessLowerLimit ()

Returns the lowest value can be set for Border Thickness.

Returns
  • An integer to indicate the lowest value can be set for Border Thickness.

public int getBorderThicknessUpperLimit ()

Returns the highest value can be set for Border Thickness.

Returns
  • An integer to indicate the highest value can be set for Border Thickness.

public String getCurrentBorderStyleValue ()

Returns current value set for Border Style. If current graph is not Gauge Style, a default value will be returned.

Returns
  • current value set for Border Style.

public int getCurrentBorderThicknessValue ()

Returns current value set for Border Thickness. If current graph is not Gauge Style, a default value will be returned.

Returns
  • current value set for Border Thickness.

public String getCurrentGaugeStyleValue ()

Returns current value set for Gauge Style. If current graph is not Gauge Style, a default value will be returned.

Returns
  • current value set for Gauge Style.

public String getCurrentNeedleStyleValue ()

Returns current value set for Needle Style. If current graph is not Gauge Style, a default value will be returned.

Returns
  • current value set for Needle Style.

public int getCurrentRangeThicknessValue ()

Returns current value set for Range Thickness. If current graph is not Gauge Style, a default value will be returned.

Returns
  • current value set for Range Thickness.

public int getCurrentStartAngleValue ()

Returns current value set for Start Angle. If current graph is not Gauge Style, a default value will be returned.

Returns
  • current value set for Start Angle.

public int getCurrentStopAngleValue ()

Returns current value set for Stop Angle. If current graph is not Gauge Style, a default value will be returned.

Returns
  • current value set for Stop Angle.

public ShortcutList getGaugeStylePicker ()

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

Returns

public ShortcutList getNeedleStylePicker ()

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

Returns

public int getRangeThicknessLowerLimit ()

Returns the lowest value can be set for Range Thickness.

Returns
  • An integer to indicate the lowest value can be set for Range Thickness.

public int getRangeThicknessUpperLimit ()

Returns the highest value can be set for Range Thickness.

Returns
  • An integer to indicate the highest value can be set for Range Thickness.

public int getStartAngleLowerLimit ()

Returns the lowest value can be set for Start Angle.

Returns
  • An integer to indicate the lowest value can be set for Start Angle.

public int getStartAngleUpperLimit ()

Returns the highest value can be set for Start Angle.

Returns
  • An integer to indicate the highest value can be set for Start Angle.

public int getStopAngleLowerLimit ()

Returns the lowest value can be set for Stop Angle.

Returns
  • An integer to indicate the lowest value can be set for Stop Angle.

public int getStopAngleUpperLimit ()

Returns the highest value can be set for Stop Angle.

Returns
  • An integer to indicate the highest value can be set for Stop Angle.

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 renderBorderStyle (TableTag table)

Generates the HTML output for the Border Style section.

It calls utility method renderDropDownWithLabel(TableTag, String, ShortcutList, String, String, String, String) to generate the HTML. It calls getBorderStylePicker() to retrieve the available values; and getCurrentBorderStyleValue() to retrieve the current value to select.

Parameters
table TableTag instance where the HTML contents gets generated.

public void renderBorderThickness (TableTag table)

Generates the HTML output for the Border Thickness section.

It calls utility method renderSliderWithLabel(TableTag, String, int, int, int, String, String, int, int) to generate the HTML. It calls getBorderThicknessUpperLimit() to get the upper limit for the slider; getBorderThicknessLowerLimit() to get the lower limit for the slider; and getCurrentBorderThicknessValue() to retrieve the current value.

Parameters
table TableTag 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 renderGaugeStyle(TableTag), renderNeedleStyle(TableTag), renderBorderStyle(TableTag), renderBorderThickness(TableTag), renderRangeThickness(TableTag), renderStartAngle(TableTag) and renderStopAngle(TableTag).

Parameters
out MarkupOutput instance where the HTML contents gets generated.

public void renderDropDown (MarkupOutput out, ShortcutList picker, String currentValue, String controlName, String cmdId, String cssClass)

Generates the HTML output for a dropdown.

Parameters
out MarkupOutput instance where the HTML contents gets generated.
picker The shortcut list which contains the available values for this drop down.
currentValue The current value should be selected in this drop down.
controlName The name used for this drop down control.
cmdId The command id used for this drop down control.
cssClass The css class used for this drop down control.

public void renderDropDownWithLabel (TableTag tableTag, String label, ShortcutList picker, String currentValue, String controlName, String cmdId, String cssClass)

Generates the HTML output for a dropdown with its label. It calls renderDropDown(MarkupOutput, ShortcutList, String, String, String, String) to render the dropdown part.

Parameters
tableTag TableTag instance where the HTML contents gets generated.
label The label to put for this drop down.
picker The shortcut list which contains the available values for this drop down.
currentValue The current value should be selected in this drop down.
controlName The name used for this drop down control.
cmdId The command id used for this drop down control.
cssClass The css class used for this drop down control.

public void renderGaugeStyle (TableTag table)

Generates the HTML output for the Gauge Style section.

It calls utility method renderDropDownWithLabel(TableTag, String, ShortcutList, String, String, String, String) to generate the HTML. It calls getGaugeStylePicker() to retrieve the available values; and getCurrentGaugeStyleValue() to retrieve the current value to select.

Parameters
table TableTag instance where the HTML contents gets generated.

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 renderNeedleStyle (TableTag table)

Generates the HTML output for the Needle Style section.

It calls utility method renderDropDownWithLabel(TableTag, String, ShortcutList, String, String, String, String) to generate the HTML. It calls getNeedleStylePicker() to retrieve the available values; and getCurrentNeedleStyleValue() to retrieve the current value to select.

Parameters
table TableTag instance where the HTML contents gets generated.

public void renderRangeThickness (TableTag table)

Generates the HTML output for the Range Thickness section.

It calls utility method renderSliderWithLabel(TableTag, String, int, int, int, String, String, int, int) to generate the HTML. It calls getRangeThicknessUpperLimit() to get the upper limit for the slider; getRangeThicknessLowerLimit() to get the lower limit for the slider; and getCurrentRangeThicknessValue() to retrieve the current value.

Parameters
table TableTag instance where the HTML contents gets generated.

public void renderSlider (MarkupOutput out, int upperLimit, int lowerLimit, int currentValue, String slideId, String slideCmdId, int increment, int slideStyle)

Generates the HTML output for a slider.

Parameters
out MarkupOutput instance where the HTML contents gets generated.
upperLimit The upper limit of the slider.
lowerLimit The lower limit of the slider.
currentValue The current value should be shown on the slider.
slideId The id used for slider component.
slideCmdId The command id should be used for slider.

public void renderSliderWithLabel (TableTag tableTag, String label, int upperLimit, int lowerLimit, int currentValue, String slideId, String slideCmdId, int increment, int slideStyle)

Generates the HTML output for a slider with its label. It calls renderSlider(MarkupOutput, int, int, int, String, String, int, int) to generate the HTML output for the slider part.

Parameters
tableTag TableTag instance where the HTML contents gets generated.
label The label to put for this slider.
upperLimit The upper limit of the slider.
lowerLimit The lower limit of the slider.
currentValue The current value should be shown on the slider.
slideId The id used for slider component.
slideCmdId The command id should be used for slider.

public void renderStartAngle (TableTag table)

Generates the HTML output for the Start Angle section.

It calls utility method renderSliderWithLabel(TableTag, String, int, int, int, String, String, int, int) to generate the HTML. It calls getStartAngleUpperLimit() to get the upper limit for the slider; getStartAngleLowerLimit() to get the lower limit for the slider; and getCurrentStartAngleValue() to retrieve the current value.

Parameters
table TableTag instance where the HTML contents gets generated.

public void renderStopAngle (TableTag table)

Generates the HTML output for the Start Angle section.

It calls utility method renderSliderWithLabel(TableTag, String, int, int, int, String, String, int, int) to generate the HTML. It calls getStopAngleUpperLimit() to get the upper limit for the slider; getStopAngleLowerLimit() to get the lower limit for the slider; and getCurrentStopAngleValue() to retrieve the current value.

Parameters
table TableTag instance where the HTML contents gets generated.

public void setBorderStylePicker (ShortcutList picker)

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

Parameters
picker the major type picker to set.

public void setGaugeStylePicker (ShortcutList picker)

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

Parameters
picker the major type picker to set.

public void setNeedleStylePicker (ShortcutList picker)

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

Parameters
picker the major type picker to set.