Package writer2latex.api

Interface BatchHandler

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean cancel()
      Notification that the conversion may be cancelled.
      void endConversion()
      Notification that the conversion has finished
      void endDirectory​(java.lang.String sName, boolean bSuccess)
      Notification that a directory conversion has finished
      void endFile​(java.lang.String sName, boolean bSuccess)
      Notification that a file conversion has finished
      void startConversion()
      Notification that the conversion is started
      void startDirectory​(java.lang.String sName)
      Notification that a directory conversion starts
      void startFile​(java.lang.String sName)
      Notification that a file conversion starts

    • Method Detail

      • startConversion

        void startConversion()
        Notification that the conversion is started

      • endConversion

        void endConversion()
        Notification that the conversion has finished

      • startDirectory

        void startDirectory​(java.lang.String sName)
        Notification that a directory conversion starts
        Parameters:
        sName - the name of the directory to convert

      • endDirectory

        void endDirectory​(java.lang.String sName,
                  boolean bSuccess)
        Notification that a directory conversion has finished
        Parameters:
        sName - the name of the directory
        bSuccess - true if the conversion was successful (this only means that the index page was created with success, not that the conversion of files and subdirectories was successful)

      • startFile

        void startFile​(java.lang.String sName)
        Notification that a file conversion starts
        Parameters:
        sName - the name of the file to convert

      • endFile

        void endFile​(java.lang.String sName,
             boolean bSuccess)
        Notification that a file conversion has finished
        Parameters:
        sName - the name of the file
        bSuccess - true if the conversion of this file was successful

      • cancel

        boolean cancel()
        Notification that the conversion may be cancelled. The BatchConverter fires this event once per document. Cancelling the conversion does not delete files that was already converted
        Returns:
        true if the handler wants to cancel the conversion