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 argument:: parentView
  13 argument:: bounds
  14 argument:: label
  15 argument:: items
  16 argument:: globalAction
  17 argument:: initVal
  18 argument:: initAction
  19 argument:: labelWidth
  20 argument:: layout
  21 argument:: gap
  22
  23 instancemethods::
  24
  25 subsection:: Building and Changing the List
  26
  27 method:: globalAction
  28 Set/get the global function to be performed in addition to the item functions: code:: { arg listObj; value } ::.
  29
  30 method:: items
  31 Set/get an link::Classes/Array:: of Associations including the labels and the item functions: code:: ['label' -> { arg listObj; value }, ] ::.
  32 discussion::
  33 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' -> {}, ] ::.
  34
  35 method:: item
  36 Returns:: the item label of the current selection.
  37
  38 method:: itemFunc
  39 Returns:: the item function of the current selection.
  40
  41 method:: addItem
  42 Adds an item.
  43 argument:: name
  44 An instance of link::Classes/String:: or link::Classes/Symbol::. The name of the list/menu item.
  45 argument:: action
  46 An instance of link::Classes/Function::.
  47
  48 method:: insertItem
  49 Inserts a list/menu item at positiion of index.
  50 argument:: index
  51 An link::Classes/Integer::. The index where to insert an item.
  52 argument:: name
  53 An instance of link::Classes/String:: or link::Classes/Symbol::. The name of the list/menu item.
  54 argument:: action
  55 An instance of link::Classes/Function::.
  56
  57 method:: replaceItemAt
  58 Replace a list/menu item at positiion of index.
  59 argument:: index
  60 An link::Classes/Integer::. The index where to insert an item.
  61 argument:: name
  62 An instance of link::Classes/String:: or link::Classes/Symbol::. The name of the list/menu item. Default is the current item label.
  63 argument:: action
  64 An instance of link::Classes/Function::. Default is the current item action.
  65
  66 method:: removeItemAt
  67 Removes a list/menu item at positiion of index.
  68 argument:: index
  69 An link::Classes/Integer::. The index where to remove an item.
  70
  71 method:: remove
  72 Removes both the view, label and the list/menu from the parent view.
  73
  74 subsection:: Accessing Values
  75
  76 method:: value
  77 Gets/sets the list/menu to the index at value. Does not perform the action.
  78 argument:: val
  79 An link::Classes/Integer::.
  80
  81 method:: valueAction
  82 Sets the value and performs the action at the index value and the global action.
  83 argument:: val
  84 An link::Classes/Integer::.
  85
  86 method:: doAction
  87 Performs the action at the current index and the global action.
  88
  89 method:: initViews
  90 Called by init and overriden by all subclasses. This is where the class specific views are built.