Class StringList

Object
   |
   +--StringList

class StringList

Defined in util/stringlist.js

Field Detail

observing

Boolean observing

Set this flag to false to disable onUpdate calls when the string list changes

sep

<private> String sep

Holds the separator used to split the list members

str

<private> String str

Holds the base string

StringList

StringList(<String> str, <String> sep)

A StringList handles strings that are lists of elements splitted by a separator substring. Ex: "2#3#4#5". With this class, it's possible to query, add or remove list elements, besides converting the list into an array and getting the most updated version of the list using the toString method

Parameters:
str - Base string. Defaults to an empty string
sep - String separator. Defaults to "#"

add

Boolean add(<String> obj)

Adds a new element onto the list

Parameters:
obj - New element

Returns:
Returns true if the element could be added, false otherwise

clear

void clear()

Clear the list

contains

Boolean contains(<String> obj)

Searches for a given element in the list

Parameters:
obj - Search substring

empty

Boolean empty()

Check if the list is empty

importOptions

void importOptions(<Object> sel, idx)

Populate the string list using the options of a SELECT element

Parameters:
sel - SELECT element

onUpdate

void onUpdate(<String> str)

Handle modifications in the string list. This method is abstract and must be implemented.

Parameters:
str - String list contents

remove

Boolean remove(<String> obj)

Removes an element from the list

Parameters:
obj - Element to be removed

Returns:
Returns true if the element could be removed, false otherwise

serialize

String serialize()

Serialize the list

toArray

Array toArray()

Converts the list into an Array instance

toString

String toString()

Gets the most updated version of the list

update

 <private> void update(<String> str)

Private function used to change the value of the string list

Parameters:
str - New value