SelectableElements

A class that allows children of the element to be selected.

Syntax

new SelectableElements(oElement, bMultiple);

Parameters

Name	Type	Descripton
oElement	HTMLElement	The element which children should be selectable.
bMultiple	Boolean	Whether to allow multiple selection or not.

Static Methods

Name	Description
None.

Static Fields

Name	Type	Descripton
None.

Methods

Name	Description
click Syntax object.click(e) Arguments Name Type Descripton e Event The event object associated with the click event. Return Type void	Called when the user clicks on the element.
fireChange Syntax object.fireChange() Arguments Name Type Descripton Return Type void	Fires the pseudo event change.
getItem Syntax object.getItem(nIndex) Arguments Name Type Descripton nIndex Number The index of the item to return. Return Type HTMLElement	Returns the nIndex:th item. Part of the Indexable interface.
getItemIndex Syntax object.getItemIndex(el) Arguments Name Type Descripton el HTMLElement The element to return the index for Return Type Number	Returns the index of a given item element. Part of the Indexable interface.
getItems Syntax object.getItems() Arguments Name Type Descripton Return Type HTMLElements[]	Returns an array/collection containing all the items. Part of the Indexable interface.
getItemSelected Syntax object.getItemSelected(oEl) Arguments Name Type Descripton oEl HTMLElement The element to check whether selected or not. Return Type Boolean	Returns whether the element acting as item is selected.
getNext Syntax object.getNext(el) Arguments Name Type Descripton el HTMLElement The element to get the next after. Return Type HTMLElement	Returns the next item after the one passed as argument. Returns null if no more items are available. Part of the Traversable interface.
getPrevious Syntax object.getPrevious(el) Arguments Name Type Descripton el HTMLElement The element to get the previous before. Return Type HTMLElement	Returns the previous item before the one passed as argument. Returns null if no more items are available. Part of the Traversable interface.
getSelectedIndexes Syntax object.getSelectedIndexes() Arguments Name Type Descripton Return Type Number[]	Returns an array containing the indexes of the selected items.
getSelectedItems Syntax object.getSelectedItems() Arguments Name Type Descripton Return Type HTMLElement[]	Returns an array containing the HTMLElements that are selected.
isBefore Syntax object.isBefore(n1, n2) Arguments Name Type Descripton n1 HTMLElement The element to test if it is before the other n2 HTMLElement The element to test if it is after the other Return Type Boolean	Returns whether the first argument comes before the second argument in the logical order of the items. Part of the Traversable interface.
isItem Syntax object.isItem(node) Arguments Name Type Descripton node Node The DOM node to test. Return Type Boolean	Returns whether the Node is considered an item or not.
setItemSelected Syntax object.setItemSelected(oEl, bSelected) Arguments Name Type Descripton oEl HTMLElement The element acting as item to select or deselect. bSelected Boolean Whether to select or deselect. Return Type void	Selects or deselects an item.
setItemSelectedUi Syntax object.setItemSelectedUi(oEl, bSelected) Arguments Name Type Descripton oEl HTMLElement The element acting as item to update visually. bSelected Boolean Whether to select or deselect. Return Type void	Updates the UI for the item.

Fields

Name	Type	Descripton
None.

Events

Name	Descripton
change	Fires when the selection changes

Remarks

None.

SelectableTableRows

This class extends SelectableElements and therefore all methods and field available for SelectableElements are also available for SelectableTableRows.

A class that allows table rows to be selected in a table.

Syntax

new SelectableTableRows(oTableElement, bMultiple);

Parameters

Name	Type	Descripton
oTableElement	HTMLTableElement	The table element which rows should be selectable.
bMultiple	Boolean	Whether to allow multiple selection or not.

Static Methods

Name	Description
None.

Static Fields

Name	Type	Descripton
None.

Methods

Name	Description
None.

Fields

Name	Type	Descripton
None.

Events

Name	Descripton
None.

Remarks

None.

SelectableTableCells

This class extends SelectableElements and therefore all methods and field available for SelectableElements are also available for SelectableTableCells.

A class that allows table cells to be selected in a table.

Syntax

new SelectableTableCells(oTableElement, bMultiple);

Parameters

Name	Type	Descripton
oTableElement	HTMLTableElement	The table element which cells should be selectable.
bMultiple	Boolean	Whether to allow multiple selection or not.

Static Methods

Name	Description
None.

Static Fields

Name	Type	Descripton
None.

Methods

Name	Description
None.

Fields

Name	Type	Descripton
None.

Events

Name	Descripton
None.

Remarks

None.

SelectableListItems

This class extends SelectableElements and therefore all methods and field available for SelectableElements are also available for SelectableListItems.

A class that allows list items in a list to be selected.

Syntax

new SelectableListItems(oListElement, bMultiple);

Parameters

Name	Type	Descripton
oListElement	HTMLElement	The list element which list items should be selectable.
bMultiple	Boolean	Whether to allow multiple selection or not.

Static Methods

Name	Description
None.

Static Fields

Name	Type	Descripton
None.

Methods

Name	Description
None.

Fields

Name	Type	Descripton
None.

Events

Name	Descripton
None.

Remarks

None.

Globals

Functions

Name	Description
addClassName Syntax addClassName(el, sClassName) Arguments Name Type Descripton el HTMLElement The element to change the class name for. sClassName String The string to add to the class name. Return Type void	Adds a string to the class name of an element
removedClassName Syntax removedClassName(el, sClassName) Arguments Name Type Descripton el HTMLElement The element to change the class name for. sClassName String The string to remove from the class name. Return Type void	removes a string from the class name of an element

Objects

Name	Type	Descripton
None.

Introduction
Usage
Sub Classes
API
Demo
Download

Author: Erik Arvidsson