Class OpenProjectEP

java.lang.Object

ca.phon.app.project.OpenProjectEP

All Implemented Interfaces:

IPluginEntryPoint

public class OpenProjectEP
extends Object
implements IPluginEntryPoint

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EP_NAME
static final String	OPEN_WITH_SESSION	If true, OpenSessionEP will be called after the project window is opened with the provided entry point args which should point to an existing session in the project
static final String	USE_NEW_UI_PROP

Constructor Summary

Constructors

Constructor	Description
OpenProjectEP()	Constructor

Method Summary

Modifier and Type	Method	Description
String	getName()	Plugin action ID.
void	loadProject(EntryPointArgs epArgs)
void	newProject()
void	pluginStart(Map<String,Object> args)	Entry point method for a plugin.

Methods inherited from class java.lang.Object

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

Field Details

EP_NAME

public static final String EP_NAME

See Also:

• Constant Field Values

OPEN_WITH_SESSION

public static final String OPEN_WITH_SESSION

If true, OpenSessionEP will be called after the project window is opened with the provided entry point args which should point to an existing session in the project

See Also:

• Constant Field Values

USE_NEW_UI_PROP

public static final String USE_NEW_UI_PROP

See Also:

• Constant Field Values

Constructor Details

OpenProjectEP

public OpenProjectEP()

Constructor

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

loadProject

public void loadProject(EntryPointArgs epArgs)
                 throws IOException

Throws:

IOException

newProject

public void newProject()

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.