|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.ka2ddo.yaac.pluginapi.Provider
public abstract class Provider
This class defines the structure of a plugin extension's definition. All additions to the core YAAC functionality is specified by querying methods on subclasses of this class.
Nested Class Summary | |
---|---|
static class |
Provider.PortEntry
This class describes the name and implementing Class of an interface port driver. |
Field Summary | |
---|---|
static int |
PROVIDER_API_VERSION
Define the version of the Provider superclass-defined that this build of YAAC supports. |
Constructor Summary | |
---|---|
protected |
Provider(java.lang.String name,
java.lang.String version,
java.lang.String author,
java.lang.String info)
Create a new plugin Provider specifying extensions to be added to YAAC. |
Method Summary | |
---|---|
protected javax.help.HelpSet |
findHelpSet(java.lang.String helpBaseName,
java.lang.String filePathString)
Helper function to load a helpset if a Provider subclass has one. |
java.lang.String[] |
getAboutAttributions()
Specify attributions, credits/acknowledgements, and license references to be displayed in the About dialog box. |
java.lang.String |
getAuthor()
Get the provider author's name. |
java.util.Map<java.lang.String,java.lang.String> |
getConfigurationPanels()
Get any panels needed by this Provider to provision or configure the services offered by the Provider. |
Filter[] |
getFilters()
Get any filters to add to the main CumulativeBooleanAndFilter in the main class of YAAC. |
javax.help.HelpSet |
getHelpSet()
Provide an additional HelpSet to merge into the base HelpSet for complete online documentation. |
java.lang.String |
getImageIconPath()
Return an icon image associated with this Provider. |
java.lang.String |
getInfo()
Get a short description of what this provider provides. |
AbstractMenuAction[] |
getMenuItems()
Get Actions to define new menu items from this Provider. |
java.lang.String |
getName()
Get the name of the provider. |
Provider.PortEntry[] |
getPortConnectorTypes()
Get PortConnector drivers provided by this Provider. |
java.lang.String |
getVersion()
Get the version of the provider. |
void |
runInitializersAfter()
Execute this function after calling all of the other functions of the Provider. |
boolean |
runInitializersBefore(int providerApiVersion)
Execute this function before calling any of the other functions of the Provider. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int PROVIDER_API_VERSION
runInitializersBefore(int)
,
Constant Field ValuesConstructor Detail |
---|
protected Provider(java.lang.String name, java.lang.String version, java.lang.String author, java.lang.String info)
name
- String human-displayed name for this pluginversion
- String version identifier for this pluginauthor
- String name of author(s) of this plugininfo
- String description of what services this plugin providesMethod Detail |
---|
protected javax.help.HelpSet findHelpSet(java.lang.String helpBaseName, java.lang.String filePathString)
helpBaseName
- String name of HelpSet file, without the filetype or locale extensionsfilePathString
- directory path relative to the YAAC installation directory to search for .hs files
public final java.lang.String getName()
public final java.lang.String getVersion()
public final java.lang.String getAuthor()
public final java.lang.String getInfo()
public boolean runInitializersBefore(int providerApiVersion)
providerApiVersion
- the int version of the Provider API supported by
the build of YAAC trying to load this plugin
public java.lang.String getImageIconPath()
public Provider.PortEntry[] getPortConnectorTypes()
public java.util.Map<java.lang.String,java.lang.String> getConfigurationPanels()
YAAC.getMsg(String)
,
YAAC.getMsg(String, String)
,
YAAC.getMsgBundle()
,
YAAC.getMsgBundle(String)
public Filter[] getFilters()
public AbstractMenuAction[] getMenuItems()
May be overridden by subclasses that define new menu choices.
AbstractMenuAction
,
AbstractPopupMenuAction
public java.lang.String[] getAboutAttributions()
Expected to be overridden by subclasses.
public javax.help.HelpSet getHelpSet()
public void runInitializersAfter()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |