| com.methodhead.shim.Module
All known Subclasses: com.methodhead.shim.IncludeModule, com.methodhead.shim.NavModule, com.methodhead.shim.MockModule, com.methodhead.shim.TextModule,
| Module | | public interface Module (Code) | | A module that can be inserted into a panel and managed by shim.
|
| copyTo | | public void copyTo(Page page)(Code) | | Copies any resources associated with the module for page.
|
| create | | public void create()(Code) | | Creates the module. This method is called when a module is instantiated
for a page and panel. The module should be initialized such that future
calls to
Module.configure configure() and
Module.display display() are
successful. Note that this method is also called when a template is
changed for a page, giving modules an opportunity to reset (or leave
alone) the data associated with the panel.
|
| destroy | | public void destroy()(Code) | | Destroys the module, freeing any resources associated with the module.
|
| getName | | public String getName()(Code) | | Returns a short descriptive name for the module.
|
| init | | public void init(Page page, String panel)(Code) | | Sets the module's page and panel. This method is called
before any other operations are performed.
|
| isConfigurable | | public boolean isConfigurable()(Code) | | Returns true if the module has a configuration interface; that
is, if
Module.configure configure() actually does something.
|
| isEditable | | public boolean isEditable()(Code) | | Returns true if the module can be updated in the rich text
editor; if so,
Module.update update() must be implemented.
|
| update | | public void update(String text)(Code) | | Updates the module with text submitted from the rich text editor.
|
|
|