public class

MojoXtabTransformImpl

extends MojoTemplateTransformImpl
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractWebBeanTransform
           ↳ com.microstrategy.web.app.transforms.AbstractReportTransform
             ↳ com.microstrategy.web.app.transforms.AbstractReportDataTransform
               ↳ com.microstrategy.web.app.transforms.MojoTemplateTransformImpl
                 ↳ com.microstrategy.web.app.transforms.MojoXtabTransformImpl
Known Direct Subclasses
Known Indirect Subclasses

Summary

Constants
String BLOCK_ELEMENT_MODEL
int DEFAULT_BORDER_WIDTH
int DEFAULT_PADDING_BOTTOM
int DEFAULT_PADDING_LEFT
int DEFAULT_PADDING_RIGHT
int DEFAULT_PADDING_TOP
int LOCK_COL
String PROPERTY_COLUMN_WIDTHS
String PROPERTY_ID
String PROPERTY_METRIC_INDEX
String PROPERTY_RAW_VALUE
String PROPERTY_SELECTOR_OPTIONS
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractReportDataTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected FormalParameter encodeElementNameParam
protected FormalParameter forceShowAttributeFormParam
protected FormalParameter includeBlockIndicesPropertiesParam
protected FormalParameter includeCSSOnlyParam
protected FormalParameter includeCSSParam
protected FormalParameter includeCSSStringForDocument
protected FormalParameter includeCellFillColorParam
protected FormalParameter includeColWidthsParam
protected FormalParameter includeDataBlockParam
protected FormalParameter includeElementIDParam
protected FormalParameter includeGridSelectorCurrentElementsParam
protected FormalParameter includeThresholdParam
protected FormalParameter returnReplacementParam
protected FormalParameter useAbsoluteURLsParam
protected FormalParameter useRawValuesParam
protected FormalParameter useReducedElementIDParam
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.MojoTemplateTransformImpl
From class com.microstrategy.web.app.transforms.AbstractReportDataTransform
From class com.microstrategy.web.app.transforms.AbstractReportTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
MojoXtabTransformImpl()
Public Methods
long getActions(WebHeader header)
long getActions(WebTitleUnit element)
long getActions(WebRowValue rowValue)
int getColSpan(WebHeader header)
String getDescription()
BlockList getDrillPathBlock(WebTitleUnit element)
BlockList getElementsBlock(WebTitleUnit titleUnit, long actions, IntWrapper intWrp)
String getFormID(WebTitleUnit titleUnit)
int getFormType(WebTitleUnit titleUnit)
List<? extends WebTitleUnit> getGridTitles(int axis)
List<WebColumn> getHeaderWidths()
List<WebHeader> getHeaders(WebHeaders headers)
List<WebHeaders> getHeadersList(int axis)
BlockList getLinkMapBlock(WebTitleUnit element)
int getLockHeadersValue()
int getMergeHeaderValue()
Integer getMetricIndex(WebHeader header)
String getName(WebTitleUnit element)
Integer getParentCellIndex(WebHeader header)
Block getParentIndex(WebHeader header, long headerActionType)
Integer getParentRowIndex(WebHeader header)
String getRowHeight()
returns empty string, if the height is not fixed.
Block getSelectorBlock(WebTitleUnit element)
Boolean getSortOrder(WebTitleUnit titleUnit)
Boolean getSortOrder(WebHeader header)
int getSpan(WebTitleUnit titleUnit)
int getSubtotalsPosition(int axis)
List<String> getTitleFormIDs(WebTitleUnit titleUnit)
int getTitleUnitIndex(WebHeader header)
List<WebColumn> getTitleWidths()
int getUnitIndex(WebHeader header)
String getValue(WebHeader header)
String getValue(WebRowValue rowValue)
Block getValueBlock(WebRowValue rowValue)
int getWebElementIndex(WebHeader header)
boolean isClipOverflowSet()
boolean isComplex(WebHeader header)
boolean isDhtml()
Determine if the environment where this transform instance is being used is DHTML or not
boolean isTemplateMetric(WebHeader header)
boolean isVisible(int zoneID)
boolean removeExtraColumn()
void renderShell(MarkupOutput out)

Generates the shell for this Transform.

void transformForRequestSuccessful(MarkupOutput out)
Transform when the status is "Successful".
Protected Methods
BlockList createCellFillColorList()
BlockList createCellFillColorList(LinkedHashMap<String, Integer> colormap)
Block createGridDataModelBlock()
Block createGridHeadersModelBlock()
Block createGridModelBlock()
Block createGridTitlesModelBlock()
Block createHeader(WebHeader headerSrc, boolean useTitle)
BlockList createThresholdList()
boolean forceIncludeMetricRawValue(WebRowValue rowValue)
static WebAttribute getAttribute(WebTitleUnit tu)
WebCSSHelper getCssHelper()
Integer getRowHeightVal()
HashList<String, String> getVisProps()
void prepareToTransform(MarkupOutput out)
void renderRegisterBone(MarkupOutput out)
If a scriptClass is specified, this method registers the corresponding javascript bone for this component.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.MojoTemplateTransformImpl
From class com.microstrategy.web.app.transforms.AbstractReportDataTransform
From class com.microstrategy.web.app.transforms.AbstractReportTransform
From class com.microstrategy.web.app.transforms.AbstractWebBeanTransform
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.app.transforms.ReportDataTransform
From interface com.microstrategy.web.transform.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Constants

protected static final String BLOCK_ELEMENT_MODEL

Constant Value: "ElementModel"

protected static final int DEFAULT_BORDER_WIDTH

Constant Value: 1 (0x00000001)

protected static final int DEFAULT_PADDING_BOTTOM

Constant Value: 1 (0x00000001)

protected static final int DEFAULT_PADDING_LEFT

Constant Value: 2 (0x00000002)

protected static final int DEFAULT_PADDING_RIGHT

Constant Value: 2 (0x00000002)

protected static final int DEFAULT_PADDING_TOP

Constant Value: 1 (0x00000001)

protected static final int LOCK_COL

Constant Value: 2 (0x00000002)

public static final String PROPERTY_COLUMN_WIDTHS

Constant Value: "cws"

protected static final String PROPERTY_ID

Constant Value: "id"

public static final String PROPERTY_METRIC_INDEX

Constant Value: "mix"

protected static final String PROPERTY_RAW_VALUE

Constant Value: "rv"

public static final String PROPERTY_SELECTOR_OPTIONS

Constant Value: "so"

Fields

protected FormalParameter encodeElementNameParam

protected FormalParameter forceShowAttributeFormParam

protected FormalParameter includeBlockIndicesPropertiesParam

protected FormalParameter includeCSSOnlyParam

protected FormalParameter includeCSSParam

protected FormalParameter includeCSSStringForDocument

protected FormalParameter includeCellFillColorParam

protected FormalParameter includeColWidthsParam

protected FormalParameter includeDataBlockParam

protected FormalParameter includeElementIDParam

protected FormalParameter includeGridSelectorCurrentElementsParam

protected FormalParameter includeThresholdParam

protected FormalParameter returnReplacementParam

protected FormalParameter useAbsoluteURLsParam

protected FormalParameter useRawValuesParam

protected FormalParameter useReducedElementIDParam

Public Constructors

public MojoXtabTransformImpl ()

Public Methods

public long getActions (WebHeader header)

public long getActions (WebTitleUnit element)

public long getActions (WebRowValue rowValue)

public int getColSpan (WebHeader header)

public String getDescription ()

public BlockList getDrillPathBlock (WebTitleUnit element)

public BlockList getElementsBlock (WebTitleUnit titleUnit, long actions, IntWrapper intWrp)

public String getFormID (WebTitleUnit titleUnit)

public int getFormType (WebTitleUnit titleUnit)

public List<? extends WebTitleUnit> getGridTitles (int axis)

public List<WebColumn> getHeaderWidths ()

public List<WebHeader> getHeaders (WebHeaders headers)

public List<WebHeaders> getHeadersList (int axis)

public BlockList getLinkMapBlock (WebTitleUnit element)

public int getLockHeadersValue ()

public int getMergeHeaderValue ()

public Integer getMetricIndex (WebHeader header)

public String getName (WebTitleUnit element)

public Integer getParentCellIndex (WebHeader header)

public Block getParentIndex (WebHeader header, long headerActionType)

Throws
Exception

public Integer getParentRowIndex (WebHeader header)

public String getRowHeight ()

returns empty string, if the height is not fixed.

public Block getSelectorBlock (WebTitleUnit element)

public Boolean getSortOrder (WebTitleUnit titleUnit)

public Boolean getSortOrder (WebHeader header)

public int getSpan (WebTitleUnit titleUnit)

public int getSubtotalsPosition (int axis)

public List<String> getTitleFormIDs (WebTitleUnit titleUnit)

public int getTitleUnitIndex (WebHeader header)

public List<WebColumn> getTitleWidths ()

public int getUnitIndex (WebHeader header)

public String getValue (WebHeader header)

public String getValue (WebRowValue rowValue)

public Block getValueBlock (WebRowValue rowValue)

Throws
Exception

public int getWebElementIndex (WebHeader header)

public boolean isClipOverflowSet ()

public boolean isComplex (WebHeader header)

public boolean isDhtml ()

Determine if the environment where this transform instance is being used is DHTML or not

Returns
  • boolean value indicating the environment is DHTML or not.

public boolean isTemplateMetric (WebHeader header)

public boolean isVisible (int zoneID)

public boolean removeExtraColumn ()

public void renderShell (MarkupOutput out)

Generates the shell for this Transform.

The shell is a <div> tag that automatically surrounds the content generated by the Transform. It's used among other things by the javascript to identify the HTML associated with a bone, and by the iFrame update technology to identify a component in the page.

The attributes to append to this <div> are obtained from the getAttributesShellDiv method; the style from the getStyleShellDiv method.
This method calls renderCssLink and checkStatus to generate the Transform's content.

Parameters
out output by this transform

public void transformForRequestSuccessful (MarkupOutput out)

Transform when the status is "Successful". This is the main entry point of the Transform. It will check if a layout-xml has been specified and use it, otherwise it calls renderContent.
After the content has been generated it calls renderJavascript to generate any necessary client-side information.

Parameters
out MarkupOutput to generate the HTML.

Protected Methods

protected BlockList createCellFillColorList ()

protected BlockList createCellFillColorList (LinkedHashMap<String, Integer> colormap)

protected Block createGridDataModelBlock ()

Throws
Exception

protected Block createGridHeadersModelBlock ()

Throws
Exception

protected Block createGridModelBlock ()

Throws
Exception

protected Block createGridTitlesModelBlock ()

Throws
Exception

protected Block createHeader (WebHeader headerSrc, boolean useTitle)

Parameters
useTitle whether title can be referenced in the block model
Throws
Exception

protected BlockList createThresholdList ()

protected boolean forceIncludeMetricRawValue (WebRowValue rowValue)

protected static WebAttribute getAttribute (WebTitleUnit tu)

protected WebCSSHelper getCssHelper ()

protected Integer getRowHeightVal ()

protected HashList<String, String> getVisProps ()

protected void prepareToTransform (MarkupOutput out)

protected void renderRegisterBone (MarkupOutput out)

If a scriptClass is specified, this method registers the corresponding javascript bone for this component.

Parameters
out MarkupOutput whether the output should be rendered.