net.sf.okapi.lib.verification

Interface IQualityCheckEditor

public interface IQualityCheckEditor

Method Summary

Modifier and Type	Method and Description
void	addRawDocument(RawDocument rawDoc) Adds a raw document to the session.
void	edit(boolean processOnStart) Runs an editing session with this IQualityCheckEditor object.
QualityCheckSession	getSession() Gets the session associated with this editor.
void	initialize(Object parent, boolean asDialog, IHelp helpParam, IFilterConfigurationMapper fcMapper, QualityCheckSession session) Initializes this IQualityCheckEditor object.

Method Detail

initialize

void initialize(Object parent,
                boolean asDialog,
                IHelp helpParam,
                IFilterConfigurationMapper fcMapper,
                QualityCheckSession session)

Initializes this IQualityCheckEditor object.

Parameters:

parent - the object representing the parent window/shell for this editor. The type of this parameter depends on the implementation.

asDialog - true if used from another program.

helpParam - the help engine to use.

fcMapper - the IFilterConfigurationMapper object to use with the editor.

session - an optional session to use (null to use one created internally)

addRawDocument

void addRawDocument(RawDocument rawDoc)

Adds a raw document to the session. If this is the first document added to the session, the locales of the session are automatically set to the source and target locale of this document. This method can be called without the UI being setup yet.

Parameters:

rawDoc - the raw document to add (it must have an input URI and its source and target locale set).

getSession

QualityCheckSession getSession()

Gets the session associated with this editor. You want to call this method only after initialize(Object, boolean, IHelp, IFilterConfigurationMapper, QualityCheckSession) has been called.

Returns:

the session associated with this editor.

edit

void edit(boolean processOnStart)

Runs an editing session with this IQualityCheckEditor object. You must have called initialize(Object, boolean, IHelp, IFilterConfigurationMapper, QualityCheckSession) once before calling this method.

Parameters:

processOnStart - true to trigger the verification process when the editor is opened.