Differences

This shows you the differences between two versions of the page.

--- mistudio:design_editor:more_layout:text_display_lists:list [2026/09/18 13:37] – removed - external edit (Unknown date) 127.0.0.1
+++ mistudio:design_editor:more_layout:text_display_lists:list [2026/09/18 15:44] (current) – tputman
@@ Line 1: / Line 1: @@
+===== List =====
+com.ergotech.vib.graphics.swing.SwingList
+==== Image Examples ====
+| {{:mistudio:graphics:more_layout:text_display_lists:pasted:20260627-102459.png?40|List in the graphics palette}} | {{:mistudio:graphics:more_layout:text_display_lists:pasted:20260627-102717.png?80|List graphic example}} |
+| //List in the graphics palette.// | //List graphic example.// |
+==== Overview ====
+The List graphic is a More Layout selection graphic used to display a list of selectable items.
+List shows the available choices directly in the list field. When the user selects an item, the selected value can be sent through the output.
+The list items can be entered manually using the **Hand Entered Items** property or updated through logic.
+==== Common Uses ====
+  * Displaying a list of choices
+  * Letting users select one item from a list
+  * Sending a selected value into application logic
+  * Sending the selected item text
+  * Sending the selected item index
+  * Showing selectable options in an application screen
+==== Input Behavior ====
+List can be updated from an input connection.
+The **updateDisplayedValue** port updates the displayed list values from another source.
+When an array value is sent into the List, each item in the array is added to the list.
+==== Output Behavior ====
+List sends the selected item through **PrimaryOutPort**.
+By default, the output is the string value of the selected item.
+If **Output Index** is enabled, the output is the zero-based index of the selected item. The first item in the list is index **0**.
+==== List-Specific Behavior ====
+List is designed for single-selection list behavior.
+List-specific settings include:
+  * **Name** Sets the name of the List graphic.
+  * **Delimiter** Sets the delimiter used to separate hand-entered list items.
+  * **Hand Entered Items** Sets the list choices entered directly in the property panel.
+  * **Output Index** Controls whether the output is the selected item text or the selected item index.
+  * **Enabled** Controls whether the user can interact with the List.
+  * **Font** Controls the font used for list text.
+  * **Text Color** Sets the list text color.
+  * **Background Color** Sets the list background color.
+  * **Visible** Controls whether the List is shown.
+==== Hand Entered Items ====
+The **Hand Entered Items** property is used to enter list choices manually.
+For example:
+  * **High,Low,Normal**
+  * **One,Two,Three**
+  * **Open,Closed,Unknown**
+Do not add spaces around the delimiter unless the spaces should be part of the displayed item text.
+==== Logic Ports ====
+In the Logic Editor, List includes these default ports:
+  * **PrimaryOutPort**
+  * **updateDisplayedValue**
+The **PrimaryOutPort** sends the selected list value or selected index.
+The **updateDisplayedValue** port updates the displayed list values from another source.
+==== Notes ====
+Use List when users need to select one item from a visible list of choices.
+Use **Output Index** when application logic needs the numeric position of the selected item instead of the item text.
+For selecting multiple items, use [[mistudio:design_editor:more_layout:text_display_lists:multiselectlist|MultiselectList]].
+For moving or selecting items between two lists, use [[mistudio:design_editor:more_layout:text_display_lists:multiselectduallist|MultiselectDualList]].
+For general graphic behavior, see [[mistudio:design_editor:active_graphic|Active Graphic]].
+==== Related Pages ====
+  * [[mistudio:design_editor:start|MIStudio Design Editor]]
+  * [[mistudio:design_editor:more_layout:start|More Layout]]
+  * [[mistudio:design_editor:more_layout:text_display_lists:start|Text, Display, Lists, and Tables]]
+  * [[mistudio:design_editor:more_layout:text_display_lists:multiselectlist|MultiselectList]]
+  * [[mistudio:design_editor:more_layout:text_display_lists:multiselectduallist|MultiselectDualList]]
+  * [[mistudio:design_editor:active_graphic|Active Graphic]]