writer2latex.api
Interface BatchHandler
- BatchHandlerAdapter, BatchHandlerImpl
public interface BatchHandler
This is a call back interface to handle user interaction during a
batch conversion with a
BatchConverter
boolean | cancel() - Notification that the conversion may be cancelled.
|
void | endConversion() - Notification that the conversion has finished
|
void | endDirectory(String sName, boolean bSuccess) - Notification that a directory conversion has finished
|
void | endFile(String sName, boolean bSuccess) - Notification that a file conversion has finished
|
void | startConversion() - Notification that the conversion is started
|
void | startDirectory(String sName) - Notification that a directory conversion starts
|
void | startFile(String sName) - Notification that a file conversion starts
|
cancel
public 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
- true if the handler wants to cancel the conversion
endConversion
public void endConversion()
Notification that the conversion has finished
endDirectory
public void endDirectory(String sName,
boolean bSuccess)
Notification that a directory conversion has finished
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)
endFile
public void endFile(String sName,
boolean bSuccess)
Notification that a file conversion has finished
sName
- the name of the filebSuccess
- true if the conversion of this file was successful
startConversion
public void startConversion()
Notification that the conversion is started
startDirectory
public void startDirectory(String sName)
Notification that a directory conversion starts
sName
- the name of the directory to convert
startFile
public void startFile(String sName)
Notification that a file conversion starts
sName
- the name of the file to convert