HelpSource/Classes/PopUpMenu.schelp

   1 CLASS:: PopUpMenu
   2 redirect:: implClass
   3 summary:: A view displaying a text item selectable from a drop-down menu.
   4 categories:: GUI>Views
   5
   6 DESCRIPTION::
   7
   8 When clicked, this view opens a menu containing several text items, then closes the menu and displays one of the items after it is selected.
   9
  10 CLASSMETHODS::
  11
  12 PRIVATE:: key
  13
  14
  15
  16
  17 INSTANCEMETHODS::
  18
  19
  20
  21 SUBSECTION:: Data
  22
  23 METHOD:: items
  24         The list of items displayed in a menu when the view is clicked.
  25
  26         argument::
  27                 An Array of Strings or Symbols.
  28
  29 METHOD:: item
  30         The currently selected item.
  31
  32         returns::
  33                 A String.
  34
  35 METHOD:: value
  36         The index of the currently selected item.
  37
  38         argument::
  39                 An integer, or nil meaning no selected item.
  40
  41 METHOD:: valueAction
  42         Sets link::#-value:: and triggeres link::#-action::.
  43
  44         argument::
  45                 An integer, or nil meaning no selected item.
  46
  47
  48
  49 SUBSECTION:: Appearance
  50
  51 METHOD:: stringColor
  52         The color used to display text.
  53
  54         argument::
  55                 A Color.
  56
  57 METHOD:: background
  58         Setting this variable colors the area of the view under the text with the given color.
  59
  60         argument::
  61                 A Color.
  62
  63
  64
  65 SUBSECTION:: Interaction
  66
  67 METHOD:: allowsReselection
  68         Determines whether the action is triggered when selecting already selected item. Defaults to false.
  69
  70         argument::
  71                 A Boolean.
  72
  73
  74
  75 SUBSECTION:: Actions
  76
  77 METHOD:: action
  78         The action object evaluated whenever the user changes the selected item from the menu. See link::#-allowsReselection:: for customization.
  79
  80
  81
  82 SUBSECTION:: Drag and drop
  83
  84 METHOD:: defaultGetDrag
  85         returns::
  86                 The link::#-value::.
  87
  88 METHOD:: defaultCanReceiveDrag
  89         returns::
  90                 True if the current drag data is a number.
  91
  92 METHOD:: defaultReceiveDrag
  93         Sets link::#-valueAction:: to the current drag data.