Package com.microstrategy.web.transform

Class AbstractLayoutTransform

java.lang.Object

com.microstrategy.web.transform.AbstractTransform

com.microstrategy.web.transform.AbstractLayoutTransform

All Implemented Interfaces:

Transform

Direct Known Subclasses:

AbstractAppTransform, AbstractPromptObjectTransform, ResultSetStatusTransform

public abstract class AbstractLayoutTransform
extends AbstractTransform

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.

Since:

MicroStrategy Web 8.0.0

Constructor Summary

Constructors

Constructor	Description
AbstractLayoutTransform()

Method Summary

Modifier and Type	Method	Description
protected LayoutContext	getLayoutContext(Transformable data, boolean excludeStaticTags)	Gets the LayoutContext instance to use for any layout processing.
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.

Methods inherited from class com.microstrategy.web.transform.AbstractTransform

addFormalParam, canTransform, getEvents, getFormalParams, getID, getPreview, isPreviewAvailable, isResolved, removeFormalParam, setAnnotation, setDeprecated, supports, supports

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.microstrategy.web.transform.Transform

getDescription, getSupportedBeanType, transform

Constructor Detail

AbstractLayoutTransform

public AbstractLayoutTransform()

Method Detail

getLayoutDefinition

public LayoutTag getLayoutDefinition()

setLayoutDefinition

public void setLayoutDefinition(LayoutTag layoutDefn)

transformUsingLayout

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

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.

getLayoutContext

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:

A LayoutContext object.

Since:

MicroStrategy Web 9.0.0