Instance Methods

toString()

The “toString()” instance method provides an easy way to debug the contents of an Object instance via the “alert()” function or the “ezAlert()” function. Whenever an Object instance is printed via some type of writeln() method the toString() method for each object is fired to obtain a String representation of the object.

fromSpec(aSpec)

The “fromSpec(aSpec)” instance method takes one argument which is “aSpec” String Object instance that specifies a standard “Query String” that names key-value pairs in the form of the following: “key1=value1&key2=value2…” or “key1=value1,key2=value2…”.

URLDecode()

The “URLDecode()” instance method takes no arguments and performs the function of sending a “ezURLDecode()” message to all the values stored within the ezDictObj.

asQueryString(ch_delim)

The “asQueryString(ch_delim)” instance method takes one argument that is “ch_delim” String Object instance that specifies a single character delimiter that is by default the “,” character.

push(key, value)

The “push(key, value)” instance method takes two arguments that are “key” String Object instance that specifies a key that is associated with “value” String Object instance that specifies a value. This method works in a similar manner as the “push(value)” method for the Array Object instance in that new values are pushed into an ezDictObj using this method. Many values can be associated with a single “key” which means whenever a “key” for which there are many values stores is requested the Array Object instance that holds the values is returned rather than a single String Object instance unless the appropriate Boolean flag has been set to always return an Array Object instance.

put(key, value)

The “put(key, value)” instance method takes two arguments that are “key” String Object instance that specifies a key that is associated with “value” String Object instance that specifies a value. This method is used to replace an already extant “value” for a new “value” for a specific “key”; all other uses will throw an error by popping-up an “alert()” dialog.

drop(key)

The “drop(key)” instance method takes one argument that is “key” String Object instance that specifies a key that is to be dropped or removed from the ezDictObj along with the associated value(s).

getValueFor(key)

The “getValueFor(key)” instance method takes one argument that is “key” String Object instance that specifies a key for which the associated value(s) are to be retrieved from the ezDictObj. If the “bool_returnArray” Boolean has been set “true” then this method always returns an Array Object instance even when there is only one value to return.

getKeysMatching(aFunc)

The “getKeysMatching(aFunc)” instance method takes one argument that is “aFunc” Function Object instance that specifies a Function that takes two arguments which are the “key, value” for each key-value pair. If “aFunc” returns “true” then the “key, value” pair is returned in the form of an Array Object instance that holds all the “key” String Object instances that caused “aFunc” to return a “true” value. Keep in mind the fact that value(s) can be Array Object instances or String Object instances unless the “bool_returnArray” Boolean has been set “true” in which case the value(s) are always Array Object instances. This method allows the programmer to construct simple Query of ezDictObj’s contents which can extend the power of the ezAJAX Community Edition Framework considerably when properly used.

getKeys()

The “getKeys()” instance method takes no arguments and returns an Array Object instance that holds the array of “key” String Object instances that specify each “key” that is associated with a “value” within the ezDictObj instance.

adjustKeyNames(aFunc)

The “adjustKeyNames(aFunc)” instance method takes one argument that is “aFunc” Function Object instance that specifies a Function that takes one argument that is the “key” from the array of keys. The user-defined “aFunc” should return the “key” with some kind of transformation applied to each “key”. This method does not modify the keys within the ezDictObj but it does allow the array of keys to be modified in a temporary manner as-needed. This method allows the programmer to construct simple Query of ezDictObj’s contents which can extend the power of the ezAJAX Community Edition Framework considerably when properly used.

length()

The “length()” instance method takes no arguments and returns the number of keys that are stored within the ezDictObj instance.

keyForLargestValue()

The “keyForLargestValue()” instance method takes no arguments and returns the greatest number from all those values that are associated with “key” Strings. This method assumes there is one and only one value for each key and that the value is already numeric and represents a 32 bit value at most.

intoNamedArgs()

The “intoNamedArgs()” instance method takes no arguments and converts an ezDictObj instance that contains arguments from the ezAJAX Server Call-Back into the same ezDictObj instance that holds “named” arguments since the first “arg” from ezAJAX Server is the name of the argument and the next “arg” is the value for the argument. This method is used automatically whenever the simpler ezAJAX Server Call-Back is being used otherwise the programmer is responsible for taking care of this assuming this is a desired action to perform on behalf of the programmer.

init()

The “init()” instance method takes no arguments and performs the action of initializing the keys Array and the values cache within the ezDictObj instance. Any previously existing “key, value” pairs will be lost when this method completes.