net.sf.okapi.lib.ui.verification

Class QualityCheckEditor

java.lang.Object

net.sf.okapi.lib.ui.verification.QualityCheckEditor

All Implemented Interfaces:

IQualityCheckEditor

public class QualityCheckEditor
extends Object
implements IQualityCheckEditor

Constructor Summary

Constructors

Constructor and Description
QualityCheckEditor() Creates a default editor, to allow dynamic instantiation.

Method Summary

Modifier and Type	Method and Description
void	addRawDocument(net.sf.okapi.common.resource.RawDocument rawDoc)
void	edit(boolean processOnStart)
protected void	finalize()
QualityCheckSession	getSession()
void	initialize(Object parent, boolean asDialog, net.sf.okapi.common.IHelp helpParam, net.sf.okapi.common.filters.IFilterConfigurationMapper fcMapper, QualityCheckSession paramSession) Initializes this IQualityCheckEditor object.
void	showDialog(String path, boolean processOnStart) Opens the dialog box, loads an QC session if one is specified.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QualityCheckEditor

public QualityCheckEditor()

Creates a default editor, to allow dynamic instantiation. Either edit(boolean) or initialize(Object, boolean, IHelp, IFilterConfigurationMapper, QualityCheckSession) must be called afterward.

Method Detail

edit

public void edit(boolean processOnStart)

Specified by:

edit in interface IQualityCheckEditor

initialize

public void initialize(Object parent,
                       boolean asDialog,
                       net.sf.okapi.common.IHelp helpParam,
                       net.sf.okapi.common.filters.IFilterConfigurationMapper fcMapper,
                       QualityCheckSession paramSession)

Initializes this IQualityCheckEditor object.

Specified by:

initialize in interface IQualityCheckEditor

Parameters:

parent - the object representing the parent window/shell for this editor. In this implementation this parameter must be the Shell of the caller.

asDialog - true if used from another program.

helpParam - the help engine to use.

fcMapper - the IFilterConfigurationMapper object to use with the editor.

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

addRawDocument

public void addRawDocument(net.sf.okapi.common.resource.RawDocument rawDoc)

Specified by:

addRawDocument in interface IQualityCheckEditor

finalize

protected void finalize()

Overrides:

finalize in class Object

showDialog

public void showDialog(String path,
                       boolean processOnStart)

Opens the dialog box, loads an QC session if one is specified.

Parameters:

path - Optional QC session to load. Use null to load nothing.

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

getSession

public QualityCheckSession getSession()

Specified by:

getSession in interface IQualityCheckEditor