renderlet:LISTER

 

This control is used to display a list of items.

It is usually used in collaboration with renderlet:SEARCHFORM.

Reference

Go to Top
path data type req default uobj description
all     This control has applied all the common properties of renderlet.

See renderlet:* section for the complete list of common properties to use.
modestring div  Specify the way how this control will be wrapped. By default, it will have a <div> tag around it.
You can changed it with any HTML tag that you need or you can eliminate it by specifying mode="inline".
beforeRenderarray  
  
TODO
beforeDisplayarray  
  
TODO
ifEmpty/ : Use this option if you want to show a specific message when the results data of this control are empty.
ifEmpty/messagestring  
  
Specify the message to show when the control datasource is empty.
ifEmpty/processboolean true
  
If false, the lister will not be display at all when no row is to be displayed.
ajaxListerboolean false  If true, there is an event on the links of pager which refresh the lister without refresh the page.
searchform/ : If this control is listing all the items searched via a renderlet:SEARCHFORM, then you must set up this option to the renderlet:SEARCHFORM to whom is linked.
searchform/usestring    Set the name of renderlet:SEARCHFORM to whom is linked this control.
You must set up either searchform or datasource option, in order to be able to show up some data into this control.

Example:
  1. <searchform use="my-searchform-name" />
datasource/ : If this control is listing all the results from a datasource:*, then you must set up this option to the datasource to whom is linked.
datasource/usestring    Set the name of datasource:* to whom is linked this control.
You must set up either searchform or datasource option, in order to be able to show up some data into this control.

Example:
  1. <datasource use="my-datasource-name" />
cacheHashboolean    TODO
pager/ : If you want to display the results on more than one single page, then you must set up this option.
pager/alwaysDisplayboolean    If true, the pager is always displayed.
pager/template : If you want to customize the way how this PAGER is generated as HTML, then set up this option.
pager/template/pathstring  
  
Set the absolute path of template.

Example:
  1. path="EXT:myext/template.html"
pager/template/subpartstring  
  
Set the name of subpart used to render this PAGER.

Example:
  1. subpart="###listpager###"
pager/template/rows
pager/rows/perPagenumber 5
  
Set the number of items to show on each page.
If you want to have no limit, then set up to "-1".
pager/rows/sort : If you want to sort the results in some specifical way, then set up this option.
pager/sort/columnstring  
  
Set the column name function of which the results will be sorted.
pager/sort/directionstring  
  
Set up the way how the results will be sorted.

The available options are:
  • ASC: when you want to order the results ascendantly
  • DESC: when you want to order the results descendantly
pager/sort/windownumber 5
  
Specify how many links to pages will be showed before and after the current page.
columns/
columns/wrapstring  
  
TODO
columns/listHeadersboolean true  Set this property to TRUE when you want to display headers for each column, either FALSE.
columns/column : Specify throghout this option a list of columns to show on our renderlet:LISTER.
columns/column/typestring
  
   Set the type of control to use in this column. This can be whatever renderlet you want.

Example:
  1. <column type="renderlet:TEXT" name="my-column-name" />
columns/column/all     You can also set up, all other properties of the control specified on type option above.

So, if you are using a :
  • renderlet:TEXT, then see the entire reference here
  • renderlet:LINK, then see the entire reference here
  • renderlet:BUTTON, then see the entire reference here
  • and so on...

It is required to set up a different name for each column from this control.