|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.ka2ddo.yaac.pluginapi.Provider
org.ka2ddo.yaac.core.provider.CoreProvider
public class CoreProvider
This class defines the core functionality to be provided by the YAAC application. In essence, this is the root plugin that all other plugins augment and extend. This is the only provider subclass explicitly coded into YAAC; all others are loaded from JAR files as defined by the Provider class's documentation.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.ka2ddo.yaac.pluginapi.Provider |
---|
Provider.PortEntry |
Field Summary | |
---|---|
static AbstractMenuAction |
ABOUT_ACTION
This Action performs the operations needed to open the About dialog, identifying and describing the YAAC application. |
static AbstractMenuAction |
CONFIGURE_ACTION
This Action performs the operations needed to open the expert-mode Configuration dialog. |
static AbstractMenuAction |
EXIT_ACTION
This Action performs the operations needed to cleanly shut down YAAC and free up the system resources it is using. |
static java.lang.String[] |
TOP_MENU
The pre-localization hierarchy of sub-menu names for a menu at the top level, made available for use by plugins creating new menus. |
Fields inherited from class org.ka2ddo.yaac.pluginapi.Provider |
---|
PROVIDER_API_VERSION |
Method Summary | |
---|---|
java.lang.String[] |
getAboutAttributions()
Specify attributions, credits/acknowledgements, and license references to be displayed in the About dialog box. |
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. |
HttpServer |
getCoreWebServer()
Get the web server instance associated with the core services of YAAC. |
Filter[] |
getFilters()
Get any filters to add to the main CumulativeBooleanAndFilter in the main class of YAAC. |
javax.help.HelpSet |
getHelpSet()
Provide the base HelpSet for complete online documentation. |
java.lang.String |
getImageIconPath()
Return an icon image associated with this Provider. |
static CoreProvider |
getInstance()
Get the core instance of Provider for YAAC. |
AbstractMenuAction[] |
getMenuItems()
Get Actions to define new menu items from this Provider. |
static ChangeSet[] |
getOSMChangeSetIds(boolean getBoth)
Get the local and remote OSM ChangeSet records for the versions of the OpenStreetMap data stored locally and available on the tile server website. |
Provider.PortEntry[] |
getPortConnectorTypes()
Get PortConnector drivers provided by this Provider. |
static ChangeSet |
getServerOSMChangeset()
Query the author's website for the currently available changeset of the pre-imported OpenStreetMap tile files. |
java.lang.String |
getUserAgent()
Return a standard string for identifying this installation of YAAC to a web server in the User-Agent HTTP header property. |
boolean |
hasRXTX()
Report whether this plugin was able to load the RXTX native library for accessing serial ports. |
static void |
logCurrentStateToPrefs(java.util.prefs.Preferences prefs)
Checkpoint a description of YAAC's current execution environment into the Preferences so that the information can be saved in a configuration save file. |
void |
runInitializersAfter()
Execute this function after calling all of the other functions of the CoreProvider. |
boolean |
runInitializersBefore(int providerApiVersion)
Execute this function before calling any of the other functions of the Provider. |
Methods inherited from class org.ka2ddo.yaac.pluginapi.Provider |
---|
findHelpSet, getAuthor, getInfo, getName, getVersion |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String[] TOP_MENU
public static final AbstractMenuAction EXIT_ACTION
public static final AbstractMenuAction CONFIGURE_ACTION
public static final AbstractMenuAction ABOUT_ACTION
Method Detail |
---|
public static CoreProvider getInstance()
public Provider.PortEntry[] getPortConnectorTypes()
getPortConnectorTypes
in class Provider
public java.util.Map<java.lang.String,java.lang.String> getConfigurationPanels()
getConfigurationPanels
in class Provider
YAAC.getMsg(String)
,
YAAC.getMsg(String, String)
,
YAAC.getMsgBundle()
,
YAAC.getMsgBundle(String)
public Filter[] getFilters()
getFilters
in class Provider
public static ChangeSet[] getOSMChangeSetIds(boolean getBoth)
getBoth
- boolean true if both local and server changesets should be obtained, false if only local
public static ChangeSet getServerOSMChangeset()
public AbstractMenuAction[] getMenuItems()
getMenuItems
in class Provider
AbstractMenuAction
,
AbstractPopupMenuAction
public static void logCurrentStateToPrefs(java.util.prefs.Preferences prefs)
prefs
- Preferences node to write the descriptive information topublic java.lang.String[] getAboutAttributions()
getAboutAttributions
in class Provider
public javax.help.HelpSet getHelpSet()
getHelpSet
in class Provider
public java.lang.String getImageIconPath()
getImageIconPath
in class Provider
public boolean runInitializersBefore(int providerApiVersion)
runInitializersBefore
in class Provider
providerApiVersion
- the int version of the Provider API supported by
the build of YAAC trying to load this plugin
public void runInitializersAfter()
runInitializersAfter
in class Provider
public HttpServer getCoreWebServer()
public boolean hasRXTX()
getPortConnectorTypes()
public java.lang.String getUserAgent()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |