Package com.microstrategy.web.objects

Interface RWIterateSettings

  • public interface RWIterateSettings
    Since:
    MicroStrategy Web 8.1.0

    • Field Detail

      • VISIBLE_ONLY_ALL

        static final int[] VISIBLE_ONLY_ALL

      • VISIBLE_ONLY_NONE

        static final int[] VISIBLE_ONLY_NONE

      • VISIBLE_ONLY_HEADER_FOOTER_DETAIL

        static final int[] VISIBLE_ONLY_HEADER_FOOTER_DETAIL

    • Method Detail

      • setDesignMode

        void setDesignMode​(boolean isDesignMode)

      • isDesignMode

        boolean isDesignMode()

      • setLayoutKey

        void setLayoutKey​(java.lang.String key)

      • getLayoutKey

        java.lang.String getLayoutKey()

      • setVisitVisibleOnly

        void setVisitVisibleOnly​(int[] visibleOnly)
        Array of EnumRWUnitTypes determines the unit types that will be iterated only if they are visible.
        Parameters:
        visibleOnly - EnumRWUnitTypes of units that will be iterated only if they are visible.

      • visitVisibleOnly

        int[] visitVisibleOnly()
        Returns:
        EnumRWUnitTypes of units that will be iterated only if they are visible.

      • visitVisibleOnly

        boolean visitVisibleOnly​(RWUnit unit)
                  throws WebObjectsException
        Check whether a unit type is in a given array of acceptable matches. If unit is null or visible only array is VISIBLE_ONLY_NONE, false is returned. If the visible only array is length 0, true is returned.
        Parameters:
        unit - unit to test
        Returns:
        whether the given unit type is in the visible only array.
        Throws:
        WebObjectsException
        See Also:
        visitVisibleOnly()

      • setSuppressEmptySections

        void setSuppressEmptySections​(boolean suppress)
        Parameters:
        suppress - whether to omit sections that have no subsections.

      • suppressEmptySections

        boolean suppressEmptySections()
        Whether to omit sections that have no subsections. This works in conjunction with setVisitVisibleOnly(int[]) when non-visible subsections are suppressed. By default, this is true.
        Returns:
        whether to omit sections that have no (visible) subsections.