Package com.microstrategy.web.transform

Class LayoutsImpl

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.utils.config.AbstractElementList

com.microstrategy.web.transform.AbstractStyleCatalogList

com.microstrategy.web.transform.LayoutsImpl

All Implemented Interfaces:

ConfigurationElement, ConfigurationFile, Layouts, java.lang.Cloneable

public class LayoutsImpl
extends AbstractStyleCatalogList
implements Layouts

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

Since:

MicroStrategy Web 8.0.0

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

AbstractConfigurationElement.FilteredList

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	NODE_LAYOUTS

Fields inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

ATT_CONFIG_SRC, ATT_DELETED, ATT_POSITION, ATT_PROTOTYPE, ATT_USE_DEFAULT

Constructor Summary

Constructors

Constructor	Description
LayoutsImpl()

Method Summary

Modifier and Type	Method	Description
Layout	getLayout()
Layout	getLayout(int index)	Gets the Layout associated with supplied index.
LayoutTag	getLayoutDefinition(LayoutParser desiredParser)	This method returns the in-memory representation of the layout definition to use with this specific style.
protected java.lang.Class	getListClass()	Returns the Class items beloging to this list will be instance of.
protected java.lang.String	getListNodeName()	Returns the name of the node representing children of this list.
Layout	newLayout()	Creates a new layout object.

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

clearCaches, getCount, getStyleCatalog, newItem, reload, remove, remove

Methods inherited from class com.microstrategy.utils.config.AbstractElementList

clear, containsKey, get, get, getKeyAttribute, getList, isEmpty, put, put, size

Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

addFileSource, applyCustomization, applyCustomizations, cleanUpDeletedElements, clone, delete, deltas, deltas, equalAtts, equalElements, equalNodeValues, equals, equalsIncludingDeletedElements, exportAttributesToXML, exportElementsToXML, exportNodeValueToXML, getAttribute, getAttributes, getBoolAttribute, getChildKey, getConfigSrc, getDTDFileName, getElement, getElement, getElements, getFileLoader, getIntAttribute, getIntAttribute, getKey, getLineNumber, getList, getNextKey, getNodeName, getNodeValue, getNodeValue, getOrCreateElement, getParent, getPosition, getPrototype, getRegisteredClass, getSelfInitPath, getSource, getStrAttribute, getUseDefault, getXMLParserParameters, getXMLSerializerParameters, hashCode, hashCodeAtts, hashCodeElements, hashCodeNodeValues, hasRegisteredClass, initAttributesFromXML, initDefaultAttributes, initElementFromXML, initElementsFromXML, initFromFile, initFromResource, initFromXML, initFromXML, initNodeValueFromXML, initPrototype, isActive, isCustomized, isDeleted, isDirty, isInSource, isKeyAttribute, load, mergeChanges, newChildInstance, newSource, original, populate, printAttributes, printElements, printNodeValue, refreshLists, registerClass, registerElement, registerElement, registerElementList, reloadPrototype, removeAttribute, removeDefaults, replaceList, restore, save, save, saveChangesAs, saveConfig, saveFlatXML, saveNode, saveSource, setAttribute, setBoolAttribute, setChildOriginals, setConfigSrc, setCustomized, setElement, setFileLoader, setIntAttribute, setKey, setLineNumber, setNodeName, setNodeValue, setPosition, setPrototype, setSelfInitPath, setStrAttribute, setUseDefault, setUseValidation, throwConfigParseException, toString, toXML, toXML, toXML, toXML, useNodeValue, useValidation

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.microstrategy.utils.config.ConfigurationElement

getAttribute, getAttributes, getElement, getElements, getKey, getNodeName, getStrAttribute, initFromXML, reload, toXML

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

clear, getCount, remove

Field Detail

NODE_LAYOUTS

protected static final java.lang.String NODE_LAYOUTS

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

Constructor Detail

LayoutsImpl

public LayoutsImpl()

Since:

MicroStrategy Web 9.0.0

Method Detail

getLayout

public Layout getLayout(int index)
                 throws java.lang.IndexOutOfBoundsException

Description copied from interface: Layouts

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

Specified by:

getLayout in interface Layouts

Parameters:

index - The index of the Layout to return.

Returns:

The Layout at the supplied index.

Throws:

java.lang.IndexOutOfBoundsException - This exception is thown if the argument is outside the range of a valid index.

getLayout

public Layout getLayout()

Since:

MicroStrategy Web 9.0.0

newLayout

public Layout newLayout()
                 throws java.lang.UnsupportedOperationException

Description copied from interface: Layouts

Creates a new layout object.

Specified by:

newLayout in interface Layouts

Returns:

The new layout object.

Throws:

java.lang.UnsupportedOperationException - This exception is thrown if the Style Catalog is in "read only" mode.

getLayoutDefinition

public LayoutTag getLayoutDefinition(LayoutParser desiredParser)
                              throws WebTransformException

Description copied from interface: Layouts

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 Layout.getOrder()). Each one is evaluated until the underlying layout returns a valid, non-null LayoutTag object.

Specified by:

getLayoutDefinition in interface Layouts

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).

getListClass

protected java.lang.Class getListClass()

Description copied from class: AbstractElementList

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

Specified by:

getListClass in class AbstractElementList

Since:

MicroStrategy Web 9.0.0

getListNodeName

protected java.lang.String getListNodeName()

Description copied from class: AbstractElementList

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

Specified by:

getListNodeName in class AbstractElementList

Since:

MicroStrategy Web 9.0.0