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

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(entry,index,dataTarget,event)

Called when the mouse is clicked on a list entry

Parameters:

• {object} entry

• {int} index

• {string} dataTarget

• {JSEvent} event

---

onDoubleClickMethodID(entry,index,dataTarget,event)

Called upon double click on a list entry

Parameters:

• {object} entry

• {int} index

• {string} dataTarget

• {JSEvent} event

---

onDrop(event,oldIndicies,newIndicies,entriesMoved,entriesMovedTo)

Called when entries dragged from another Custom List are dropped into this Custom list element.

Parameters:

• {JSEvent} event

• {int[]} oldIndicies

• {int[]} newIndicies

• {object[]} entriesMoved

• {object[]} entriesMovedTo

---

onRightClickMethodID(entry,index,dataTarget,event)

Called upon right click on a list entry

Parameters:

• {object} entry

• {int} index

• {string} dataTarget

• {JSEvent} event

---

onSortEnd(event,oldIndicies,newIndicies,entriesMoved,entriesMovedTo)

Called when Custom List entries are reordered by drag&drop.

Parameters:

• {JSEvent} event

• {int[]} oldIndicies

• {int[]} newIndicies

• {object[]} entriesMoved

• {object[]} entriesMovedTo

---

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:

• {string} selector Selector

• {string} styleClass StyleClass

---

clear()

---

getEntriesCount()

@return {int}

Returns: int

---

getEntry(index)

@return {object}

Parameters:

• {int} index

Returns: object

---

newEntry()

@return {object}

Returns: object

---

removeEntry(index)

@return {boolean}

Parameters:

• {int} index

Returns: boolean

---

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:

• {string} selector Selector

• {string} styleClass StyleClass

---

setEntries(entries)

Parameters:

• {object[]} entries

---

Types

sortableOptions

scripting type: CustomType<customrenderedcomponents-customlist.sortableOptions>

• animation

  • Type: int

• handle

  • Type: styleclass

• multiDrag

  • Type: boolean

  • Default Value: false

• multiDragKey

  • Type: string

  • Default Value: "CTRL"

---