public class

StyleImpl

extends AbstractStyleCatalogElement
implements Style
java.lang.Object
   ↳ com.microstrategy.utils.config.AbstractConfigurationElement
     ↳ com.microstrategy.web.transform.AbstractStyleCatalogElement
       ↳ com.microstrategy.web.transform.StyleImpl

Class Overview

This class implements the Style interface, which exposes information about a single style.

Summary

Constants
String ATT_DESCRIPTION
String ATT_NAME
String ATT_TRANSFORM
String NODE_STYLE
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
StyleImpl()
Public Methods
ActualParameters getActualParams()
Returns the Actual parameters associated with this style.
String getDescription()
Returns the description of the style object.
Layouts getLayouts()
Gets the collection of layouts associated with this style.
String getName()
Returns the name of the style object.
TransformDefn getTransformDefn()
Returns the transform definition object associated with this style.
String getTransformName()
Returns the name of the transform definition associated with this style
boolean isLayoutAware()
This method returns true if the underlying transform is "layout aware".
boolean isResolved(StyleRequestContext context)
Returns whether all the required formal parameters of the transform have actual values associated with them.
boolean isResolved()
Returns whether all the required formal parameters of the transform have actual values associated with them.
void setDescription(String desc)
Sets the description of the style object.
void setName(String _name)
Sets the name of the style.
void setName(String _name, boolean overwrite)
Sets the name of the style.
void setTransformDefn(TransformDefn transformDefn)
Sets the transform definition object of the style.
void setTransformName(String value)
Associates a the transform definition with this style based on its name
Protected Methods
void clearCaches()
This method is invoked whenever the structure of the style catalog has changed and caches to other objects in the structure needs to be updated.
String getKeyAttribute()
This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.
[Expand]
Inherited Methods
From class com.microstrategy.web.transform.AbstractStyleCatalogElement
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.Style

Constants

protected static final String ATT_DESCRIPTION

Constant Value: "description"

protected static final String ATT_NAME

Constant Value: "name"

protected static final String ATT_TRANSFORM

Constant Value: "transform"

protected static final String NODE_STYLE

Constant Value: "Style"

Public Constructors

public StyleImpl ()

Public Methods

public ActualParameters getActualParams ()

Returns the Actual parameters associated with this style.

Returns

public String getDescription ()

Returns the description of the style object.

Returns
  • description of the style object.

public Layouts getLayouts ()

Gets the collection of layouts associated with this style.

Returns

public String getName ()

Returns the name of the style object.

Returns
  • name of the style object.

public TransformDefn getTransformDefn ()

Returns the transform definition object associated with this style.

Returns

public String getTransformName ()

Returns the name of the transform definition associated with this style

Returns
  • name of the transform defn.

public boolean isLayoutAware ()

This method returns true if the underlying transform is "layout aware". This translates into saying whether the underlying Transform implements the LayoutTransform interface.

Returns
  • True if the underlying transform is layout aware.

public boolean isResolved (StyleRequestContext context)

Returns whether all the required formal parameters of the transform have actual values associated with them. A style is resolved if there is at least one actual parameter whose value matches the type of a required formal parameter.

Parameters
context a StyleRequestContext object used to look up the dynamic actual parameter value.
Returns
  • True if the style is resolved.

public boolean isResolved ()

Returns whether all the required formal parameters of the transform have actual values associated with them.

Returns
  • whether the transform is resolved or not.

public void setDescription (String desc)

Sets the description of the style object.

Parameters
desc the description of the style object.

public void setName (String _name)

Sets the name of the style.

Parameters
_name the name of the style.

public void setName (String _name, boolean overwrite)

Sets the name of the style.

Parameters
_name the name of the style.
overwrite whether an existing style with that name will be overwritten.
Throws
IllegalArgumentException

public void setTransformDefn (TransformDefn transformDefn)

Sets the transform definition object of the style.

Parameters
transformDefn the TransformDefn object to set.
Throws
IllegalArgumentException

public void setTransformName (String value)

Associates a the transform definition with this style based on its name

Protected Methods

protected void clearCaches ()

This method is invoked whenever the structure of the style catalog has changed and caches to other objects in the structure needs to be updated.

protected String getKeyAttribute ()

This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.