summaryrefslogtreecommitdiffstats
path: root/documentation/components/components-listselect.asciidoc
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/components/components-listselect.asciidoc')
-rw-r--r--documentation/components/components-listselect.asciidoc57
1 files changed, 57 insertions, 0 deletions
diff --git a/documentation/components/components-listselect.asciidoc b/documentation/components/components-listselect.asciidoc
new file mode 100644
index 0000000000..900147ef1c
--- /dev/null
+++ b/documentation/components/components-listselect.asciidoc
@@ -0,0 +1,57 @@
+---
+title: ListSelect
+order: 17
+layout: page
+---
+
+[[components.listselect]]
+= [classname]#ListSelect#
+
+The [classname]#ListSelect# component is list box that shows the selectable
+items in a vertical list. If the number of items exceeds the height of the
+component, a scrollbar is shown. The component allows both single and multiple
+selection modes, which you can set with [methodname]#setMultiSelect()#. It is
+visually identical in both modes.
+
+
+[source, java]
+----
+// Create the selection component
+ListSelect select = new ListSelect("The List");
+
+// Add some items (here by the item ID as the caption)
+select.addItems("Mercury", "Venus", "Earth", ...);
+
+select.setNullSelectionAllowed(false);
+
+// Show 5 items and a scrollbar if there are more
+select.setRows(5);
+----
+
+The number of visible items is set with [methodname]#setRows()#.
+
+[[figure.components.listselect.basic]]
+.The [classname]#ListSelect# Component
+image::img/listselect-basic.png[]
+
+Common selection component features are described in
+<<dummy/../../../framework/components/components-selection#components.selection,"Selection
+Components">>.
+
+== CSS Style Rules
+
+
+[source, css]
+----
+.v-select {}
+ .v-select-select {}
+ option {}
+----
+
+The component has an overall [literal]#++v-select++# style. The native
+[literal]#++<select>++# element has [literal]#++v-select-select++# style. The
+items are represented as [literal]#++<option>++# elements.
+
+
+
+