Difference between revisions of "Frontend extensions"

Revision as of 11:41, 25 October 2012

OpenKM plugin extensions makes it easy to extend the OpenKM end user interface by encapsulating plugin code and making it reusable between OpenKM versions.

The OpenKM plugin extension architecture is based on:

• Extensions
• Events
• Handlers
• Comunicators

Extensions are available widget definitions that allows the developer 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 occur ( for example when is added new keyword in tab document is fired event HasDocumentEvent.KEYWORD_ADDED)

Handlers are a collection of methods called internally by OpenKM. Handlers must be implemented into your extensions in order to 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 Comunitators API to accessing transparently with some internal UI values. There are several Comunitators, for example with GeneralComunicator can access some general actions like refreshing UI as GeneralComunicator.refreshUI(). OpenKM Communicators API has read and write methods to interact with internal OpenKM UI objects.

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

• HelloWorld Example
• Enable example extensions

Extension

• TabWorkspaceExtension
• TabDocumentExtension
• ToolBarBoxExtension
• TabFolderExtension
• TabMailExtension
• TabRecordExtension
• ToolBarButtonExtension
• MenuItemExtension
• MenuBarExtension

Handlers

• WorkspaceHandlerExtension
• NavigatorHandlerExtension
• DocumentHandlerExtension
• FolderHandlerExtension
• MailHandlerExtension
• RecordHandlerExtension
• ToolBarHandlerExtension
• PropertyGroupHandlerExtension
• DashboardHandlerExtension
• WidgetHandlerExtension

Comunicators

• GeneralComunicator
• WorkspaceComunicator
• NavigatorComunicator
• FileBrowserComunicator
• TabDocumentComunicator
• TabFolderComunicator
• TabMailComunicator
• TabRecordComunicator
• UtilComunicator
• DashboardComunicator
• SearchComunicator
• ToolBarComunicator

UI Constants

• UIMenuConstants
• UIDesktopConstants
• UIDockPanelConstants
• UISearchConstants
• UIFileUploadConstants

Misc

• RPCService
• Widget library

Best practices

• Adding RPC ( Remote Process Calls ) to server
• Internationalization