public interface

Layouts

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

Class Overview

The Layouts interface represents a collection of Layout objects. In addition to the standard collection-type methods, this interface exposes a method to return an in-memory representation of the layout associated with this style.

Summary

Public Methods
abstract void clear()
Clears the collection of layout objects.
abstract int getCount()
Returns the number of Layout objects in this collection.
abstract Layout getLayout(int index)
Gets the Layout associated with supplied index.
abstract LayoutTag getLayoutDefinition(LayoutParser desiredParser)
This method returns the in-memory representation of the layout definition to use with this specific style.
abstract Layout newLayout()
Creates a new layout object.
abstract void remove(int index)
Removes the Layout object at the specified index.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.config.ConfigurationElement

Public Methods

public abstract void clear ()

Clears the collection of layout objects.

Throws
UnsupportedOperationException This exception is thrown if the Style Catalog is in "read only" mode.

public abstract int getCount ()

Returns the number of Layout objects in this collection.

Returns
  • The count of layout objects.

public abstract Layout getLayout (int index)

Gets the Layout associated with supplied index. A valid index begins at 0 and continues to getCount() - 1.

Parameters
index The index of the Layout to return.
Returns
  • The Layout at the supplied index.
Throws
IndexOutOfBoundsException This exception is thown if the argument is outside the range of a valid index.

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). Individual Layout objects are ordered in this object by decreasing precedence order (see getOrder()). Each one is evaluated until the underlying layout returns a valid, non-null LayoutTag object.

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 Layout newLayout ()

Creates a new layout object.

Returns
  • The new layout object.
Throws
UnsupportedOperationException This exception is thrown if the Style Catalog is in "read only" mode.

public abstract void remove (int index)

Removes the Layout object at the specified index.

Parameters
index The index of the layout object to remove.
Throws
IndexOutOfBoundsException This exception is thown if the argument is outside the range of a valid index.
UnsupportedOperationException This exception is thrown if the Style Catalog is in "read only" mode.