Hooks and Listeners

6. Hooks and Listeners

You can create custom hooks or listeners and attach it to defined view. Using this elements, you can connect defined in xml view to JAVA code.

6.1. hooks

Hooks are methods that will be executed every time when request to server is send.

6.1.1. view hook structure

Hooks have to be grouped in tag:

<hooks>

     // HOOK DEFINITIONS

</hooks>

Every hook has structure:

<hookType class="className" method="beanMethod" />

Where:

• hookType - is type of hook
• className - class (path + name) which contains hook method
• beanMethod - name of hook method that should be executed

6.1.1. view hook types

For more informations about hooks see 'view hooks section'.

Refreshing ribbon after hook's change we must:

• call button.requestUpdate(true) on ribbon action item
• call window.requestRibbonRender() on window component.

6.2. listeners

6.2.1 view listener structure

Listeners are methods that will be executed when specified event is fired. Every listener has structure:

<listener event="eventname" class="className" method="beanMethod" />

Where:

• eventname - name of event on which this lisiner is waiting
• className - class (path + name) which contains listener method
• beanMethod - name of listener method that should be executed when event is fired

6.2.2 view listener event names

<layoutElement column="2" row="2">
	<component type="input" name="quantity" field="quantity" reference="quantity">
		<option type="alignment" value="right" />
		<listener event="onInputChange" method="someMethod" class="someClass" />
    </component>
</layoutElement>

<layoutElement column="2" row="1">
	<component type="lookup" name="product" reference="product" field="product">
		<option type="column" name="name" fields="name" link="true" />
		<option type="searchable" value="name,number" />
	    <option type="orderable" value="name,number" />
	    <option type="expression" value="#number + ' - ' + #name" />
	    <option type="fieldCode" value="number" />
	    <listener event="onSelectedEntityChange" method="someMethod" class="someClass" />
    </component>
</layoutElement>

For more informations about listeners see 'view listeners section'. 

6.3. row style resolvers

Row style resolvers returns set of CSS clas names for given row entity. You can use them to mark specified grid rows, e.g. whith negative balance of some arbitrary values. 
Resolver method is invoked for each of grid's entity.

Every resolver has structure:

<rowStyleResolver class="className" method="beanMethod" />

Where:

• className - class (package path + name) which contains resolver method
• beanMethod - name of resolver method that should be executed for each of row entity

For more informations about row style resolvers see 'row style resolvers section'.

6.4. criteria modifiers

Criteria modifiers allow you to modify state of SearchCriteriaBuilder used by given view component to fetch row entities.

Every modifier has structure:

<criteriaModifier class="className" method="beanMethod" />

Where:

• className - class (package path + name) which contains modifier method
• beanMethod - name of method

For more informations about criteria modifier see 'criteria modifier section'.