Class AbstractLayoutTransform

  • All Implemented Interfaces:
    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.
    MicroStrategy Web 8.0.0
    • 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.
        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.
        True if the layout is well-formed and it generates correct result.
        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.
        data - The Transformable object we are processing
        excludeStaticTags - Whether to exclude static tags.
        A LayoutContext object.
        MicroStrategy Web 9.0.0