The JFormMap Script

No properties found.

No events found.

• Found in:
  • JContainers

  intfunctionobject()NativeGlobal

  creates new container object. returns container's identifier (unique integer number).

• Found in:
  • JContainers

  intfunctiongetInt(intobject, Formkey, intdefault=0)NativeGlobal

  Returns the value associated with the @key. If not, returns @default value

• Found in:
  • JContainers

  floatfunctiongetFlt(intobject, Formkey, floatdefault=0.0)NativeGlobal
• Found in:
  • JContainers

  stringfunctiongetStr(intobject, Formkey, stringdefault="")NativeGlobal
• Found in:
  • JContainers

  intfunctiongetObj(intobject, Formkey, intdefault=0)NativeGlobal
• Found in:
  • JContainers

  FormfunctiongetForm(intobject, Formkey, Formdefault=NONE)NativeGlobal
• Found in:
  • JContainers

  voidfunctionsetInt(intobject, Formkey, intvalue)NativeGlobal

  Inserts @key: @value pair. Replaces existing pair with the same @key

• Found in:
  • JContainers

  voidfunctionsetFlt(intobject, Formkey, floatvalue)NativeGlobal
• Found in:
  • JContainers

  voidfunctionsetStr(intobject, Formkey, stringvalue)NativeGlobal
• Found in:
  • JContainers

  voidfunctionsetObj(intobject, Formkey, intcontainer)NativeGlobal
• Found in:
  • JContainers

  voidfunctionsetForm(intobject, Formkey, Formvalue)NativeGlobal
• Found in:
  • JContainers

  boolfunctionhasKey(intobject, Formkey)NativeGlobal

  Returns true, if the container has @key: value pair

• Found in:
  • JContainers

  intfunctionvalueType(intobject, Formkey)NativeGlobal

  Returns type of the value associated with the @key.
  0 - no value, 1 - none, 2 - int, 3 - float, 4 - form, 5 - object, 6 - string

• Found in:
  • JContainers

  intfunctionallKeys(intobject)NativeGlobal

  Returns a new array containing all keys

• Found in:
  • JContainers

  Form[]functionallKeysPArray(intobject)NativeGlobal
• Found in:
  • JContainers

  intfunctionallValues(intobject)NativeGlobal

  Returns a new array containing all values

• Found in:
  • JContainers

  boolfunctionremoveKey(intobject, Formkey)NativeGlobal

  Removes the pair from the container where the key equals to the @key

• Found in:
  • JContainers

  intfunctioncount(intobject)NativeGlobal

  Returns count of pairs in the conainer

• Found in:
  • JContainers

  voidfunctionclear(intobject)NativeGlobal

  Removes all pairs from the container

• Found in:
  • JContainers

  voidfunctionaddPairs(intobject, intsource, booloverrideDuplicates)NativeGlobal

  Inserts key-value pairs from the source container

• Found in:
  • JContainers

  FormfunctionnextKey(intobject, FormpreviousKey=NONE, FormendKey=NONE)NativeGlobal

  Simplifies iteration over container's contents.
  Accepts the @previousKey, returns the next key.
  If @previousKey == @endKey the function returns the first key.
  The function always returns so-called 'valid' keys (the ones != @endKey).
  The function returns @endKey ('invalid' key) only once to signal that iteration has reached its end.
  In most cases, if the map doesn't contain an invalid key ("" for JMap, None form-key for JFormMap)
  it's ok to omit the @endKey.

  Usage:

    string key = JMap.nextKey(map, previousKey="", endKey="")
    while key != ""
      <retrieve values here>
      key = JMap.nextKey(map, key, endKey="")
    endwhile
  

• Found in:
  • JContainers

  FormfunctiongetNthKey(intobject, intkeyIndex)NativeGlobal

  Retrieves N-th key. negative index accesses items from the end of container counting backwards.
  Worst complexity is O(n/2)