Interface Layouts

  • All Superinterfaces:
    java.lang.Cloneable, ConfigurationElement
    All Known Implementing Classes:
    LayoutsImpl

    public interface Layouts
    extends ConfigurationElement
    The Layouts interface represents a collection of Layout objects. In addition to the standard collection-type methods, this interface exposes a method to return an in-memory representation of the layout associated with this style.
    Since:
    MicroStrategy Web 8.0.0
    • Method Detail

      • getCount

        int getCount()
        Returns the number of Layout objects in this collection.
        Returns:
        The count of layout objects.
      • getLayout

        Layout getLayout​(int index)
                  throws java.lang.IndexOutOfBoundsException
        Gets the Layout associated with supplied index. A valid index begins at 0 and continues to getCount() - 1.
        Parameters:
        index - The index of the Layout to return.
        Returns:
        The Layout at the supplied index.
        Throws:
        java.lang.IndexOutOfBoundsException - This exception is thown if the argument is outside the range of a valid index.
      • clear

        void clear()
            throws java.lang.UnsupportedOperationException
        Clears the collection of layout objects.
        Throws:
        java.lang.UnsupportedOperationException - This exception is thrown if the Style Catalog is in "read only" mode.
      • remove

        void remove​(int index)
             throws java.lang.IndexOutOfBoundsException,
                    java.lang.UnsupportedOperationException
        Removes the Layout object at the specified index.
        Parameters:
        index - The index of the layout object to remove.
        Throws:
        java.lang.IndexOutOfBoundsException - This exception is thown if the argument is outside the range of a valid index.
        java.lang.UnsupportedOperationException - This exception is thrown if the Style Catalog is in "read only" mode.
      • newLayout

        Layout newLayout()
                  throws java.lang.UnsupportedOperationException
        Creates a new layout object.
        Returns:
        The new layout object.
        Throws:
        java.lang.UnsupportedOperationException - This exception is thrown if the Style Catalog is in "read only" mode.
      • getLayoutDefinition

        LayoutTag getLayoutDefinition​(LayoutParser desiredParser)
                               throws WebTransformException
        This method returns the in-memory representation of the layout definition to use with this specific style. This object may be the result of a parse operation or it may have been previously cached (and simply returned). Individual Layout objects are ordered in this object by decreasing precedence order (see Layout.getOrder()). Each one is evaluated until the underlying layout returns a valid, non-null LayoutTag object.
        Parameters:
        desiredParser - If a layout definition needs to be parsed, then use the supplied LayoutParser object.
        Returns:
        The in-memory representation of the layout definition (in the form of a root
        Throws:
        WebTransformException - thrown if there is any error occurred. LayoutTag tag).