Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

name

type

required

description

plugin

string

yes

Name of the plugin where the view belongs.

view

string

yes

Name of the view where the component belongs.

component

string

yes

Name of the component where the listener will be added to.

hookType type

string

yes

Type of the hook.

bean class

string

yes

Name of the class where the listener is defined.

method

string

yes

Name of the listener's method.

...

Please find below an example of plugin defining one view's hook. Lines 8 contains a module which defines new preRenderHook beforeRender view's hook for component sampleComponent in view sampleView which belongs to samplePlugin. Hook is defined in class com.sample.SampleHook in method invoke.

Code Block
languagexml
themeEclipse
linenumberstrue
<?xml version="1.0" encoding="UTF-8"?>
<plugin plugin="samplePlugin" version="1.0.0" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schema.qcadoo.org/plugin" 
    xmlns:view="http://schema.qcadoo.org/modules/view" 
    xsi:schemaLocation="http://schema.qcadoo.org/plugin http://schema.qcadoo.org/plugin.xsd http://schema.qcadoo.org/modules/view http://schema.qcadoo.org/modules/view.xsd">

    <view:view-hook plugin="otherPlugin" view="sampleView" component="sampleComponent" hookTypetype="preRenderHookbeforeRender" beanclass="com.sample.SampleHook" method="invoke" />

</plugin>