Difference between revisions of "Extension Guide"

Revision as of 11:33, 3 June 2010

This section is still unders contruction

OpenKM allows to create your own plugin extensions.

OpenKM plugin extensions makes OpenKM more easilly to extends OpenKM users interface encapsulating plugin code and making it rehusable between OpenKM versions.

The OpenKM plugin extension architecture is based on:

• Extensions
• Events
• Handlers
• Comunicators

Extensions are available widget definitions that allows to make extensible panels and widgets ( for example adding new tab panel on tab document )

Events are a collection of events that OpenKM UI fires each time any changes happens ( for example when is added new keyword in tab document if fired event HasDocumentEvent.KEYWORD_ADDED)

Handlers are a collection of metods called internally by OpenKM. Handlers must be implemented into your extensions in order to take collect OpenKM fired events. Each extension you make can have one or several handlers that are automatically registered by OpenKM on loading process. OpenKM internally fire events to each declared handler.

Comunicators are a collection of methods avaliable as OpenKM Comunitate API to accessing transparently with some internal UI values. There are several Comunitators, for example with GeneralComunicator can accessing to some general actions like refreshing UI as GeneralComunicator.refreshUI(). OpenKM Communicators API has read and write methods to interact with internal OpenKM UI objects.

Create OpenKM plugin extension it's easy but you need some java knowledge and pay special attention at Google Web ToolKit API that's used to build OpenKM UI. http://code.google.com/webtoolkit/

• HelloWorld Example
• Extension
  • TabDocumentExtension
  • ToolBarButtonExtension
• Handlers
  • DocumentHandlerExtension
  • ToolBarHandlerExtension
• Comunicators
  • TabDocumentComunicator