public interface

Layout

implements ConfigurationElement
com.microstrategy.web.transform.Layout
Known Indirect Subclasses

Class Overview

The Layout interface represents a single layout that is associated with a style. It consists of three fundamental components:

  • A layout "locator" which identifies where a layout can be found
  • A layout source which uses the layout location to find the associated definition source and convert it into an in-memory representation.
  • A precedence order property which defines the order in which this layout should be searched. The Layouts interface will inspect layouts in order of decreasing precedence order.
This interface also exposes a top-level method to return the in-memory representation of the layout, in the form of a LayoutTag object.

Summary

Public Methods
abstract LayoutTag getLayoutDefinition(LayoutParser desiredParser)
This method returns the in-memory representation of the layout definition to use with this specific style.
abstract String getLayoutLocator()
This method returns the layout locator string associated with this layout.
abstract LayoutSourceDefn getLayoutSourceDefn()
This method returns the LayoutSourceDefn object associated with this layout.
abstract String getLayoutSourceName()
Return the name of the LayoutSourceDefn currently associated with this Layout.
abstract int getOrder()
This method is deprecated. The order is not relevant anymore as there can only be one Layout associated with a Style.
abstract void setLayoutLocator(String layoutLocator)
This method sets the layout locator (String) associated with this layout.
abstract void setLayoutSourceDefn(LayoutSourceDefn layoutSourceDefn)
This method is deprecated. The LayoutSourceDefn should not be explicitly set, it should be resolved automatically by the Layout automatically from the LayoutSourceName property.
abstract void setLayoutSourceName(String name)
Associates a LayoutSourceDefn with this Layout based on its name.
abstract void setOrder(int order)
This method is deprecated. The order is not relevant anymore as there can only be one Layout associated with a Style.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.config.ConfigurationElement

Public Methods

public abstract LayoutTag getLayoutDefinition (LayoutParser desiredParser)

This method returns the in-memory representation of the layout definition to use with this specific style. This object may be the result of a parse operation or it may have been previously cached (and simply returned).

Parameters
desiredParser If a layout definition needs to be parsed, then use the supplied LayoutParser object.
Returns
  • The in-memory representation of the layout definition (in the form of a root
Throws
WebTransformException thrown if there is any error occurred. LayoutTag tag).

public abstract String getLayoutLocator ()

This method returns the layout locator string associated with this layout.

Returns
  • The layout "location" as a String.

public abstract LayoutSourceDefn getLayoutSourceDefn ()

This method returns the LayoutSourceDefn object associated with this layout. The underlying LayoutSource object instance is used to perform the actual retrieval of the layout definition.

Returns

public abstract String getLayoutSourceName ()

Return the name of the LayoutSourceDefn currently associated with this Layout.

public abstract int getOrder ()

This method is deprecated.
The order is not relevant anymore as there can only be one Layout associated with a Style.

This method returns the precedence order of this specific layout. The higher the number, the earlier it will get evaluated.

Returns
  • The numeric value of the precedence order.

public abstract void setLayoutLocator (String layoutLocator)

This method sets the layout locator (String) associated with this layout.

Parameters
layoutLocator The string representation of the layout location. The actual syntax is defined by the LayoutSource object it is associated with.

public abstract void setLayoutSourceDefn (LayoutSourceDefn layoutSourceDefn)

This method is deprecated.
The LayoutSourceDefn should not be explicitly set, it should be resolved automatically by the Layout automatically from the LayoutSourceName property.

This method sets the LayoutSourceDefn object associated with this layout. The underlying LayoutSource object instance is used to perform the actual retrieval of the layout definition.

Parameters
layoutSourceDefn The LayoutSourceDefn object instance to use.

public abstract void setLayoutSourceName (String name)

Associates a LayoutSourceDefn with this Layout based on its name.

public abstract void setOrder (int order)

This method is deprecated.
The order is not relevant anymore as there can only be one Layout associated with a Style.

This method sets the precedence order of this specific layout. The higher the number, the earlier it will get evaluated.

Parameters
order The numeric value of the precedence order.