Method Detail

• public void activate()

  Called when the module is selected in the module-bar

• public void deactivate()

  Called when another module is selected in the module-bar

• public void displayActivationGui()

• public java.lang.String getDescription()

  Returns the description of the module for display purposes.

  Returns:

  the description of the module

• public ModuleGui getGui()

  Gets the GUI object for this Module

• public java.lang.String getId()

  Returns a unique ID for this module - for referring between modules

  Returns:

  the unique ID of this module

• public int getMenuPosition()

  Returns the menu position of this module, see ReadyApiModulePositions class

• public ModuleType getModuleType()

• public void initialize()

  Method to initialize the module. Called once.

  throws:

  ModuleInitializationException

• public boolean isEnabled()