Class Descriptor

Method Details

• getID

  public String getID()

  Gets the ID of the plug-in, e.g. "com.iizigo.db". Predefined descriptors such as Images, Panels, etc, return null.

  Specified by:

  getID in interface IPluginDescriptor<ScreenProp>

  Returns:

  Predefined descriptors such as Images, Panels, etc, return null.

• getServerID

  public String getServerID()

  Gets the ID of the plug-in, e.g. "com.iizix.db". Predefined descriptors such as Images, Panels, etc, return null.

  Specified by:

  getServerID in interface IPluginDescriptor<ScreenProp>

  Returns:

  Predefined descriptors such as Images, Panels, etc, return null.

• getDescription

  public String getDescription()

  Gets the description of the plug-in.

  Specified by:

  getDescription in interface IPluginDescriptor<ScreenProp>

  Returns:

  The description.

• getPropertiesURL

  public URL getPropertiesURL()

  Gets the properties file URL for "properties.xml".

  Specified by:

  getPropertiesURL in interface IPluginDescriptor<ScreenProp>

  Returns:

  The URL for the properties file.

• getClassLoader

  public ClassLoader getClassLoader()

  Gets the class loader to use for loading properties classes.

  Specified by:

  getClassLoader in interface IPluginDescriptor<ScreenProp>

  Returns:

  A class loader or null to use the default class loader.

• getModuleDirectory

  public String getModuleDirectory()

  Gets the directory name in Module projects.

  Specified by:

  getModuleDirectory in interface IPluginDescriptor<ScreenProp>

  Returns:

  The module directory name.

• getModuleFileExtension

  public String getModuleFileExtension()

  Gets the file extension used in Module projects, null for all.

  Specified by:

  getModuleFileExtension in interface IPluginDescriptor<ScreenProp>

  Returns:

  The file extension used in Module projects, null for all.

• getPropertyClass

  public Class<ScreenProp> getPropertyClass()

  Gets the property class for files.

  Specified by:

  getPropertyClass in interface IPluginDescriptor<ScreenProp>

  Returns:

  The main property class used, null if there are multiple ones, in which case the IPluginDescriptor.getPropertyClasses() method must be used.

• getPropertyClasses

  public Class<ScreenProp>[] getPropertyClasses()

  Gets the property class for files.

  Specified by:

  getPropertyClasses in interface IPluginDescriptor<ScreenProp>

  Returns:

  The main property class used.

• getClasspathEntries

  public List<URL> getClasspathEntries()

  Gets the URL's to the required classpath entries when running in the Server. This method is also called from the Designer, and the reply should include a representation of the same libraries or paths.

  Specified by:

  getClasspathEntries in interface IPluginDescriptor<ScreenProp>

  Returns:

  A list of the classpath entries, or null for no special processing.