Package com.microstrategy.web.objects.rw

Interface RWExportSettings

  • All Known Subinterfaces:
    RWExcelExportSettings
    public interface RWExportSettings
    Represents export settings.
    Since:
    MicroStrategy Web 8.0.0

    • Field Detail

      • PROPERTY_DEFAULT_PAGE_BY_EXPORT_MODE

        static final java.lang.String PROPERTY_DEFAULT_PAGE_BY_EXPORT_MODE
        See Also:
        Constant Field Values

      • PROPERTY_EXPORT_RANGE

        static final java.lang.String PROPERTY_EXPORT_RANGE
        See Also:
        Constant Field Values

    • Method Detail

      • setMode

        void setMode​(int exportMode)
        Sets the export mode. Possible values are from EnumRWExportModes
        Parameters:
        exportMode -

      • getMode

        int getMode()
        returns the export mode
        Returns:
        the export mode

      • setStateID

        void setStateID​(int stateID)
        Sets the state id of a RW manipulation. This is for canceling.
        Parameters:
        stateID -

      • getStateID

        int getStateID()
        Gets the state id of a RW manipulation. This is to restore / refresh document state after canceling exporting.
        Returns:

      • getExportPaperHeight

        java.lang.String getExportPaperHeight()

      • getExportPaperWidth

        java.lang.String getExportPaperWidth()

      • getExportOrientation

        int getExportOrientation()

      • getExportPDFHeader

        int getExportPDFHeader()

      • getExportPDFFooter

        int getExportPDFFooter()

      • getExportOverview

        int getExportOverview()

      • getExportViz

        int getExportViz()

      • getHtmlDelayTime

        int getHtmlDelayTime()

      • setExportPaperWidth

        void setExportPaperWidth​(java.lang.String exportPaperWidth)

      • setExportPaperHeight

        void setExportPaperHeight​(java.lang.String exportPaperHeight)

      • setExportOrientation

        void setExportOrientation​(int exportOrientation)

      • setExportPDFHeader

        void setExportPDFHeader​(int exportPDFHeader)

      • setExportPDFFooter

        void setExportPDFFooter​(int exportPDFFooter)

      • setExportOverview

        void setExportOverview​(int exportOverview)

      • setExportViz

        void setExportViz​(int exportViz)

      • setHtmlDelayTime

        void setHtmlDelayTime​(int htmlDelayTime)

      • getPassword

        java.lang.String getPassword()

      • setPassword

        void setPassword​(java.lang.String p)

      • getViewportWidth

        int getViewportWidth()

      • setViewportWidth

        void setViewportWidth​(int width)

      • getViewportHeight

        int getViewportHeight()

      • setViewportHeight

        void setViewportHeight​(int height)

      • getTableOfContents

        int getTableOfContents()

      • setTableOfContents

        void setTableOfContents​(int enabled)

      • setFilterSummary

        void setFilterSummary​(int filterSummary)

      • getFilterSummary

        int getFilterSummary()

      • setGridPagingMode

        void setGridPagingMode​(int mode)

      • getGridPagingMode

        int getGridPagingMode()

      • setGridHorizontalPagination

        void setGridHorizontalPagination​(int allowed)

      • getGridHorizontalPagination

        int getGridHorizontalPagination()

      • setGridRepeatHeader

        void setGridRepeatHeader​(int repeat)

      • getGridRepeatHeader

        int getGridRepeatHeader()

      • setHtml5Vi

        void setHtml5Vi​(boolean isHtml5Vi)

      • getHtml5Vi

        boolean getHtml5Vi()

      • setIsNewExportSetting

        void setIsNewExportSetting​(boolean isNewExportSetting)

      • getIsNewExportSetting

        boolean getIsNewExportSetting()

      • setGridKey

        void setGridKey​(java.lang.String gridKey)
        Sets the grid key.
        Parameters:
        gridKey -

      • getGridKey

        java.lang.String getGridKey()
        returns the grid key
        Returns:
        the grid key

      • setNodeKeys

        void setNodeKeys​(java.util.List<java.lang.String> nodeKeys)
        Sets the node keys.
        Parameters:
        nodeKeys -

      • getNodeKeys

        java.util.List<java.lang.String> getNodeKeys()
        returns the node keys
        Returns:
        the node keys to be exported

      • setSliceId

        void setSliceId​(int sliceId)
        Sets the ID of the slice to export. If a positive ID is set, it will be used for export.
        Parameters:
        sliceId -
        Since:
        MicroStrategy Web 10.0.0

      • getSliceId

        int getSliceId()
        Gets the ID of the slice to export.
        Returns:
        the ID of the slice to export
        Since:
        MicroStrategy Web 10.0.0

      • setOnetierVersion

        void setOnetierVersion​(int oneTierVersion)
        Sets the version of the onetier (desktop) client
        Parameters:
        oneTierVersion -

      • getOnetierVersion

        int getOnetierVersion()
        Returns:
        the version of the onetier (desktop) client

      • setSio

        void setSio​(int sio)
        Sets the sio(mSubtotalPositionInOutlineMode) to export.
        Parameters:
        sio -

      • getSio

        int getSio()
        Returns:
        the sio(mSubtotalPositionInOutlineMode) value

      • setFromShowData

        void setFromShowData​(boolean fromShowData)
        set whether the export is triggered from show data entry
        Parameters:
        fromShowData -

      • isFromShowData

        boolean isFromShowData()
        Returns:
        the value indicates whether the export is triggered from show data entry