Package com.microstrategy.web.objects

Interface WebFormatContainer

  • All Known Subinterfaces:
    WebTemplateFormatContainer
    public interface WebFormatContainer
    This is a container of WebFormat objects. It exists on the template, as part of every WebTemplateUnit, WebAxis, and WebTemplateMetric object. This class contains the formatting information for the object which it came from, and can be modified to change the formatting of the owner object.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      WebFormat getGridFormat()
      Returns the grid format object.
      WebFormat getHeaderFormat()
      Returns the header format object.
      WebFormat getSubtotalGridFormat()
      Returns the subtotal grid format object.
      WebFormat getSubtotalHeaderFormat()
      Returns the subtotal header format object.
      void setDefaultFormat​(int formatType)
      Set the indicated type of format (header, grid, subtotal header, or subtotal grid) object to its default value.
      void setDefaultFormat​(int formatType, boolean propagate)
      Set the indicated type of format (header, grid, subtotal header, or subtotal grid) object to its default value.
      void setDefaultFormats()
      This method sets all format objects in this container to the default values.
      void setDefaultFormats​(boolean propagate)
      Sets all format objects in this container to the default format.
      void setDefaultForProperty​(int formatType, java.lang.String propertySetName, java.lang.String propertyName)
      Set the default value for a specific format property.
      void setDefaultForProperty​(int formatType, java.lang.String propertySetName, java.lang.String propertyName, boolean propagate)
      Set the default value for a specific format property.
      void setFormatProperty​(int formatType, java.lang.String propertySetName, java.lang.String propertyName, java.lang.String value)
      Sets the value for a specific format property.
      void setFormatProperty​(int formatType, java.lang.String propertySetName, java.lang.String propertyName, java.lang.String value, boolean propagate)
      Sets the value for a specific format property.

    • Method Detail

      • getHeaderFormat

        WebFormat getHeaderFormat()
        Returns the header format object. This can be used to examine or change the header format of the object.
        Returns:
        A WebFormat object, which contains all of the header format information.

      • getGridFormat

        WebFormat getGridFormat()
        Returns the grid format object. This can be used to examine or change the grid format of the object.
        Returns:
        A WebFormat object, which contains all of the grid format information.

      • getSubtotalHeaderFormat

        WebFormat getSubtotalHeaderFormat()
                           throws java.lang.UnsupportedOperationException
        Returns the subtotal header format object. This can be used to examine or change the subtotal header format of the object. Note that if the format container came from a WebTemplateMetric object, it has no subtotal header format associated with it.
        Returns:
        A WebFormat object, which contains all of the subtotal header format information.
        Throws:
        java.lang.UnsupportedOperationException - Thrown if the object which the format container came from was a WebTemplateMetric object.

      • getSubtotalGridFormat

        WebFormat getSubtotalGridFormat()
                         throws java.lang.UnsupportedOperationException
        Returns the subtotal grid format object. This can be used to examine or change the subtotal grid format of the object. Note that if the format container came from a WebTemplateMetric object, it has no subtotal grid format associated with it.
        Returns:
        A WebFormat object, which contains all of the subtotal grid format information.
        Throws:
        java.lang.UnsupportedOperationException - Thrown if the object which the format container came from was a WebTemplateMetric object.

      • setDefaultFormats

        void setDefaultFormats()
        This method sets all format objects in this container to the default values.

      • setDefaultFormats

        void setDefaultFormats​(boolean propagate)
        Sets all format objects in this container to the default format. If the propagate option is set to true, then if the unit which contains this format container has child units which can contain format containers, this method will also set those objects to the default values.
        Parameters:
        propagate - If this is true, the effects of this method will be propagated to child units of the unit the format container came from.

      • setDefaultFormat

        void setDefaultFormat​(int formatType)
               throws java.lang.IllegalArgumentException,
                      java.lang.UnsupportedOperationException
        Set the indicated type of format (header, grid, subtotal header, or subtotal grid) object to its default value.
        Parameters:
        formatType - A value from EnumWebFormatType to indicate the format type which will be reset to its default value.
        Throws:
        java.lang.IllegalArgumentException - If formatType is not in the EnumWebFormatType enumeration, or the type passed in does not exist on the object this format container was obtained from, this error will be thrown.
        java.lang.UnsupportedOperationException - If the type passed in does not exist on the object this format container was obtained from (i.e. a subtotal-related format on a metric), this error will be thrown.

      • setDefaultFormat

        void setDefaultFormat​(int formatType,
                      boolean propagate)
               throws java.lang.IllegalArgumentException,
                      java.lang.UnsupportedOperationException
        Set the indicated type of format (header, grid, subtotal header, or subtotal grid) object to its default value. If the propagate option is set to true, then if the unit which contains this format container has child units which can contain format containers, this method will also set those format objects to the default values.
        Parameters:
        formatType - A value from EnumWebFormatType to indicate the format type which will be reset to its default value.
        propagate - If this is true, the effects of this method will be propagated to child units of the unit the format container came from.
        Throws:
        java.lang.IllegalArgumentException - If formatType is not in the EnumWebFormatType enumeration, this error will be thrown.
        java.lang.UnsupportedOperationException - If the type passed in does not exist on the object this format container was obtained from (i.e. a subtotal-related format on a metric), this error will be thrown.

      • setDefaultForProperty

        void setDefaultForProperty​(int formatType,
                           java.lang.String propertySetName,
                           java.lang.String propertyName)
                    throws java.lang.IllegalArgumentException,
                           java.lang.UnsupportedOperationException
        Set the default value for a specific format property.
        Parameters:
        formatType - A value from EnumWebFormatType which indicates the format type.
        propertySetName - The name of the property set.
        propertyName - The name of the property.
        Throws:
        java.lang.IllegalArgumentException - Thrown if the formatType is not one of the values in EnumWebFormatType.
        java.lang.UnsupportedOperationException - Thrown if the format type given does not exist in this format container. This will happen when specifying one of the subtotal format objects when the format container came from a template metric.

      • setDefaultForProperty

        void setDefaultForProperty​(int formatType,
                           java.lang.String propertySetName,
                           java.lang.String propertyName,
                           boolean propagate)
                    throws java.lang.IllegalArgumentException,
                           java.lang.UnsupportedOperationException
        Set the default value for a specific format property. If the propagate option is set to true, then if the unit which contains this format container has child units which can contain format containers, this method will propagate the changes made by this method to those objects.
        Parameters:
        formatType - A value from EnumWebFormatType which indicates the format type.
        propertySetName - The name of the property set.
        propertyName - The name of the property.
        propagate - If this is true, the effects of this method will be propagated to child units of the unit the format container came from.
        Throws:
        java.lang.IllegalArgumentException - Thrown if the formatType is not one of the values in EnumWebFormatType.
        java.lang.UnsupportedOperationException - Thrown if the format type given does not exist in this format container. This will happen when specifying one of the subtotal format objects when the format container came from a template metric.

      • setFormatProperty

        void setFormatProperty​(int formatType,
                       java.lang.String propertySetName,
                       java.lang.String propertyName,
                       java.lang.String value)
                throws java.lang.IllegalArgumentException,
                       java.lang.UnsupportedOperationException
        Sets the value for a specific format property.
        Parameters:
        formatType - A value from EnumWebFormatType specifying the format object whose value will be changed.
        propertySetName - The name of the property set.
        propertyName - The name of the property.
        value - The value to be set for the specified property.
        Throws:
        java.lang.IllegalArgumentException - Thrown if the format type is not a valid type.
        java.lang.UnsupportedOperationException - Thrown if the given format type does not exist for the object which the format container was obtained from.

      • setFormatProperty

        void setFormatProperty​(int formatType,
                       java.lang.String propertySetName,
                       java.lang.String propertyName,
                       java.lang.String value,
                       boolean propagate)
                throws java.lang.IllegalArgumentException,
                       java.lang.UnsupportedOperationException
        Sets the value for a specific format property. If the propagate option is set to true, then if the unit which contains this format container has child units which can contain format containers, this method will propagate the changes made by this method to those objects.
        Parameters:
        formatType - A value from EnumWebFormatType specifying the format object whose value will be changed.
        propertySetName - The name of the property set.
        propertyName - The name of the property.
        value - The value to be set for the specified property.
        propagate - If this is true, the effects of this method will be propagated to child units of the unit the format container came from.
        Throws:
        java.lang.IllegalArgumentException - Thrown if the format type is not a valid type.
        java.lang.UnsupportedOperationException - Thrown if the given format type does not exist for the object which the format container was obtained from.