Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
A Spinner component with a floating label for Android, similar to EditText components wrapped in a TextInputLayout.
/*
* Copyright 2015 Farbod Salamat-Zadeh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.yourcompany.yourapp.widget;
import android.content.Context;
import android.content.res.TypedArray;
import android.support.annotation.ArrayRes;
import android.support.annotation.ColorRes;
import android.support.annotation.LayoutRes;
import android.support.annotation.StringRes;
import android.util.AttributeSet;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import android.widget.AdapterView;
import android.widget.ArrayAdapter;
import android.widget.LinearLayout;
import android.widget.Spinner;
import android.widget.SpinnerAdapter;
import android.widget.TextView;
import com.yourcompany.yourapp.R;
import java.util.ArrayList;
public class LabelledSpinner extends LinearLayout implements AdapterView.OnItemSelectedListener {
/**
* The label positioned above the Spinner, similar to the floating
* label from a {@link android.support.design.widget.TextInputLayout}.
*/
private TextView mLabel;
/**
* The Spinner component used in this layout.
*/
private Spinner mSpinner;
/**
* A thin (1dp thick) divider line positioned below the Spinner,
* similar to the bottom line in an {@link android.widget.EditText}.
*/
private View mDivider;
/**
* The listener that receives notifications when an item in the
* AdapterView is selected.
*/
private OnItemChosenListener mOnItemChosenListener;
/**
* The main color used in the widget (the label color and divider
* color). This may be updated when XML attributes are obtained and
* again if the color is set programmatically.
*/
private int mWidgetColor;
public LabelledSpinner(Context context) {
this(context, null);
}
public LabelledSpinner(Context context, AttributeSet attrs) {
super(context, attrs);
initializeViews(context, attrs);
}
private void initializeViews(Context context, AttributeSet attrs) {
TypedArray typedArray = context.obtainStyledAttributes(
attrs,
R.styleable.LabelledSpinner,
0,
0);
String labelText = a.getString(R.styleable.LabelledSpinner_labelText);
mWidgetColor = typedArray.getColor(R.styleable.LabelledSpinner_widgetColor,
getResources().getColor(R.color.widget_labelled_spinner));
typedArray.recycle();
LayoutInflater inflater =
(LayoutInflater) context.getSystemService(Context.LAYOUT_INFLATER_SERVICE);
inflater.inflate(R.layout.widget_labelled_spinner, this, true);
setOrientation(LinearLayout.VERTICAL);
setLayoutParams(new LayoutParams(
ViewGroup.LayoutParams.MATCH_PARENT,
ViewGroup.LayoutParams.WRAP_CONTENT));
mLabel = (TextView) getChildAt(0);
mLabel.setText(labelText);
mLabel.setPadding(0, dpToPixels(16), 0, 0);
mLabel.setTextColor(mWidgetColor);
mSpinner = (Spinner) getChildAt(1);
mSpinner.setPadding(0, dpToPixels(8), 0, dpToPixels(8));
mSpinner.setOnItemSelectedListener(this);
mDivider = getChildAt(2);
MarginLayoutParams dividerParams =
(MarginLayoutParams) mDivider.getLayoutParams();
dividerParams.rightMargin = dpToPixels(4);
dividerParams.bottomMargin = dpToPixels(8);
mDivider.setLayoutParams(dividerParams);
mDivider.setBackgroundColor(mWidgetColor);
alignLabelWithSpinnerItem(4);
}
public TextView getLabel() {
return mLabel;
}
public Spinner getSpinner() {
return mSpinner;
}
public View getDivider() {
return mDivider;
}
/**
* Sets the text the label is to display.
*
* @see #setLabelText(int)
*
* @param labelText The CharSequence value to be displayed on the label.
*/
public void setLabelText(CharSequence labelText) {
mLabel.setText(labelText);
}
/**
* Sets the text the label is to display.
*
* @see #setLabelText(CharSequence)
*
* @param labelTextId The string resource identifier which refers to
* the string value which is to be displayed on
* the label.
*/
public void setLabelText(@StringRes int labelTextId) {
mLabel.setText(getResources().getString(labelTextId));
}
public CharSequence getLabelText() {
return mLabel.getText();
}
/**
* Sets the color to use for the label text and the divider line
* underneath.
*
* @param colorRes The color resource identifier which refers to the
* color that is to be displayed on the widget.
*/
public void setColor(@ColorRes int colorRes) {
mLabel.setTextColor(getResources().getColor(colorRes));
mDivider.setBackgroundColor(getResources().getColor(colorRes));
}
public int getColor() {
return mWidgetColor;
}
/**
* Sets the array of items to be used in the Spinner.
*
* @see #setItemsArray(ArrayList)
* @see #setItemsArray(int, int, int)
*
* @param arrayResId The identifier of the array to use as the data
* source (e.g. R.array.myArray)
*/
public void setItemsArray(@ArrayRes int arrayResId) {
setItemsArray(
arrayResId,
android.R.layout.simple_spinner_item,
android.R.layout.simple_spinner_dropdown_item
);
}
/**
* Sets the array of items to be used in the Spinner.
*
* @see #setItemsArray(int)
* @see #setItemsArray(int, int, int)
*
* @param arrayList The ArrayList used as the data source
*/
public void setItemsArray(ArrayList<String> arrayList) {
ArrayAdapter<String> adapter = new ArrayAdapter<>(
getContext(),
android.R.layout.simple_spinner_item,
arrayList);
adapter.setDropDownViewResource(android.R.layout.simple_spinner_dropdown_item);
mSpinner.setAdapter(adapter);
}
/**
* A private helper method to set the array of items to be used in the
* Spinner.
*
* @see #setItemsArray(int)
* @see #setItemsArray(ArrayList)
*
* @param arrayResId The identifier of the array to use as the data
* source (e.g. R.array.myArray)
* @param spinnerItemRes The identifier of the layout used to create
* views (e.g. R.layout.my_item)
* @param dropdownViewRes The layout resource to create the drop down
* views (e.g. R.layout.my_dropdown)
*/
private void setItemsArray(@ArrayRes int arrayResId, @LayoutRes int spinnerItemRes, @LayoutRes int dropdownViewRes) {
ArrayAdapter<CharSequence> adapter = ArrayAdapter.createFromResource(
getContext(),
arrayResId,
spinnerItemRes);
adapter.setDropDownViewResource(dropdownViewRes);
mSpinner.setAdapter(adapter);
}
/**
* Sets the Adapter used to provide the data for the Spinner.
* This would be similar to setting an Adapter for a normal Spinner
* component.
*
* @param adapter The Adapter which would provide data for the Spinner
*/
public void setCustomAdapter(SpinnerAdapter adapter) {
mSpinner.setAdapter(adapter);
}
/**
* Sets the currently selected item.
*
* @param position Index (starting at 0) of the data item to be selected.
*/
public void setSelection(int position) {
mSpinner.setSelection(position);
}
/**
* Interface definition for a callback to be invoked when an item in this
* LabelledSpinner's Spinner view has been selected.
*/
public interface OnItemChosenListener {
/**
* Callback method to be invoked when an item in this LabelledSpinner's
* spinner view has been selected. This callback is invoked only when
* the newly selected position is different from the previously selected
* position or if there was no selected item.
*
* @param labelledSpinner The LabelledSpinner where the selection
* happened. This view contains the AdapterView.
* @param adapterView The AdapterView where the selection happened. Note
* that this AdapterView is part of the LabelledSpinner
* component.
* @param itemView The view within the AdapterView that was clicked.
* @param position The position of the view in the adapter.
* @param id The row id of the item that is selected.
*/
void onItemChosen(View labelledSpinner, AdapterView<?> adapterView, View itemView, int position, long id);
/**
* Callback method to be invoked when the selection disappears from this
* view. The selection can disappear for instance when touch is activated
* or when the adapter becomes empty.
*
* @param labelledSpinner The LabelledSpinner view that contains the
* AdapterView.
* @param adapterView The AdapterView that now contains no selected item.
*/
void onNothingChosen(View labelledSpinner, AdapterView<?> adapterView);
}
/**
* Register a callback to be invoked when an item in this AdapterView has
* been selected.
* This would be similar to setting an OnItemSelectedListener for a normal
* Spinner component.
*
* @param onItemChosenListener The callback that will run
*/
public void setOnItemChosenListener(OnItemChosenListener onItemChosenListener) {
mOnItemChosenListener = onItemChosenListener;
}
public OnItemChosenListener getOnItemChosenListener() {
return mOnItemChosenListener;
}
/**
* Implemented method from {@link android.widget.AdapterView.OnItemSelectedListener}
*/
@Override
public void onItemSelected(AdapterView<?> parent, View view, int position, long id) {
if (mOnItemChosenListener != null) {
// 'this' refers to this LabelledSpinner component
mOnItemChosenListener.onItemChosen(this, parent, view, position, id);
}
}
/**
* Implemented method from {@link android.widget.AdapterView.OnItemSelectedListener}
*/
@Override
public void onNothingSelected(AdapterView<?> parent) {
if (mOnItemChosenListener != null) {
// 'this' refers to this LabelledSpinner component
mOnItemChosenListener.onNothingChosen(this, parent);
}
}
/**
* Adds a 4dp left margin to the label and divider line underneath so that
* it aligns with the Spinner item text. By default, the additional 4dp
* margin will not be added.
*
* @see #alignLabelWithSpinnerItem(int)
*
* Note: By default, however, a 4dp margin will be added so that the label
* and divider align correctly with other UI components, such as the label
* in a {@link android.support.design.widget.TextInputLayout}. This means
* that if {@param indentLabel} is true, an 8dp left margin will be added
* (this would be the 4dp margin to align with other UI components with
* an additional 4dp margin to align the label with the Spinner item text.
* Also note that if {@param indentLabel} is true, the label and divider
* will not be aligned with other UI components as they would be 4dp
* further right from them.
*
* @param indentLabel Whether or not the label will be indented
*/
public void alignLabelWithSpinnerItem(boolean indentLabel) {
if (indentLabel) {
alignLabelWithSpinnerItem(8);
} else {
alignLabelWithSpinnerItem(4);
}
}
/**
* A helper method responsible for adding left margins to the label and
* divider line underneath, used to align these to the start of the Spinner
* item text.
*
* @see #alignLabelWithSpinnerItem(boolean)
*
* @param indentDps The density-independent pixel value for the left margin
*/
private void alignLabelWithSpinnerItem(int indentDps) {
MarginLayoutParams labelParams =
(MarginLayoutParams) mLabel.getLayoutParams();
labelParams.leftMargin = dpToPixels(indentDps);
mLabel.setLayoutParams(labelParams);
MarginLayoutParams dividerParams =
(MarginLayoutParams) mDivider.getLayoutParams();
dividerParams.leftMargin = dpToPixels(indentDps);
mDivider.setLayoutParams(dividerParams);
}
/**
* A helper method responsible for the conversion of dp/dip (density-independent
* pixel) values to pixels, so that they can be used when setting layout
* parameters such as margins.
*
* @param dps The density-independent pixel value
* @return The pixel value from the conversion
*/
private int dpToPixels(int dps) {
if (dps == 0) {
return 0;
}
final float scale = getResources().getDisplayMetrics().density;
return (int) (dps * scale + 0.5f);
}
}
<?xml version="1.0" encoding="utf-8"?>
<!-- Copyright 2015 Farbod Salamat-Zadeh
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:custom="http://schemas.android.com/apk/res-auto"
xmlns:tools="http://schemas.android.com/tools"
android:orientation="vertical"
android:layout_width="match_parent"
android:layout_height="match_parent"
tools:context="com.yourcompany.yourapp.YourActivity">
<com.yourcompany.yourapp.widget.LabelledSpinner
android:id="@+id/your_labelled_spinner"
custom:labelText="@string/your_spinner_label"
custom:widgetColor="#F44336"
android:layout_width="match_parent"
android:layout_height="wrap_content" />
</LinearLayout>
/*
* Copyright 2015 Farbod Salamat-Zadeh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.yourcompany.yourapp;
import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.view.View;
import android.widget.AdapterView;
import com.yourcompany.yourapp.widget.LabelledSpinner;
public class ExampleActivity extends AppCompatActivity implements LabelledSpinner.OnItemChosenListener {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.example_usage);
LabelledSpinner yourSpinner = (LabelledSpinner) findViewById(R.id.your_labelled_spinner);
yourSpinner.setItemsArray(R.array.your_array);
yourSpinner.setOnItemChosenListener(this);
}
@Override
public void onItemChosen(View labelledSpinner, AdapterView<?> adapterView, View itemView, int position, long id) {
String selectedText = adapterView.getItemAtPosition(position).toString();
switch (labelledSpinner.getId()) {
case R.id.your_labelled_spinner:
// Do something here
break;
// If you have multiple LabelledSpinners, you can add more cases here
}
}
@Override
public void onNothingChosen(View labelledSpinner, AdapterView<?> adapterView) {
// Do something here
}
}
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
<?xml version="1.0" encoding="utf-8"?>
<!-- Copyright 2015 Farbod Salamat-Zadeh
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<resources>
<declare-styleable name="LabelledSpinner" >
<attr name="labelText" format="string" />
<attr name="widgetColor" format="color" />
</declare-styleable>
<color name="widget_labelled_spinner">#6D6D6D</color>
</resources>
<?xml version="1.0" encoding="utf-8"?>
<!-- Copyright 2015 Farbod Salamat-Zadeh
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<merge xmlns:android="http://schemas.android.com/apk/res/android">
<TextView
android:textSize="12sp"
android:layout_width="match_parent"
android:layout_height="wrap_content" />
<Spinner
android:layout_width="match_parent"
android:layout_height="wrap_content" />
<View
android:gravity="start|center_vertical"
android:layout_width="match_parent"
android:layout_height="1dp" />
</merge>
@FarbodSalamat-Zadeh

This comment has been minimized.

Copy link

FarbodSalamat-Zadeh commented Jan 2, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.