182 lines
6.1 KiB
Text
182 lines
6.1 KiB
Text
class:: EZListView
|
|
summary:: A wrapper class for a label plus a listView with per item actions
|
|
categories:: GUI>EZ-GUI
|
|
related:: Classes/ListView
|
|
|
|
description::
|
|
EZListView is wrapper class which creates an (optional) label and a listView. It includes per item actions as well as a global action which are both evaluated upon selection of an item. Convenience methods for inserting and deleting list items are also included . If the parent is nil, then EZListView will create its own window. See link::Classes/EZGui:: and link::Classes/EZLists:: for all of the options.
|
|
|
|
subsection:: Some Important Issues Regarding EZListView
|
|
|
|
The convenience methods for EZListView require that the items array is an array of associations of labels and functions, not like in ListView, where items is simply an array of strings. If code::label:: is nil, then no staticText is created.
|
|
|
|
classmethods::
|
|
|
|
subsection:: Creation / Class Methods
|
|
|
|
method:: new
|
|
|
|
argument:: parentView
|
|
The parent view or window. If the parent is nil, then EZListView will create its own link::Classes/Window::, and place it conveniently on the screen if the bounds are a link::Classes/Point::. If the bounds are a link::Classes/Rect::, then the link::Classes/Rect:: determines the window bounds.
|
|
|
|
argument:: bounds
|
|
An instance of link::Classes/Rect:: or link::Classes/Point::. Default value is code::160@200::.
|
|
|
|
argument:: label
|
|
The label. Default value is code::nil::. If code::nil::, then no link::Classes/StaticText:: is created.
|
|
|
|
argument:: items
|
|
Default value is code::nil::. An link::Classes/Array:: of link::Classes/Association::s code:: ['label' -> { arg listObj; value }, ] ::. Or and link::Classes/Array:: link::Classes/Symbol::s (if you are only using code::globalAction::).
|
|
|
|
argument:: globalAction
|
|
A global function to be performed in addition to the item functions code:: { arg listObj; value } ::.
|
|
|
|
argument:: initVal
|
|
Initial value of the List, i.e. the index selected. Default value is 0.
|
|
|
|
argument:: initAction
|
|
An instance of link::Classes/Boolean::. Performs the action at code::initVal:: on creation of the list, plus the code::globalAction::. Default value is code::false::.
|
|
|
|
argument:: labelWidth
|
|
Default value is 80. Not used if layout is code::\vert::.
|
|
|
|
argument:: labelHeight
|
|
Default value is 20. Not used if layout is code::\horz::.
|
|
|
|
argument:: layout
|
|
code::\vert:: or code::\horz::. default is code::\vert::.
|
|
|
|
argument:: gap
|
|
A link::Classes/Point::. By default, the view tries to get its parent's gap, otherwise it defaults to code::2@2::. Setting it overrides these.
|
|
|
|
argument:: margin
|
|
A link::Classes/Point::. This will inset the bounds occupied by the subviews of view.
|
|
|
|
discussion::
|
|
Example:
|
|
code::
|
|
(
|
|
// default with vertical layout
|
|
w = Window.new.front;
|
|
w.view.decorator = FlowLayout(w.view.bounds);
|
|
g = EZListView.new(w,
|
|
230@230,
|
|
"An ListView:",
|
|
[
|
|
\item0 ->{ |a| ("this is item 0 of " ++ a).postln },
|
|
\item1 ->{ |a| ("this is item 1 of " ++ a).postln },
|
|
\item2 ->{ |a| ("this is item 2 of " ++ a).postln },
|
|
],
|
|
globalAction: { |a| ("this is a global action of "++a.asString ).postln },
|
|
initVal: 2,
|
|
initAction: true,
|
|
labelWidth: 120,
|
|
labelHeight: 16,
|
|
layout: \vert,
|
|
gap: 2@2
|
|
);
|
|
|
|
)
|
|
|
|
// or a more simple syntax (uses decorator gap settings):
|
|
(
|
|
w = Window.new.front;
|
|
w.view.decorator = FlowLayout(w.view.bounds);
|
|
g = EZListView.new(w,200@230, " List:");
|
|
g.addItem(\item0, { |a| ("this is item 0 of " ++ a).postln });
|
|
g.addItem(\item1, { |a| ("this is item 1 of " ++ a).postln });
|
|
g.addItem(\item2, { |a| ("this is item 2 of " ++ a).postln });
|
|
g.setColors(Color.grey, Color.white);
|
|
)
|
|
::
|
|
|
|
instancemethods::
|
|
|
|
subsection:: Changing Appearance
|
|
|
|
method:: setColors
|
|
argument:: stringBackground
|
|
An instance of link::Classes/Color::. The code::background:: of the label and unit views.
|
|
argument:: stringColor
|
|
An instance of link::Classes/Color::. The code::stringColor:: of the label and unit views.
|
|
argument:: listBackground
|
|
An instance of link::Classes/Color::. The code::background:: of the list view.
|
|
argument:: listStringColor
|
|
An instance of link::Classes/Color::. The code::stringColor:: of the list view.
|
|
argument:: selectedStringColor
|
|
An instance of link::Classes/Color::. The code::selectedStringColor:: of the listView.
|
|
argument:: hiliteColor
|
|
An instance of link::Classes/Color::. The code::hiliteColor:: of the list view.
|
|
argument:: background
|
|
An instance of link::Classes/Color::. The code::background:: of the list view.
|
|
|
|
method:: font
|
|
Set the link::Classes/Font:: used by all the views.
|
|
argument:: font
|
|
An instance of link::Classes/Font::.
|
|
|
|
examples::
|
|
Creates its own window if parent is nil:
|
|
code::
|
|
(
|
|
g = EZListView.new(label: " My PopUp List: ");
|
|
g.addItem(\item0, {"this is item 0". postln});
|
|
g.addItem(\item1, {"this is item 1". postln});
|
|
g.addItem(\item2, {"this is item 2". postln});
|
|
g.setColors(Color.grey,Color.white);
|
|
)
|
|
::
|
|
Layout horizontal:
|
|
code::
|
|
(
|
|
g = EZListView.new(nil,205@180, "Choose One: ", layout:\horz);
|
|
10.do{|i| g.addItem("item"++i.asString, {("this is item" ++i.asString). postln})};
|
|
g.setColors(Color.grey,Color.white);
|
|
)
|
|
::
|
|
No labelView created, so set the window title:
|
|
code::
|
|
(
|
|
g = EZListView.new(bounds:200@230); // no label
|
|
12.do{|i| g.addItem("item"++i.asString, {("this is item" ++i.asString). postln})};
|
|
g.view.parent.findWindow.name=" choose item";
|
|
)
|
|
::
|
|
insert item:
|
|
code::
|
|
(
|
|
g = EZListView.new(nil,200@200, "List:");
|
|
g.addItem(\item0, {"this is item 0". postln});
|
|
g.addItem(\item1, {"this is item 1". postln});
|
|
g.addItem(\item2, {"this is item 2". postln});
|
|
g.addItem(\item4, {"this is item 4". postln});
|
|
)
|
|
|
|
g.insertItem(3, \item3, {"this is item 3". postln});
|
|
::
|
|
remove item:
|
|
code::
|
|
(
|
|
g = EZListView.new(nil,200@200, "List:");
|
|
g.addItem(\item0, {"this is item 0". postln});
|
|
g.addItem(\item1, {"this is item 1". postln});
|
|
g.addItem(\item2, {"this is item 2". postln});
|
|
g.addItem(\item4, {"this is item 4". postln});
|
|
g.insertItem(3, \item3, {"this is item 3". postln});
|
|
)
|
|
|
|
g.removeItemAt(1);
|
|
::
|
|
replace item:
|
|
code::
|
|
(
|
|
g = EZListView.new(nil,200@200, "List:");
|
|
g.addItem(\item0, {"this is item 0". postln});
|
|
g.addItem(\item1, {"this is item 1". postln});
|
|
g.addItem(\item2, {"this is item 2". postln});
|
|
g.addItem(\item3, {"this is item 3". postln});
|
|
)
|
|
|
|
g.replaceItemAt(2, \item2_replaced, {"this is item 2 replaced". postln});
|
|
::
|
|
|