Package com.microstrategy.web.app.transforms

Class ReportSavePropertiesTransform

  • All Implemented Interfaces:
    AppTransform, Transform
    public class ReportSavePropertiesTransform
extends AbstractReportTransform
    ReportSavePropertiesTransform is the class that generates the output for a Report to be exported.
    Please note this transform generates a form which will be submitted automatically after displayed,
    therefore it is required the bean is transformed last in the page so any previous HTML/Javascript code
    generated by other beans on the page is executed first.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Field Detail

      • allowCloseWindow

        protected FormalParameter allowCloseWindow
        Formal parameter that displays special HTML to allow users the possiblity to close the window where this transform will be rendered
        Since:
        MicroStrategy Web 8.0.2

      • eventToForwardTo

        protected FormalParameter eventToForwardTo
        This is the name of the event to redirect to after updating the report page state.
        Allowed Values: integer values representing WebEvent. It shall be defined in appBeanEvents.xml or mdBeanEvents.xml.

      • setEventArguments

        protected FormalParameter setEventArguments
        Defines if the arguments of the event to forward to should be set or not.
        Default is true, to be set to false when only passing the bean state is required.
        Allowed Values: TRUE/FALSE.

      • reloadPageName

        protected FormalParameter reloadPageName
        Defines the name of the Parent Page to reload after saving Properties on the options page (used for HTML mode) Default value is "report" Allowed values - String value. Should be a page name.
        Since:
        MicroStrategy Web 8.0.1

      • useURLRedirect

        protected FormalParameter useURLRedirect
        Determines whether to use a fake URL to avoid a problem with IE having two excel files open at the same time inside the browser.
        The fake URL has the following format:
      • for aspx:"Microstrategy/asp/number.exp.aspx"
      • for jsp: "Microstrategy/export/number"
        where the number is a unique identifier.
        Internally we will redirect to the appropiate ASP/servlet.
Since:
MicroStrategy Web 8.0.2

  • Constructor Detail

    • ReportSavePropertiesTransform

      public ReportSavePropertiesTransform()
      Default empty constructor.
      Initialize formal parameters.

  • Method Detail

    • initializeTransform

      public void initializeTransform​(Transformable data)
      Description copied from class: AbstractReportTransform
      This method initialize the private and protected fields of the transform. After calling the initializeTransform on super, it calls initializeProperties if the XMLStatus of the reportBean is WebBeanRequestSuccessful
      Specified by:
      initializeTransform in interface AppTransform
      Overrides:
      initializeTransform in class AbstractReportTransform
      Parameters:
      data - the bean to transform.
      Since:
      MicroStrategy Web 8.0.1

    • getFormActionName

      protected java.lang.String getFormActionName()
      Since:
      MicroStrategy Web 8.0.2

    • getSuggestedFileName

      protected java.lang.String getSuggestedFileName()
      Since:
      MicroStrategy Web 9.0.0

    • renderCloseWindowLink

      protected void renderCloseWindowLink​(Tag div)
      Renders the anchor that displays the "Close window" message.
      Parameters:
      div - the DIV tag where the anchor tag is rendered.

    • getReloadPageEvent

      public WebEvent getReloadPageEvent()
      Return the event to reload the parent page.
      Used in HTML to refresh the parent page after printing or exporting to PDF.
      Returns:
      WebEvent the event to execute a report.
      Since:
      MicroStrategy Web 8.0.1

    • getExecuteReportEvent

      public WebEvent getExecuteReportEvent()
      Deprecated.
      use getReloadPageEvent() instead.
      Return the event to execute a report.
      Used in HTML to refresh the Report page after printing or exporting to PDF.
      Returns:
      WebEvent the event to execute a report.
      Since:
      MicroStrategy Web 8.0.0

    • renderShell

      public void renderShell​(MarkupOutput out)
      Generates the shell for this Transform
      Overrides:
      renderShell in class AbstractAppTransform
      Parameters:
      out - MarkupOutput the markup output
      Since:
      MicroStrategy Web 8.0.0

    • getDescription

      public java.lang.String getDescription()
      Return description for this Transform
      Returns:
      description for this Transform