public class

LayoutsImpl

extends AbstractStyleCatalogList
implements Layouts
java.lang.Object
   ↳ com.microstrategy.utils.config.AbstractConfigurationElement
     ↳ com.microstrategy.utils.config.AbstractElementList
       ↳ com.microstrategy.web.transform.AbstractStyleCatalogList
         ↳ com.microstrategy.web.transform.LayoutsImpl

Class Overview

The LayoutsImpl class implements the Layout interface for the Style Catalog.

Summary

Constants
String NODE_LAYOUTS
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
LayoutsImpl()
Public Methods
Layout getLayout(int index)
Gets the Layout associated with supplied index.
Layout getLayout()
LayoutTag getLayoutDefinition(LayoutParser desiredParser)
This method returns the in-memory representation of the layout definition to use with this specific style.
Layout newLayout()
Creates a new layout object.
Protected Methods
Class getListClass()
Returns the Class items beloging to this list will be instance of.
String getListNodeName()
Returns the name of the node representing children of this list.
[Expand]
Inherited Methods
From class com.microstrategy.web.transform.AbstractStyleCatalogList
From class com.microstrategy.utils.config.AbstractElementList
From class com.microstrategy.utils.config.AbstractConfigurationElement
From class java.lang.Object
From interface com.microstrategy.utils.config.ConfigurationElement
From interface com.microstrategy.utils.config.ConfigurationFile
From interface com.microstrategy.web.transform.Layouts

Constants

protected static final String NODE_LAYOUTS

Constant Value: "Layouts"

Public Constructors

public LayoutsImpl ()

Public Methods

public 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

public Layout getLayout ()

public 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

public Layout newLayout ()

Creates a new layout object.

Returns
  • The new layout object.
Throws
UnsupportedOperationException

Protected Methods

protected Class getListClass ()

Returns the Class items beloging to this list will be instance of.

protected String getListNodeName ()

Returns the name of the node representing children of this list.