Package com.microstrategy.web.app.taglibs

Class ExportSetContentTypeTag

  • All Implemented Interfaces:
    java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
    public class ExportSetContentTypeTag
extends AbstractNoBodyTag
    Since:
    MicroStrategy Web 7.3.1 or earlier
    See Also:
    Serialized Form

    • Field Summary

      • Fields inherited from class javax.servlet.jsp.tagext.TagSupport

        id, pageContext

      • Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

        EVAL_BODY_AGAIN

      • Fields inherited from interface javax.servlet.jsp.tagext.Tag

        EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      AbstractNoBodyTagHelper getHelper()
      Method for retrieving the helper related with the tag.
      void setCharSet​(java.lang.String value)
      Indicates the character set definition to use on the new exported document to generate.
      void setContentType​(java.lang.String value)
      Indicates the content type that the exported document will have.
      void setDocumentBean​(java.lang.String value)
      Indicates the name of the document bean that is specified for the page.
      void setExportBean​(java.lang.String value)
      Indicates the name of the export bean specified for the page.
      void setFileExtension​(java.lang.String value)
      Indicates the file extension the new exported document will have.
      void setFileName​(java.lang.String value)
      Indicates the name of the file of the new exported document.
      void setMaxFileSize​(int value)
      Deprecated.
      we now read this value from ExportBean.getMaxFileSize()
      void setReportBean​(java.lang.String value)
      Indicates the name of the report bean that is specified for the page.

      • Methods inherited from class javax.servlet.jsp.tagext.TagSupport

        doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ExportSetContentTypeTag

        public ExportSetContentTypeTag()

    • Method Detail

      • setFileName

        public void setFileName​(java.lang.String value)
        Indicates the name of the file of the new exported document. If no name is specified, it will default to the report or document name if the information can be retrieved.
        Parameters:
        value - String with the name of the file to use.

      • setContentType

        public void setContentType​(java.lang.String value)
        Indicates the content type that the exported document will have.
        Usage:
        Possible values include application/vnd.ms-excel when exporting to excel, application/csv when exporting as comma separated values, etc, as defined on the export format configuration information. If none is specified, it will be retrieved from the export bean instance, or the default indicated previously by the user.
        Parameters:
        value - String with the content type of the exported file.

      • setFileExtension

        public void setFileExtension​(java.lang.String value)
        Indicates the file extension the new exported document will have.
        Usage:
        Possible values that can be defined include xls for Excel exporting, csv for exporting as comma separated values, etc, as defined on the export format configuration information. If none is specified, the information will be retrieved from the export bean instance if specified; otherwise, it will be taken from the value indicated previously by the user.
        Parameters:
        value - String with the file extension to use for the export file to generate.

      • setCharSet

        public void setCharSet​(java.lang.String value)
        Indicates the character set definition to use on the new exported document to generate.
        Usage:
        Possible values could be UnicodeLittle if exporting to excel, or UTF-8 if another type of exporting is requested. If no attribute value is specified, it will default to the property defined for the corresponding export type defined on the locales configuration information.
        Parameters:
        value - String with the character set information to use for the new exported file.

      • setMaxFileSize

        public void setMaxFileSize​(int value)
        Deprecated.
        we now read this value from ExportBean.getMaxFileSize()
        Indicates the maximum size of the file name to use on the new exported document.
        Usage:
        The file name will be based on the report name; if this is too long, it will be truncated so it works in all hardware configurations. This number will determine the maximum file size in characters
        Parameters:
        value - int with the maximum file size in characters.
        Since:
        MicroStrategy Web 8.0.0

      • setExportBean

        public void setExportBean​(java.lang.String value)
        Indicates the name of the export bean specified for the page.
        Usage:
        The information about the export will be retrieved from this bean if it's not specified on the other attributes this custom tag has.
        Parameters:
        value - String with the name of the ExportBean defined for the page.

      • setReportBean

        public void setReportBean​(java.lang.String value)
        Indicates the name of the report bean that is specified for the page.
        Usage:
        The information about the report will be retrieved from this bean if it's not specified on the other attributes this custom tag has.
        Parameters:
        value - String with the name of the ReportBean defined for the page.

      • setDocumentBean

        public void setDocumentBean​(java.lang.String value)
        Indicates the name of the document bean that is specified for the page.
        Usage:
        The information about the document will be retrieved from this bean if it's not specified on the other attributes this custom tag has.
        Parameters:
        value - String with the name of the DocumentBean defined for the page.
        Since:
        MicroStrategy Web 7.5.0