Menu Counter

The component xeo:MenuCounter allows adding counters to the TreePanel entires (think unread messages in outlook). This component extends the xvw:menu component.

Declaration

<xeo:menuCounter ... >

Properties

Observations

The component to retrieve the counter value uses the following processing order:

1. Checks if the counterValue has value.
2. Checks if the boql property has a value.
3. Checks if the sql property has a value
4. Checks if the value has a JSON Object, and if it has the boql property.

Childs Elements

NO

Examples

Declaring a MenuCounter in a viewer:

<xvw:viewer (...)>
        <xvw:treePanel renderComponent='false' id='tree'>
    <xeo:menuCounter
         id='testCounter'
           boql="select MyObject"
           updateInterval='60'
      text='My Object'  
      value="{viewerName:'viewers/MyObject/list.xvw', boql:'select MyObject'}" 
      target='Tab' 
      serverAction="#{viewBean.listObject}"
    />
   </xvw:treePanel>
(...)

In the previous example as the property "counterValue" is not set, the value for the counter will be retrieved by counting the results of the boql expression.

How to update a counter programatically (in a Bean action):

 // Update a specific counter (using its client id)
 public void updateCounter() {
     MenuCounter.updateClientCounter( "formId:menuCounterId" );
 }

 //Update all counters
 public void updateAllCounter() {
     MenuCounter.updateClientCounters();
 }