Package com.microstrategy.web.transform

Interface Style

  • All Superinterfaces:
    java.lang.Cloneable, ConfigurationElement
    All Known Implementing Classes:
    StyleImpl
    public interface Style
extends ConfigurationElement
    The Style interface exposes information about a single style.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Detail

      • getName

        java.lang.String getName()
        Returns the name of the style object.
        Returns:
        name of the style object.

      • setName

        void setName​(java.lang.String name,
             boolean overwrite)
      throws java.lang.IllegalArgumentException
        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:
        java.lang.IllegalArgumentException - thrown if the name is invalid or if it already exists and overwrite is false.

      • setName

        void setName​(java.lang.String name)
        Sets the name of the style.
        Parameters:
        name - the name of the style.
        Throws:
        java.lang.IllegalArgumentException - thrown if the name is invalid or if it already exists and overwrite is false.
        Since:
        MicroStrategy Web 9.0.0

      • getTransformName

        java.lang.String getTransformName()
        Returns the name of the transform definition associated with this style
        Returns:
        name of the transform defn.
        Since:
        MicroStrategy Web 9.0.0

      • setTransformName

        void setTransformName​(java.lang.String value)
        Associates a the transform definition with this style based on its name
        Since:
        MicroStrategy Web 9.0.0

      • getDescription

        java.lang.String getDescription()
        Returns the description of the style object.
        Returns:
        description of the style object.

      • setDescription

        void setDescription​(java.lang.String desc)
        Sets the description of the style object.
        Parameters:
        desc - the description of the style object.

      • getTransformDefn

        TransformDefn getTransformDefn()
        Returns the transform definition object associated with this style.
        Returns:
        the TransformDefn object associated with the style.

      • setTransformDefn

        void setTransformDefn​(TransformDefn transformDefn)
               throws java.lang.IllegalArgumentException
        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:
        java.lang.IllegalArgumentException - thrown if the transform definition object is null.

      • getActualParams

        ActualParameters getActualParams()
        Returns the Actual parameters associated with this style.
        Returns:
        the ActualParameters object associated with this style.

      • isResolved

        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.

      • isLayoutAware

        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.
        Since:
        MicroStrategy Web 8.0.0

      • getLayouts

        Layouts getLayouts()
        Gets the collection of layouts associated with this style.
        Returns:
        The Layouts collection.
        Since:
        MicroStrategy Web 8.0.0

      • isResolved

        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.
        Since:
        MicroStrategy Web 8.0.0