Interface IRenderOption

All Superinterfaces:
ITaskOption
All Known Subinterfaces:
IExcelRenderOption, IHTMLRenderOption, IPDFRenderOption, IPostscriptRenderOption, IPPTRenderOption
All Known Implementing Classes:
DocxRenderOption, EXCELRenderOption, HTMLEmitterConfig, HTMLRenderOption, PDFRenderOption, RenderOption, RenderOptionBase

public interface IRenderOption extends ITaskOption
Defines render options for emitters
  • Field Details

  • Method Details

    • getOutputSetting

      @Deprecated Map<String,Object> getOutputSetting()
      Deprecated.
      use getOptions instead
      Get the output settings
      Returns:
      Return the output settings
    • setOutputFormat

      void setOutputFormat(String format)
      Set output format.
      Parameters:
      format -
    • getOutputFormat

      String getOutputFormat()
      Get output format.
      Returns:
      Return the output format
    • setOutputFileName

      void setOutputFileName(String outputFileName)
      Set name of the output file.
      Parameters:
      outputFileName - name of the output file
    • getOutputFileName

      String getOutputFileName()
      Get name of the output file.
      Returns:
      name
    • setOutputStream

      void setOutputStream(OutputStream ostream)
      Set output stream.
      Parameters:
      ostream -
    • getOutputStream

      OutputStream getOutputStream()
      Get output stream.
      Returns:
      output stream
    • setSupportedImageFormats

      void setSupportedImageFormats(String formats)
      Parameters:
      formats - - the image format supported by the browser
    • getSupportedImageFormats

      String getSupportedImageFormats()
      Returns:
      the image format supported by the browser
    • getBaseURL

      String getBaseURL()
      Returns the base URL for creating an Action URL
      Returns:
      the baseURL.
    • setBaseURL

      void setBaseURL(String baseURL)
      sets the base url for action handling
      Parameters:
      baseURL - sets the base URL used for action handling
    • getAppBaseURL

      String getAppBaseURL()
      Returns the app base url for URL images
      Returns:
      appBaseUrl
    • setAppBaseURL

      void setAppBaseURL(String appBaseURL)
      Set app base url
      Parameters:
      appBaseURL - the app base url
    • setActionHandle

      @Deprecated void setActionHandle(IHTMLActionHandler handler)
      Deprecated.
      Set the action handler
      Parameters:
      handler -
    • setActionHandler

      void setActionHandler(IHTMLActionHandler handler)
      Set the action handler
      Parameters:
      handler -
    • getActionHandle

      @Deprecated IHTMLActionHandler getActionHandle()
      Deprecated.
      Get the action handler
      Returns:
      Return the action handler
    • getActionHandler

      IHTMLActionHandler getActionHandler()
      Get the action handler
      Returns:
      Return the action handler
    • setImageHandle

      @Deprecated void setImageHandle(IHTMLImageHandler handler)
      Deprecated.
      Set the image handler
      Parameters:
      handler -
    • setImageHandler

      void setImageHandler(IHTMLImageHandler handler)
      Set the image handler
      Parameters:
      handler -
    • getImageHandle

      @Deprecated IHTMLImageHandler getImageHandle()
      Deprecated.
      Get the image handler
      Returns:
      Return the image handler
    • getImageHandler

      IHTMLImageHandler getImageHandler()
      Get the image handler
      Returns:
      Return the image handler
    • getEmitterID

      String getEmitterID()
      returns the emitter id
      Returns:
      Returns the emitter id
    • setEmitterID

      void setEmitterID(String emitterID)
      sets the emitter id
      Parameters:
      emitterID -