public interface IExtModManifestBean extends IBean
Contains module info like name, authors, release date, long description, main class (entry point).
Modules are identified by their folder (getFolder()
), must be unique amongst modules.
IExternalModule.init(IExtModManifestBean, hu.scelightapi.IServices, hu.scelightapi.IModEnv)
,
IModEnv.getManifest()
,
IBean
Modifier and Type | Method and Description |
---|---|
IVersionBean |
getApiVersion()
Returns the used External Module API version.
|
java.util.List<? extends IPersonBean> |
getAuthorList()
Returns the list of authors of the module.
|
IBuildInfoBean |
getBuildInfo()
Returns the build info.
|
java.lang.String |
getDescription()
Returns the (long) HTML description of the module.
|
java.lang.String |
getFolder()
Returns the external module path relative folder.
Also used as the module identifier, must be unique amongst modules. |
java.lang.String |
getHomePage()
Returns the module's home page URL.
|
javax.swing.ImageIcon |
getIcon()
Returns the lazily initialized icon of the module.
|
byte[] |
getIconImgData()
Returns the module icon image data in one of the formats of JPG, PNG or GIF, in size of 16x16.
|
java.lang.String |
getMainClass()
Returns the main class (entry point) of the module.
Must be unique. |
java.lang.String |
getName()
Returns the module name.
|
java.lang.String |
getShortDesc()
Returns the short (1-line) description (plain text).
|
IVersionBean |
getVersion()
Returns the module version.
|
buildDevString, cloneBean, getBeanVer
java.lang.String getName()
IVersionBean getVersion()
IBuildInfoBean getBuildInfo()
IVersionBean getApiVersion()
The External Module API version that was used when developing the external module should be returned. This might be checked for compatibility reasons.
The used API version must not be lower than the minimum version of the API whose services and parts are used by the module, and should be the highest
possible.
For example if the module uses a method which was added in the API version 1.1, the returned used API version must be at least 1.1 but may be 1.2 for example if the module was developed with API version 1.2 even if the module does not uses 1.2 additions.
A good practice is to always return the API version the external module was developed and built with, and if an external module is modified and recompiled with a newer API version, that newer API version should be returned as the used External Module API version.
java.lang.String getFolder()
byte[] getIconImgData()
java.util.List<? extends IPersonBean> getAuthorList()
java.lang.String getHomePage()
java.lang.String getShortDesc()
java.lang.String getDescription()
HTML support: HTML 3.2 with no scripts allowed (neither embedded nor referenced).
java.lang.String getMainClass()
IExternalModule
and must have a no-arg constructor.javax.swing.ImageIcon getIcon()
The icon is created from the icon image data returned by getIconImgData()
.
This API documentation is public and is intended for / allowed to be used by anyone.
Scelight home page: https://sites.google.com/site/scelight/
Scelight is a trademark of András Belicza. Copyright © András Belicza, 2013-2015. All rights reserved.