Foundset List

(part of package 'Advanced Renderers') Extends designtime/SolutionModel: JSWebComponent Extends runtime: RuntimeWebComponent

This is a reference page; many components have detailed usage guides here.

Properties

dragEnabled

When set to true, allows to drag records into another FoundSet List element

Type: boolean Default Value: false


dragSortableOptions

Customize options for the drag n'drop and sortable

Type: sortableOptions


dropEnabled

When set to true, allows to drop records from another FoundSet List element

Type: boolean Default Value: false


enabled

Type: enabled Default Value: true


entryRendererFunction

Type: clientfunction


entryStyleClassDataProvider

Type: dataprovider


firstItemHtml

Type: tagstring


foundset

Type: foundset Default Value: {"foundsetSelector":""}


lastItemHtml

Type: tagstring


responsiveDynamicHeight

Type: boolean Default Value: false


responsiveHeight

Type: int Default Value: 500


reverseOrder

Type: boolean Default Value: false


selectionClass

Type: styleclass


showAs

Option whether text is shown as sanitized html or trusted html (as is).

Type: string Default Value: "html"


sortableEnabled

When set to true, allows to reorder records within the FoundSet List element using drag & drop

Type: boolean Default Value: false


styleClass

Type: styleclass


tooltipDataProvider

Type: dataprovider


tooltipFunction

This is a client side function that gets 2 arguments: first is the data-target (this should be set in the entry renderer) and second is the entry of the data

Type: clientfunction


visible

Type: visible


Events

onClick(record,foundSetIndex,dataTarget,event)

Called when the mouse is clicked on a list entry

Parameters:


onDoubleClickMethodID(record,foundSetIndex,dataTarget,event)

Called upon double click on a list entry

Parameters:


onDrop(event,oldIndicies,newIndicies,recordsMoved,recordsMovedTo)

Called when records dragged from another FoundSet List are dropped into this FoundSet list element. You are responsible to persist the changes for the affected records. Make sure to persist any change for the affected record and call loadRecords for the affected foundsets. If you don't the FoundSet List may go into an incosistent state.

Parameters:


onFirstItemClick(event,dataTarget)

Called when the mouse is clicked on the optional firstItemHtml

Parameters:


onLastItemClick(event,dataTarget)

Called when the mouse is clicked on the optional lastItemHtml

Parameters:


onRightClickMethodID(record,foundSetIndex,dataTarget,event)

Called upon right click on a list entry

Parameters:


onSortEnd(event,oldIndicies,newIndicies,recordsMoved,recordsMovedTo)

Called when FoundSet List records are reordered by drag&drop. You are responsible to persist the changes for the affected records. Make sure to persist any change for the affected record and call loadRecords for the affected foundsets. If you don't the FoundSet List may get into an incosistent state

Parameters:


API

addStyleClassForSelector(selector,styleClass)

Adds the given style class to all items in the list's children that match the selector. Note that tag selectors are not supported.

Parameters:


removeStyleClassForSelector(selector,styleClass)

Removes the given style class from all items in the list's children that match the selector. Note that tag selectors are not supported.

Parameters:


Types

sortableOptions

scripting type: CustomType<customrenderedcomponents-foundsetlist.sortableOptions>


Last updated