Für ein aktuelles Android Projekt bin ich auf folgendes Problem gestoßen:
Wie bekomme ich meine Enum Werte bequem in einen Spinner und kann den Text auch noch internationalisieren?
Die Lösung für dieses Problem möchte ich hier gerne beschreiben:
Ziel
Mein Ziel ist es einen Custom ArrayAdapter zu schreiben welcher ein Array mit Enum Werten als Parameter bekommt. Die übergebenen Werte sollen internationalisiert werden können und eine Wiederverwendung soll auch gegeben werden.
Hinweis
Wenn man auf die Internationalisierung der Texte verzichten möchte, so kann man auch bequem die toString Methode überschreiben und dort den Text ausgeben. Dieser Text dient dann einem ArrayAdapter als Anzeigewert.
Spinner commandSpinner = (Spinner) findViewById(R.id.mySpinnerId); commandSpinner.setAdapter(new ArrayAdapter<CommandType>(this, android.R.layout.simple_spinner_item, CommandType.values()));
Interface
Damit ich den ArrayAdapter an anderer Stelle wiederverwenden kann nutze ich folgendes Interface:
public interface IEnumSpinnerValue {
int getLabelTextResourceId();
}
Als nächstes lasse ich mein Enum dieses Inteface implementieren.
Enum
Ein Enum (Enumeration == Aufzählungstyp), liefert pro Enumexpression genau eine Instanz (und immer dieselbe).
public enum CommandType implements IEnumSpinnerValue {
TEXT(0) {
@Override
public int getLabelTextResourceId() { return R.string.cmd_text; }
}, DEVICE_SENSOR(1) {
@Override
public int getLabelTextResourceId() { return R.string.cmd_deviceSensor; }
}, TIMER(2) {
@Override
public int getLabelTextResourceId() { return R.string.cmd_timer; }
};
}
In jeder Enumexpression überschreibe ich die Methode getLabelTextResourceId aus dem implementierten Interface. Als Rückgabewert übergebe ich die ResourceID aus der string.xml Datei.
Custom ArrayAdapter für den Spinner
Nun benötigt man noch den eigenen ArrayAdapter.
public class EnumSpinnerArrayAdapter extends ArrayAdapter<IEnumSpinnerValue> {
public EnumSpinnerArrayAdapter(Context context, IEnumSpinnerValue[] values) {
super(context, -1, values);
}
...
}
Die Klasse EnumSpinnerArrayAdapter erweitert die Klasse ArrayAdapter. Da die Klasse ArrayAdapter keinen default Konstruktor besitzt, muss man min. 1 Konstruktor der Klasse implementieren.
Für diesen Fall benötige ich nur einen, wo ich den Context und ein Array mit Werten übergeben kann. Im Konstruktor selber rufe ich mit super einen anderen Konstruktor auf wo ich die Resource ID für die Darstellung des PopUpDialoges mit -1 benenne. Das Design für den PopUpDialog lege ich beim Überschreiben der Methode getDropDownView fest.
Überschreiben der Methode getView
Für die eigene Darstellung des Spinners in der Activity muss die Methode getView überschrieben werden.
@NonNull
@Override
public View getView(int position, View convertView, ViewGroup parent) {
LayoutInflater inflater = (LayoutInflater) getContext().getSystemService(Context.LAYOUT_INFLATER_SERVICE);
View view = inflater.inflate(R.layout.enumspinner_listitem, parent, false);
IEnumSpinnerValue value = getItem(position);
TextView lblTextView = (TextView) view.findViewById(R.id.lblTextView);
lblTextView.setText(getContext().getString(value.getLabelTextResourceId()));
return view;
}
In dieser Methode lade ich mir mein eigenes Layout und hole aus dem Array den wenötigten Wert welcher mir die String Resource ID liefert. Über dieser ID kann man dann mit der Methode getString den Text bekommen.
Überschreiben der Methode getDropDownView
Da auch der DropDownDialog angepasst werden muss, wird die Methode getDropDownView auch überschrieben. In der Defaulteigenschaft würde sonst hier die toString Methode aufgerufen werden und mein Wert wäre sonst einfach in Großbuchstaben dargestellt.
public View getDropDownView(int position, View convertView, ViewGroup parent) {
LayoutInflater inflater = (LayoutInflater) getContext().getSystemService(Context.LAYOUT_INFLATER_SERVICE);
View view = inflater.inflate(R.layout.enumspinner_listitem, parent, false);
IEnumSpinnerValue value = getItem(position);
TextView lblTextView = (TextView) view.findViewById(R.id.lblTextView);
lblTextView.setText(getContext().getString(value.getLabelTextResourceId()));
return view;
}
Der Vereinfachung habe ich hier dasselbe Layout gewählt. Ansonsten ist es derselbe Aufbau und daher habe ich die beiden Methoden in ihre Aufgaben zerlegt und dadurch unnötigen doppelten Code entfernt.
@NonNull
@Override
public View getView(int position, View convertView, ViewGroup parent) {
View view = getCustomView(parent);
setEnumValueText(position, view);
return view;
}
public View getDropDownView(int position, View convertView, ViewGroup parent) {
View view = getCustomView(parent);
setEnumValueText(position, view);
return view;
}
private View getCustomView(ViewGroup parent) {
LayoutInflater inflater = (LayoutInflater) getContext().getSystemService(Context.LAYOUT_INFLATER_SERVICE);
View view = inflater.inflate(R.layout.enumspinner_listitem, parent, false);
return view;
}
private void setEnumValueText(int position, View view) {
IEnumSpinnerValue value = getItem(position);
TextView lblTextView = (TextView) view.findViewById(R.id.lblTextView);
lblTextView.setText(getContext().getString(value.getLabelTextResourceId()));
}
Damit ist der eigene ArrayAdapter schon fertig und kann nun dem Spinner übergeben werden.
Das Layout des Spinners
Das Layout ist einfach aufgebaut, da ich nur einen Text anzeigen möchte, enthält dieses nur eine TextView.
<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
android:orientation="vertical" android:layout_width="match_parent"
android:layout_height="match_parent">
<TextView
android:text="TextView"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:id="@+id/lblTextView"
android:textColor="@android:color/black" />
</LinearLayout>
Verwenden des ArrayAdapters
Erzeugen wir uns nun eine Instanz des EnumSpinnerArrayAdapter damit man diesem den Spinner zuweisen können.
EnumSpinnerArrayAdapter commandEnumSpinnerArrayAdapter = new EnumSpinnerArrayAdapter(getApplicationContext(), CommandType.values());
Diesem ArrayAdapter wird der Context übergeben sowie ein Array mit den Enumexpressions.
Mit der bekannten Methode setAdapter an dem Spinner weisen wir nun noch dem Spinner den Adapter zu und können unseren ersten Test starten.
commandTypeSpinner = (Spinner) findViewById(R.id.commandTypeSpinner); commandTypeSpinner.setAdapter(commandEnumSpinnerArrayAdapter);