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
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
Type: clientfunction
visible
Type: visible
Events
onClick
Called when the mouse is clicked on a list entry
Parameters:
record record foundSetIndex int dataTarget string event JSEvent
onDoubleClickMethodID
Called upon double click on a list entry
Parameters:
record record foundSetIndex int dataTarget string event JSEvent
onDrop
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.
@param event [JSEvent] the JSEvent for this element @param oldIndicies [int[]] the original indexes, when drag started, of the dropped records @param newIndicies [int[]] the new indexes of records upon drop @param recordsMoved [record[]] the records dragged and dropped @param recordsMovedTo [record[]] the records whom have been shifted upon drop
Parameters:
event JSEvent oldIndicies int[] newIndicies int[] recordsMoved record[] recordsMovedTo record[]
onFirstItemClick
Called when the mouse is clicked on the optional firstItemHtml
Parameters:
onLastItemClick
Called when the mouse is clicked on the optional lastItemHtml
Parameters:
onRightClickMethodID
Called upon right click on a list entry
Parameters:
record record foundSetIndex int dataTarget string event JSEvent
onSortEnd
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
@param event [JSEvent] the JSEvent for this element @param oldIndicies [int[]] the original indexes of the moved records @param newIndicies [int[]] the new record indexes @param recordsMoved [record[]] the records sorted @param recordsMovedTo [record[]] the records whom have been shifted upon sort end
Parameters:
event JSEvent oldIndicies int[] newIndicies int[] recordsMoved record[] recordsMovedTo record[]
API
addStyleClassForSelector
Adds the given style class to all items in the list's children that match the selector. Note that tag selectors are not supported.
@param {String} selector @param {String} styleClass
Parameters:
removeStyleClassForSelector
Removes the given style class from all items in the list's children that match the selector. Note that tag selectors are not supported.
@param {String} selector @param {String} styleClass
Parameters:
Types
sortableOptions
animation
Type: int
handle
Type: styleclass
multiDrag
Type: boolean
Default Value: false
multiDragKey
Type: string
Default Value: "CTRL"
Last updated