Interface IRunAndRenderTask

  • All Superinterfaces:
    IEngineTask

    public interface IRunAndRenderTask
    extends IEngineTask
    an engine task that runs a report and renders it to one of the output formats supported by the engine.
    • Method Detail

      • setRenderOption

        void setRenderOption​(IRenderOption options)
        set the rendering options
        Parameters:
        settings - the rendering options
      • getRenderOption

        IRenderOption getRenderOption()
        Returns:
        the render option
      • setEmitterID

        void setEmitterID​(java.lang.String id)
        sets a specific emitter to use when generate output. Used when there are more than one emitters that support a single format. One example is the FO-based PDF emitter and the new PDF emitter added in BIRT2.0. If this function is not called when there are more than 1 emitters that support a format, engine may arbitrarily pick one.
        Parameters:
        id - the identifier for the emitter
      • setMaxRowsPerQuery

        void setMaxRowsPerQuery​(int maxRows)
        set the max rows per query
        Parameters:
        maxRows - : max rows
      • setPageHandler

        void setPageHandler​(IPageHandler callback)
        set user defined IPageHandler
        Parameters:
        callback - user-defined IPageHandler