1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
page.title=Spinners
page.tags=adapterview,spinneradapter
@jd:body
<div id="qv-wrapper">
<div id="qv">
<h2>In this document</h2>
<ol>
<li><a href="#Populate">Populate the Spinner with User Choices</a></li>
<li><a href="#SelectListener">Responding to User Selections</a></li>
</ol>
<h2>Key classes</h2>
<ol>
<li>{@link android.widget.Spinner}</li>
<li>{@link android.widget.SpinnerAdapter}</li>
<li>{@link android.widget.AdapterView.OnItemSelectedListener}</li>
</ol>
</div>
</div>
<p>Spinners provide a quick way to select one value from a set. In the default state, a spinner
shows its currently selected value. Touching the spinner displays a dropdown menu with all other
available values, from which the user can select a new one.</p>
<img src="{@docRoot}images/ui/spinner.png" alt="" />
<p>You can add a spinner to your layout with the {@link android.widget.Spinner} object. You
should usually do so in your XML layout with a {@code <Spinner>} element. For example:</p>
<pre>
<Spinner
android:id="@+id/planets_spinner"
android:layout_width="fill_parent"
android:layout_height="wrap_content" />
</pre>
<p>To populate the spinner with a list of choices, you then need to specify a {@link
android.widget.SpinnerAdapter} in your {@link android.app.Activity} or {@link android.app.Fragment}
source code.</p>
<h2 id="Populate">Populate the Spinner with User Choices</h2>
<p>The choices you provide for the spinner can come from any source, but must be provided through
an {@link android.widget.SpinnerAdapter}, such as an {@link android.widget.ArrayAdapter} if the
choices are available in an array or a {@link android.widget.CursorAdapter} if the choices are
available from a database query.</p>
<p>For instance, if the available choices for your spinner are pre-determined, you can provide
them with a string array defined in a <a
href="{@docRoot}guide/topics/resources/string-resource.html">string
resource file</a>:</p>
<pre>
<?xml version="1.0" encoding="utf-8"?>
<resources>
<string-array name="planets_array">
<item>Mercury</item>
<item>Venus</item>
<item>Earth</item>
<item>Mars</item>
<item>Jupiter</item>
<item>Saturn</item>
<item>Uranus</item>
<item>Neptune</item>
</string-array>
</resources>
</pre>
<p>With an array such as this one, you can use the following code in your {@link
android.app.Activity} or {@link android.app.Fragment} to supply the spinner with the array using
an instance of {@link android.widget.ArrayAdapter}:
<pre>
Spinner spinner = (Spinner) findViewById(R.id.spinner);
// Create an ArrayAdapter using the string array and a default spinner layout
ArrayAdapter<CharSequence> adapter = ArrayAdapter.createFromResource(this,
R.array.planets_array, android.R.layout.simple_spinner_item);
// Specify the layout to use when the list of choices appears
adapter.setDropDownViewResource(android.R.layout.simple_spinner_dropdown_item);
// Apply the adapter to the spinner
spinner.setAdapter(adapter);
</pre>
<p>The {@link
android.widget.ArrayAdapter#createFromResource(Context,int,int) createFromResource()} method allows
you to create an {@link android.widget.ArrayAdapter} from the string array. The third argument for
this method is a layout resource that defines how the selected choice appears in the
spinner control. The {@link android.R.layout#simple_spinner_item} layout is provided by the
platform and is the default layout you should use unless you'd like to define your own layout
for the spinner's appearance.</p>
<p>You should then call {@link android.widget.ArrayAdapter#setDropDownViewResource(int)} to specify
the layout the adapter should use to display the list of spinner choices ({@link
android.R.layout#simple_spinner_dropdown_item} is another standard layout defined by the
platform).</p>
<p>Call {@link android.widget.AdapterView#setAdapter setAdapter()} to apply the adapter to your
{@link android.widget.Spinner}.</p>
<h2 id="SelectListener">Responding to User Selections</h2>
<p>When the user selects an item from the drop-down, the {@link android.widget.Spinner} object
receives an on-item-selected event.</p>
<p>To define the selection event handler for a spinner, implement the {@link
android.widget.AdapterView.OnItemSelectedListener} interface and the corresponding {@link
android.widget.AdapterView.OnItemSelectedListener#onItemSelected onItemSelected()} callback method.
For example, here's an implementation of the interface in an {@link android.app.Activity}:</p>
<pre>
public class SpinnerActivity extends Activity implements OnItemSelectedListener {
...
public void onItemSelected(AdapterView<?> parent, View view,
int pos, long id) {
// An item was selected. You can retrieve the selected item using
// parent.getItemAtPosition(pos)
}
public void onNothingSelected(AdapterView<?> parent) {
// Another interface callback
}
}
</pre>
<p>The {@link android.widget.AdapterView.OnItemSelectedListener} requires the {@link
android.widget.AdapterView.OnItemSelectedListener#onItemSelected(AdapterView,View,int,long)
onItemSelected()} and {@link
android.widget.AdapterView.OnItemSelectedListener#onNothingSelected(AdapterView)
onNothingSelected()} callback methods.</p>
<p>Then you need to specify the interface implementation by calling {@link
android.widget.AdapterView#setOnItemSelectedListener setOnItemSelectedListener()}:</p>
<pre>
Spinner spinner = (Spinner) findViewById(R.id.spinner);
spinner.setOnItemSelectedListener(this);
</pre>
<p>If you implement the {@link
android.widget.AdapterView.OnItemSelectedListener} interface with your {@link
android.app.Activity} or {@link android.app.Fragment} (such as in the example above), you can pass
<code>this</code> as the interface instance.</p>
|
