vegui. list. class.js

function VegUIList( refName, Parent, Manager )

Constructor

See Parent

VegUINode::VegUINode

this.add_item = function( node, value, dontAdjust, asHeader, replace )

Adds a HTML node as a new item to the list with a certain value attached

Parameters

Code example

// add item
myList.add_item(document.getElementById('somenode'), 1);

// add item as header
myList.add_item(document.getElementById('somenode'), 0, false, true);

See also

drop_item, add_item_txt, add_item_imgtxt

this.add_item_imgtxt = function( src, txt, value, dontAdjust, asHeader, replace )

Wrapper function to add an item that contains an image and text

Parameters

See also

add_item, add_item_txt

Example

List.add_item_imgtxt('image.gif', 'Some Image', 1);

this.add_item_txt = function( txt, value, dontAdjust, asHeader, replace )

Wrapper function to add an item that contains on text

Parameters

See also

add_item, add_item_imgtxt

Example

List.add_item_txt('List Entry', 1);

this.adjust = function()

Adjusts the scrollbars of the list to the content over flow of the list.  This is usually called everytime an item is added to the list at runtime.

this.build = this.build_list = function( toNode )

Builds the list

private function

You should always use VegUIManager::build_element to build VegUI elements.

Parameters

Returns

See Parent

VegUINode::build_node

this.close = function()

Closes the list if the list is a dropdown list

See also

open

Example

List.close();

this.deselect_item = function( value, noOnChange )

Deselects the currently selected item(s), or the item submitted to the function.

private function

Parameters

See also

select, select_item

this.drop_item = function( index )

Drops the item that is located at the submitted index in the childNodes array of the Table child’s HTML node

Parameters

See also

add_item

Example

// drops the item in the beginning of the list
List.drop_item(0);

// drops the 10th item
List.drop_item(9);

this.find = function( value )

Sees if an item with a certain value exists

Parameters

Returns

See also

is_selected

Example

// returns the index of the first item that has the item value 1
return List.find(1);

// combined with drop_item
List.drop_item(List.find(1));

this.flush = function()

Clears the list of all items

Example

List.flush();

this.handle_key = this.handle_key_list = function()

Handles key press on the list element

private function

Alias

<handle_key>

See also

<VegUICBox::handle_key_cbox>

this.is_selected = function( value )

Checks if the item with a certain value is selected

Parameters

See also

select, find

Returns

Example

// returns true if the item with the item value 1 is currently
// selected

return List.is_selected(1);

this.open = function()

Expands the list if it is a dropdown list

See also

close

this.select = function( value, noOnChange )

Selects the first item that has the requested value

Parameters

See also

select_item, deselect_item

Example

// selects the item with the item value 1
List.select(1);

this.select_item = function( node, noOnChange, append )

Selects the item with the submitted HTML node.  This is a private function that is called whenever an item is clicked to mark it as selected.  If you want to select an item manually you should use the select method

private function

Use select method to select item by value

Parameters

this.select_items = function( value1, value2 )

Selects items from item with value1 to item with value2

Parameters

Returns

See also

select_item, select, is_selected

Example

// Will select all items that are between the item with the
// item value 1 and the item with the item value 20
// items 1 and 20 will be selected as well

List.select_items(1,20);

this.set = this.set_list = function( w, h, x, y, ih, rs, type, z, ne )

Sets the most common template properties for the list

Alias

set()

Parameters

See Parent

VegUINode::set_node

Example

// set list up as a normal list with a row space of 0 and
// fixed item height of 16 pixels

List.set_list(150,200,5,5,16,0,VUI_LISTTYPE_NORMAL);

// set list up with non fixed item height

List.set_list(150,200,5,5,0,0,VUI_LISTTYPE_NORMAL);

// set list up as multi select list

List.set_list(150,200,5,5,16,0,VUI_LISTTYPE_MULTI);

// set list up as dropdown list

List.set_list(150,200,5,5,16,0,VUI_LISTTYPE_DROPDOWN);

this.set_style_list = this.set_style = function( over, normal, select, header, overSelect )

Wrapper method to set the style class name attributes of this element

Alias

set_style

Parameters

this.sitem_idx = function( value )

Returns the index of an item in the sItems property

Parameters

Returns

this.to_string = function( sep )

Returns a string representation of the selection in the form of item values separated by a delimiter.  This is useful for processing multi selections.

Parameters

Returns

Example

// if list holds these items:
// Item 1 (value = 1)
// Item 2 (value = 2)
// Item 3 (value = 3)
// then this will return '1,2,3';

return List.to_string(',');

this.warp = function( value )

Scrolls the list to make sure a certain item is in point of view of the user

Parameters

Example

// warp the list to item with item value 1

List.warp(1);