Custom 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 entries into another Custom 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 entries from another Custom List element
Type: boolean Default Value: false
enabled
Type: enabled Default Value: true
entryRendererFunction
Type: clientfunction
entryStyleClassFunction
Type: clientfunction
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 entries within the Custom List element using drag & drop
Type: boolean Default Value: false
styleClass
Type: styleclass
tooltipFunction
Type: tagstring
visible
Type: visible
Events
onClick
Called when the mouse is clicked on a list entry
Parameters:
onDoubleClickMethodID
Called upon double click on a list entry
Parameters:
onDrop
Called when entries dragged from another Custom List are dropped into this Custom list element.
@param event [JSEvent] the JSEvent for this element @param oldIndicies [int[]] the original indexes, when drag started, of the dropped entries @param newIndicies [int[]] the new indexes of entries upon drop @param entriesMoved [object[]] the entries dragged and dropped @param entriesMovedTo [object[]] the entries whom have been shifted upon drop
Parameters:
event JSEvent oldIndicies int[] newIndicies int[] entriesMoved object[] entriesMovedTo object[]
onRightClickMethodID
Called upon right click on a list entry
Parameters:
onSortEnd
Called when Custom List entries are reordered by drag&drop.
@param event [JSEvent] the JSEvent for this element @param oldIndicies [int[]] the original indexes of the moved entries @param newIndicies [int[]] the new entries indexes @param entriesMoved [object[]] the entries sorted @param entriesMovedTo [object[]] the entries whom have been shifted upon sort end
Parameters:
event JSEvent oldIndicies int[] newIndicies int[] entriesMoved object[] entriesMovedTo object[]
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:
clear
getEntriesCount
Returns: int
getEntry
Parameters:
index int
Returns: object
newEntry
Returns: object
removeEntry
Parameters:
index int
Returns: boolean
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:
setEntries
Parameters:
entries object[]
Types
sortableOptions
animation
Type: int
handle
Type: styleclass
multiDrag
Type: boolean
Default Value: false
multiDragKey
Type: string
Default Value: "CTRL"
Last updated