Rollist class

Requires

• module:exontrol.commmon.min.js

Classes

Options

Members

Listeners :exontrol.Lts

Type:

• exontrol.Lts

Example

The following sample shows how you can get all items the component currently supports:

oRollist.Listeners.forEach(function(name)
{
 console.log(name);
});

The following samples handle the "onload" event:

oRollist.Listeners.Add("onload", function (oEvent)
{
 console.log(oEvent);
});

or

oRollist.on("load", function (oEvent)
{
 console.log(oEvent);
});

where oRollist is an object of Rollist type

(static, readonly) AllowFilterInputEnum :number

Type:

• number

Properties:

(static) type :string

Type:

• string

(static) version :string

Type:

• string

Methods

BeginUpdate()

CloseFilterInput()

EndUpdate()

GetAllowActions() → {string}

Returns:

Type

string

GetAllowFilterInput() → {Rollist.AllowFilterInputEnum}

Returns:

Type

Rollist.AllowFilterInputEnum

GetCyclic() → {boolean}

Returns:

Type

boolean

GetFilter() → {string}

Returns:

Type

string

GetItems() → {Items}

Returns:

Type

Items

Example

The following statements are equivalents:

 oRollist.GetItems() {Items}, returns the control's items
 oRollist.Items {Items}, returns the control's items

where oRollist is an object of Rollist type

GetMisc() → {MiscellaneousOptions}

Returns:

Type

MiscellaneousOptions

GetOptions() → {object}

Returns:

Type

object

GetSelect() → {Item}

Returns:

Type

Item

GetSmooth() → {number}

Returns:

Type

number

GetWheelChange() → {number}

Returns:

Type

number

Import(source, importOptsopt)

Parameters:

Item(id) → {Item}

Parameters:

Returns:

Type

Item

Refresh()

SetAllowActions(value)

Parameters:

Example

null {null}, indicates the control's default allowActions value
 "" {string}, specifies that no operation is allowed once the user clicks or touches the control
 "scroll" {string}, specifies that only "scroll" operation is allowed, no matter of the event's button or modifier-keys is pressed.

SetAllowFilterInput(value)

Parameters:

Example

null {null} or "hide" {string} or exontrol.Rollist.AllowFilterInputEnum.exHide {AllowFilterInputEnum} or 0 {number}, no filter input is visible (by default)
 "always" {string} or exontrol.Rollist.AllowFilterInputEnum.exAlwaysVisible {AllowFilterInputEnum} or 1 {number}, indicates that the filter input is always visible
 "key,disable" {string} or (exontrol.Rollist.AllowFilterInputEnum.exShowOnAnyKey | exontrol.Rollist.AllowFilterInputEnum.exDisableHighlightOccurences) {AllowFilterInputEnum} or 0x12 {number}, shows the filter input when the user presses any key and disables the highlighting of all occurrences of the typed text in the items

SetCyclic(value)

Parameters:

SetData(value)

Parameters:

Example

"data.txt" {string}, imports data from data.txt file

SetFilter(value)

Parameters:

Example

null {null} or "" {string}, clear the filter (if applied)
 "icon" {string}, filters the items to display only those that contain the word 'icon'
    

SetMisc(value)

Parameters:

SetOptions(nOptions, bIncludeAllopt) → {boolean}

Parameters:

Returns:

Type

boolean

Example

oRollist.Options = {imageAlign: 1, imageSize: 24}, changes the alignment and the size for all images within the control.

The oRollist.Options = value statement is equivalent with oRollist.SetOptions(value) or oRollist.SetOptions(value)

SetSelect(value)

Parameters:

SetSmooth(value)

Parameters:

Example

0 {number}, no smooth changes once the control goes from a layout to another
  125 {number}, specifies that a smooth-transition is performed from a layout to another for 125 ms.

SetWheelChange(value)

Parameters:

Example

0 {number}, locks any action the mouse's wheel performs
  18 {number}, scrolls the control by 18-pixels when mouse's wheel is rotated (CTRL + wheel scrolls horizontally)

ShowFilterInput()

Update(callback, thisArgopt)

Parameters:

feI(callback, thisArgopt)

Parameters:

feIU(callback, thisArgopt) → {any}

Parameters:

Returns:

Type

any

getInnerHTML(oItem,) → {string}

Parameters:

Returns:

Type

string

item(position) → {Item}

Parameters:

Returns:

Type

Item

off(event, listener, methodopt)

Parameters:

Since:

• 4.4

Example

The following example removes the load event handler from the control:

oRollist.off("load");

where oRollist is an object of Rollist type.

This sample is equivalent to:

oRollist.Listeners.Remove("onload");

The following example removes all event handlers from the control:

oRollist.off();

where oRollist is an object of Rollist type.

This sample is equivalent to:

oRollist.Listeners.Clear();

or

oRollist.Listeners.Remove();

on(event, listener, methodopt) → {object}

Parameters:

Since:

• 4.4

Returns:

Type

object

Example

The following sample shows how you can handle the onload event:

oRollist.on("load", function()
{
  console.log("onload event occured");
});

where oRollist is an object of Rollist type.

This sample is quivalent of 

oRollist.Listeners.Add("onload", function ()
{
  console.log("onload event occured");
});

Events

onadditem

Parameters:

Example

The following samples display the item being added:

oRollist.onadditem = function (oItem)
{
 console.log(oItem);
}

or

oRollist.Listeners.Add("onadditem", function (oItem)
{
 console.log(oItem);
})

or

oRollist.on("additem", function (oItem)
{
 console.log(oItem);
})

where oRollist is an object of Rollist type

onclick

Parameters:

Example

The following samples show how you can handle the "click" event:

oRollist.Listeners.Add("onclick", function (oEvent)
{
 console.log(oEvent);
})

or

oRollist.on("click", function (oEvent)
{
 console.log(oEvent);
})

or

oRollist.onclick = function (oEvent)
{
 console.log(oEvent);
}

where oRollist is an object of Rollist type.

oncreate

Parameters:

Example

The following samples sets the HTML element's tooltip:

oRollist.oncreate = function (oEvent)
{
 oEvent.html.title = oEvent.html.innerText;
}

or

oRollist.Listeners.Add("oncreate", function (oEvent)
{
 oEvent.html.title = oEvent.html.innerText;
})

or

oRollist.on("create", function (oEvent)
{
 oEvent.html.title = oEvent.html.innerText;
})

where oRollist is an object of Rollist type

ondestroy

Parameters:

Example

The following samples displays the element being destroyed:

oRollist.ondestroy = function (oEvent)
{
 console.log(oEvent);
}

or

oRollist.Listeners.Add("ondestroy", function (oEvent)
{
 console.log(oEvent);
})

or

oRollist.on("destroy", function (oEvent)
{
 console.log(oEvent);
})

where oRollist is an object of Rollist type

onerror

Parameters:

Example

The following samples display the error once it occurs:

oRollist.onerror = function (oEvent)
{
 console.log(oEvent);
}

or

oRollist.Listeners.Add("onerror", function (oEvent)
{
 console.log(oEvent);
})

or

oRollist.on("error", function (oEvent)
{
 console.log(oEvent);
})

where oRollist is an object of Rollist type

onfilter

Parameters:

Example

The following samples displays the current filter once the user changes it:

oRollist.Listeners.Add("onfilter", function (oEvent)
{
 console.log(oEvent);
})

or

oRollist.on("filter", function (oEvent)
{
 console.log(oEvent);
})

or

oRollist.onfilter = function (oEvent)
{
 console.log(oEvent);
}

where oRollist is an object of Rollist type.

onload

Example

The following samples display a message once the control loads or imports new data (for instance, the user drags and drops a file into the control):

oRollist.onload = function ()
{
 alert("onload");
}

or

oRollist.Listeners.Add("onload", function ()
{
 alert("onload");
})

or

oRollist.on("load", function ()
{
 alert("onload");
})

where oRollist is an object of Rollist type

onremoveitem

Parameters:

Example

The following samples display the item being removed:

oRollist.onremoveitem = function (oItem)
{
 console.log(oItem);
}

or

oRollist.Listeners.Add("onremoveitem", function (oItem)
{
 console.log(oItem);
})

or

oRollist.on("removeitem", function (oItem)
{
 console.log(oItem);
})

where oRollist is an object of Rollist type

onselect

Parameters:

Example

The following samples show how you can handle the "select" event:

oRollist.Listeners.Add("onselect", function (oEvent)
{
 console.log(oEvent);
})

or

oRollist.on("select", function (oEvent)
{
 console.log(oEvent);
})

or

oRollist.onselect = function (oEvent)
{
 console.log(oEvent);
}

where oRollist is an object of Rollist type.