Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 28 Next »

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

hook type

description

beforeInitialize

This hook is executed before view state initialization

afterInitialize

This hook is executed after initialization, but before event execution

beforeRender

This is most common used hook type. This hook is executed after event execution, just before response is send to clients browser

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

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

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.

Currently row style resolvers can be used only with grid or lookup component.

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 using to fetch component's rows. You can use them to filter out some data for example all entities owned by user other than currently logged in.

Currently row style resolvers can be used only with grid or lookup component.

Every modifier has structure:

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

Where:

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

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

  • No labels