Web frontend Plugins

Plugin types

• Asset detail
• Custom data types
• Custom mask splitter
• Detail sidebar
• Editor
• Export manager

Available plugins

• Display field values
• Barcode
• PDF Creator

This overview shows all possible hooks for register custom code inside the Web frontend. Each section mentions at least one example Plugin where such custom code is used and can be found.

ez5.rootMenu.registerApp

• Server-Status

ez5.tray.registerApp

• ExportManagerList

TransportsEditor.registerPlugin

• FTP

BaseConfig.registerPlugin

• Example

Presentation.registerDownloadManager

• Presentation-PPTX

DetailSidebar.plugins.registerPlugin

• HierarchyDetail

AssetBrowser.plugins.registerPlugin

• Example

TransitionAction.registerAction

• TransitionActionEmail

ExportManager.registerPlugin

• EasydbExport

Editor.plugins.registerPlugin

• Example

MaskSplitter.plugins.registerPlugin

This plugin allows custom code to be injected into the fields rendering in Detail, Editor, and Text-Result. Two kinds of plugins are provided, one is simple content without inner fields, the other can be used to wrap inner fields (think <fieldset>). The design and output of the injected DOM Nodes are entirely up to the plugin. The method renderFields(opts) gets all relevant render environment information inside opts, e.g. the current datawhich is rendered, or the instance of the Editoror Detail.

• Example

Classes

• CustomMaskSplitter.coffee
• CustomMaskSplitterEnd.coffee
• CustomFieldsRenderer.coffee

Pool.plugins.registerPlugin

This plugin offers the possibility to add custom tabs to the Pool Editor. Using a tab, the plugin can add custom save data to the plugins data record.

• Example

Callbacks

• getSaveData(save_data)
• getTabs(tabs)
• getInfoDivRows(rows)
• getInfoDiv(nodes)

Method getTabs can add a custom Tab to the Pool Editor. The method getSaveData is called to prepare the save data for the pool. In this method the plugin can add the custom data collected inside a Form inside the tab. The ExamplePlugin has an example for that. getInfoDivRows and getInfoDiv can be used to add information to the i-Button display in the Pool selector.

User.plugins.registerPlugin

This plugin offers the possibility to add custom tabs to the User. Using a tab, the plugin can add custom save data to the plugins data record.

Callbacks

• getSaveData(save_data)
  • This method is executed before saving, save_data contains the data which will be saved, therefore it’s necessary to append data to it.
• getTabs(tabs)
  • receives tabs which are the current tabs to be shown, a new tab should be added to tabs in order to show information (for example, a Form).
• isAllowed()
  • returns a boolean, and it could be used to avoid showing the tab under certain circumstances (for example, show only for ‘system’ users).

Callbacks

• ez5.load_defaults
• ez5.session_ready