public abstract class

AbstractLayoutTransform

extends AbstractTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

This is the abstract base class for building layout-aware transforms. Note that this class does not explicitly implement the LayoutTransform interace, but provides implementations for all methods. A layout-aware transform must also explicitly declare its support for this interface.

Summary

Public Constructors
AbstractLayoutTransform()
Public Methods
LayoutTag getLayoutDefinition()
void setLayoutDefinition(LayoutTag layoutDefn)
boolean transformUsingLayout(Transformable data, MarkupOutput markup, boolean excludeStaticTags)
This method provides a way to transform the data using a supplied layout.
Protected Methods
LayoutContext getLayoutContext(Transformable data, boolean excludeStaticTags)
Gets the LayoutContext instance to use for any layout processing.
[Expand]
Inherited Methods
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.transform.Transform

Public Constructors

public AbstractLayoutTransform ()

Public Methods

public LayoutTag getLayoutDefinition ()

public void setLayoutDefinition (LayoutTag layoutDefn)

public boolean transformUsingLayout (Transformable data, MarkupOutput markup, boolean excludeStaticTags)

This method provides a way to transform the data using a supplied layout. If there is a layout and it is well formed, then the result is generated directly into the supplied markupOutput parameter and the method returns true. If there is no layout, the return code is false.

Parameters
data The data which is being transformed using an associated layout definition.
markup The generated content based on the associated layout definition.
excludeStaticTags True if you want to exclude all static tags in the generated content.
Returns
  • True if the layout is well-formed and it generates correct result.
Throws
WebTransformException thrown if there is any error at generating content.

Protected Methods

protected LayoutContext getLayoutContext (Transformable data, boolean excludeStaticTags)

Gets the LayoutContext instance to use for any layout processing.

Parameters
data The Transformable object we are processing
excludeStaticTags Whether to exclude static tags.
Returns