public interface

Style

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

Class Overview

The Style interface exposes information about a single style.

Summary

Public Methods
abstract ActualParameters getActualParams()
Returns the Actual parameters associated with this style.
abstract String getDescription()
Returns the description of the style object.
abstract Layouts getLayouts()
Gets the collection of layouts associated with this style.
abstract String getName()
Returns the name of the style object.
abstract TransformDefn getTransformDefn()
Returns the transform definition object associated with this style.
abstract String getTransformName()
Returns the name of the transform definition associated with this style
abstract boolean isLayoutAware()
This method returns true if the underlying transform is "layout aware".
abstract boolean isResolved(StyleRequestContext context)
Returns whether all the required formal parameters of the transform have actual values associated with them.
abstract boolean isResolved()
Returns whether all the required formal parameters of the transform have actual values associated with them.
abstract void setDescription(String desc)
Sets the description of the style object.
abstract void setName(String name)
Sets the name of the style.
abstract void setName(String name, boolean overwrite)
This method is deprecated. The overwrite parameter should always be passed as true. If there is already an style with the given name it should be automatically replaced.
abstract void setTransformDefn(TransformDefn transformDefn)
This method is deprecated. The TransformDefn should not be explicitly set, it should be resolved automatically by the Style from the transform name.
abstract void setTransformName(String value)
Associates a the transform definition with this style based on its name
[Expand]
Inherited Methods
From interface com.microstrategy.utils.config.ConfigurationElement

Public Methods

public abstract ActualParameters getActualParams ()

Returns the Actual parameters associated with this style.

Returns

public abstract String getDescription ()

Returns the description of the style object.

Returns
  • description of the style object.

public abstract Layouts getLayouts ()

Gets the collection of layouts associated with this style.

Returns

public abstract String getName ()

Returns the name of the style object.

Returns
  • name of the style object.

public abstract TransformDefn getTransformDefn ()

Returns the transform definition object associated with this style.

Returns

public abstract String getTransformName ()

Returns the name of the transform definition associated with this style

Returns
  • name of the transform defn.

public abstract 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 abstract 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 abstract 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 abstract void setDescription (String desc)

Sets the description of the style object.

Parameters
desc the description of the style object.

public abstract void setName (String name)

Sets the name of the style.

Parameters
name the name of the style.
Throws
IllegalArgumentException thrown if the name is invalid or if it already exists and overwrite is false.

public abstract void setName (String name, boolean overwrite)

This method is deprecated.
The overwrite parameter should always be passed as true. If there is already an style with the given name it should be automatically replaced.

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 thrown if the name is invalid or if it already exists and overwrite is false.

public abstract void setTransformDefn (TransformDefn transformDefn)

This method is deprecated.
The TransformDefn should not be explicitly set, it should be resolved automatically by the Style from the transform name.

Sets the transform definition object of the style.

Parameters
transformDefn the TransformDefn object to set.
Throws
IllegalArgumentException thrown if the transform definition object is null.

public abstract void setTransformName (String value)

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