View Listener Module

Owned by Maciej Szczytowski (Unlicensed)
Last updated: May 05, 2011 by Michal Nawalany (Unlicensed)Version comment

Overview

This module is used for defining new view's listener. Please see also articles describing listener definition.

Module's schema is defined in view.xsd.

Attributes

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.

event

string

yes

Name of the event where the listener will be attached to.

class

string

yes

Name of the class where the listener is defined.

method

string

yes

Name of the listener's method.

Example

Please find below an example of plugin defining one view's listener. Lines 8 contains a module which defines new view's listener for component sampleComponent in view sampleView which belongs to samplePlugin. Listener will be attached to event sampleEvent. Listener is defined in class com.sample.SampleListener in method invoke.

<?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-listener plugin="otherPlugin" view="sampleView" component="sampleComponent" event="sampleEvent" class="com.sample.SampleListener" method="invoke" />

</plugin>