Package ca.phon.app.session.editor

Class SessionEditorEP

java.lang.Object

ca.phon.app.session.editor.SessionEditorEP

All Implemented Interfaces:

IPluginEntryPoint

Direct Known Subclasses:

SessionTemplateEP

public class SessionEditorEP
extends Object
implements IPluginEntryPoint

SessionEditor entry point

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EP_NAME
static final String	RECORD_INDEX_PROPERY
static final String	RESULT_VALUES_PROPERTY

Constructor Summary

Constructors

Constructor	Description
SessionEditorEP()

Method Summary

Modifier and Type	Method	Description
String	getName()	Plugin action ID.
int	getOpenAtRecord()
void	pluginStart(Map<String,Object> args)	Entry point method for a plugin.
SessionEditor	showEditor(Project project, Session session, boolean blindMode, boolean grabFocus)

Methods inherited from class java.lang.Object

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

Field Details

RECORD_INDEX_PROPERY

public static final String RECORD_INDEX_PROPERY

See Also:

• Constant Field Values

RESULT_VALUES_PROPERTY

public static final String RESULT_VALUES_PROPERTY

See Also:

• Constant Field Values

EP_NAME

public static final String EP_NAME

See Also:

• Constant Field Values

Constructor Details

SessionEditorEP

public SessionEditorEP()

Method Details

getName

public String getName()

Description copied from interface: IPluginEntryPoint

Plugin action ID. This is used by Phon to call the entry point using a string name.

Specified by:

getName in interface IPluginEntryPoint

getOpenAtRecord

public int getOpenAtRecord()

pluginStart

public void pluginStart(Map<String,Object> args)

Description copied from interface: IPluginEntryPoint

Entry point method for a plugin.

Specified by:

pluginStart in interface IPluginEntryPoint

Parameters:

args - a hash table of arguments given to the plugin. By default, Phon will provide the plugin with the following arguments: project:IPhonProject - the project. null if N/A. corpus:String - the corpus id of the open session. null if N/A session:String - the session id of the open session. null if N/A More arguments can be defined statically in the module definition xml files.

showEditor

public SessionEditor showEditor(Project project,
 Session session,
 boolean blindMode,
 boolean grabFocus)

Parameters:

project -

session -

blindMode -