Package com.microstrategy.web.transform

Class StylesImpl

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.utils.config.AbstractElementList

com.microstrategy.web.transform.AbstractStyleCatalogList

com.microstrategy.web.transform.StylesImpl

All Implemented Interfaces:

ConfigurationElement, ConfigurationFile, Styles, java.lang.Cloneable

public class StylesImpl
extends AbstractStyleCatalogList
implements Styles

Since:

MicroStrategy Web 7.3.1 or earlier

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_STYLES

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
StylesImpl()

Method Summary

Modifier and Type	Method	Description
void	addStyle(Style style)	Adds a style object to the collection.
void	copyContents(Style styleSource, Style styleDest)	Copies the contents of a style into another 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.
Style	getStyle(int index)	Retrieves a specific Style object by its numeric index.
Style	getStyle(java.lang.String name)	Retrieves a specific Style object by its name.
Style	newStyle(java.lang.String styleName)	Creates a new Style object and adds it to the collection.

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

clear, getCount, remove, remove

Field Detail

NODE_STYLES

protected static final java.lang.String NODE_STYLES

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

Constructor Detail

StylesImpl

public StylesImpl()

Since:

MicroStrategy Web 9.0.0

Method Detail

getStyle

public Style getStyle(int index)
               throws java.lang.IndexOutOfBoundsException

Description copied from interface: Styles

Retrieves a specific Style object by its numeric index.

Specified by:

getStyle in interface Styles

Parameters:

index - the index of the Style object in collection.

Returns:

the Style object in the collection with the given index.

Throws:

java.lang.IndexOutOfBoundsException - thrown if the index is invalid.

getStyle

public Style getStyle(java.lang.String name)

Description copied from interface: Styles

Retrieves a specific Style object by its name.
Returns null if no style exists with the given name in the style catalog.

Specified by:

getStyle in interface Styles

Parameters:

name - the name of the Style object.

Returns:

the Style object in the collection with the given name.

newStyle

public Style newStyle(java.lang.String styleName)
               throws java.lang.IllegalArgumentException,
                      java.lang.UnsupportedOperationException

Description copied from interface: Styles

Creates a new Style object and adds it to the collection.

Specified by:

newStyle in interface Styles

Parameters:

styleName - the name of the new Style object.

Returns:

the Style object just created.

Throws:

java.lang.IllegalArgumentException - thrown if the styleName is used by another Style object in the collection or if the style name is empty.

java.lang.UnsupportedOperationException - thrown if the collection is read-only.

addStyle

public void addStyle(Style style)

Description copied from interface: Styles

Adds a style object to the collection. If the style already exists, it is overwritten.

Specified by:

addStyle in interface Styles

Parameters:

style - The style object to be added to the collection.

copyContents

public void copyContents(Style styleSource,
                         Style styleDest)

Description copied from interface: Styles

Copies the contents of a style into another style.

Specified by:

copyContents in interface Styles

Parameters:

styleSource - the source style to copy the contents from.

styleDest - the destination style to copy the contents to.

Since:

MicroStrategy Web 9.0.0

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