HelpSource/Classes/EZLists.schelp

   1 class:: EZLists
   2 summary:: An abstract superclass for EZListView and EZPopUpMenu
   3 categories:: GUI>EZ-GUI
   4 related:: Classes/EZListView, Classes/EZPopUpMenu
   5
   6 description::
   7 Users will not normally directly create instances of EZLists, but only use it through its subclasses. It provides the basic mechanisms for link::Classes/EZListView:: and link::Classes/EZPopUpMenu::.
   8
   9 classmethods::
  10
  11 method:: new
  12
  13 instancemethods::
  14
  15 subsection:: Building and Changing the List
  16
  17 method:: globalAction
  18 Set/get the global function to be performed in addition to the item functions: code:: { arg listObj; value } ::.
  19
  20 method:: items
  21 Set/get an link::Classes/Array:: of Associations including the labels and the item functions: code:: ['label' -> { arg listObj; value }, ] ::.
  22 discussion::
  23 In menus, the OS X graphics system gives special meanings to some characters. See link::Classes/PopUpMenu:: ; Or and link::Classes/Array:: link::Classes/Symbol::s (if you are only using code::globalAction::). link::Classes/Array::s of link::Classes/Symbol::s will get converted into and array of link::Classes/Association::s with and empty link::Classes/Function:: code:: ['label' -> {}, ] ::.
  24
  25 method:: item
  26 Returns:: the item label of the current selection.
  27
  28 method:: itemFunc
  29 Returns:: the item function of the current selection.
  30
  31 method:: addItem
  32 Adds an item.
  33 argument:: name
  34 An instance of link::Classes/String:: or link::Classes/Symbol::. The name of the list/menu item.
  35 argument:: action
  36 An instance of link::Classes/Function::.
  37
  38 method:: insertItem
  39 Inserts a list/menu item at positiion of index.
  40 argument:: index
  41 An link::Classes/Integer::. The index where to insert an item.
  42 argument:: name
  43 An instance of link::Classes/String:: or link::Classes/Symbol::. The name of the list/menu item.
  44 argument:: action
  45 An instance of link::Classes/Function::.
  46
  47 method:: replaceItemAt
  48 Replace a list/menu item at positiion of index.
  49 argument:: index
  50 An link::Classes/Integer::. The index where to insert an item.
  51 argument:: name
  52 An instance of link::Classes/String:: or link::Classes/Symbol::. The name of the list/menu item. Default is the current item label.
  53 argument:: action
  54 An instance of link::Classes/Function::. Default is the current item action.
  55
  56 method:: removeItemAt
  57 Removes a list/menu item at positiion of index.
  58 argument:: index
  59 An link::Classes/Integer::. The index where to remove an item.
  60
  61 method:: remove
  62 Removes both the view, label and the list/menu from the parent view.
  63
  64 subsection:: Accessing Values
  65
  66 method:: value
  67 Gets/sets the list/menu to the index at value. Does not perform the action.
  68 argument:: val
  69 An link::Classes/Integer::.
  70
  71 method:: valueAction
  72 Sets the value and performs the action at the index value and the global action.
  73 argument:: val
  74 An link::Classes/Integer::.
  75
  76 method:: doAction
  77 Performs the action at the current index and the global action.
  78
  79 method:: initViews
  80 Called by init and overriden by all subclasses. This is where the class specific views are built.