Package writer2latex.api
Interface BatchHandler
- All Known Implementing Classes:
BatchHandlerAdapter
,BatchHandlerImpl
public interface BatchHandler
This is a call back interface to handle user interaction during a
batch conversion with a
BatchConverter
-
Method Summary
Modifier and TypeMethodDescriptionboolean
cancel()
Notification that the conversion may be cancelled.void
Notification that the conversion has finishedvoid
endDirectory
(String sName, boolean bSuccess) Notification that a directory conversion has finishedvoid
Notification that a file conversion has finishedvoid
Notification that the conversion is startedvoid
startDirectory
(String sName) Notification that a directory conversion startsvoid
Notification that a file conversion starts
-
Method Details
-
startConversion
void startConversion()Notification that the conversion is started -
endConversion
void endConversion()Notification that the conversion has finished -
startDirectory
Notification that a directory conversion starts- Parameters:
sName
- the name of the directory to convert
-
endDirectory
Notification that a directory conversion has finished- Parameters:
sName
- the name of the directorybSuccess
- 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
Notification that a file conversion starts- Parameters:
sName
- the name of the file to convert
-
endFile
Notification that a file conversion has finished- Parameters:
sName
- the name of the filebSuccess
- true if the conversion of this file was successful
-
cancel
boolean cancel()Notification that the conversion may be cancelled. TheBatchConverter
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
-