10 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # built application files
2 | *.apk
3 | *.ap_
4 |
5 | # files for the dex VM
6 | *.dex
7 |
8 | # Java class files
9 | *.class
10 |
11 | # generated files
12 | bin/
13 | gen/
14 |
15 | # Local configuration file (sdk path, etc)
16 | local.properties
17 |
18 | # Eclipse project files
19 | .classpath
20 | .project
21 |
--------------------------------------------------------------------------------
/EmptyLayout/res/values-sw720dp-land/dimens.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
7 | 128dp
8 |
9 |
10 |
--------------------------------------------------------------------------------
/EmptyLayoutSample/res/values-sw720dp-land/dimens.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
7 | 128dp
8 |
9 |
10 |
--------------------------------------------------------------------------------
/EmptyLayout/AndroidManifest.xml:
--------------------------------------------------------------------------------
1 |
2 |
6 |
7 |
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/EmptyLayout/res/values-v11/styles.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
7 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/EmptyLayoutSample/res/values-v11/styles.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
7 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/EmptyLayout/res/values-v14/styles.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
8 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/EmptyLayoutSample/res/values-v14/styles.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
8 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/EmptyLayout/res/values/strings.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Empty View
5 | Settings
6 |
7 |
8 | No items yet
9 | Please wait
10 | Oops! Something wrong happened
11 |
12 | Try again
13 | Cancel
14 | Try again
15 |
16 |
17 |
--------------------------------------------------------------------------------
/EmptyLayout/project.properties:
--------------------------------------------------------------------------------
1 | # This file is automatically generated by Android Tools.
2 | # Do not modify this file -- YOUR CHANGES WILL BE ERASED!
3 | #
4 | # This file must be checked in Version Control Systems.
5 | #
6 | # To customize properties used by the Ant build system edit
7 | # "ant.properties", and override values to adapt the script to your
8 | # project structure.
9 | #
10 | # To enable ProGuard to shrink and obfuscate your code, uncomment this (available properties: sdk.dir, user.home):
11 | #proguard.config=${sdk.dir}/tools/proguard/proguard-android.txt:proguard-project.txt
12 |
13 | # Project target.
14 | target=android-17
15 | android.library=true
16 |
--------------------------------------------------------------------------------
/EmptyLayoutSample/project.properties:
--------------------------------------------------------------------------------
1 | # This file is automatically generated by Android Tools.
2 | # Do not modify this file -- YOUR CHANGES WILL BE ERASED!
3 | #
4 | # This file must be checked in Version Control Systems.
5 | #
6 | # To customize properties used by the Ant build system edit
7 | # "ant.properties", and override values to adapt the script to your
8 | # project structure.
9 | #
10 | # To enable ProGuard to shrink and obfuscate your code, uncomment this (available properties: sdk.dir, user.home):
11 | #proguard.config=${sdk.dir}/tools/proguard/proguard-android.txt:proguard-project.txt
12 |
13 | # Project target.
14 | target=android-17
15 | android.library.reference.1=../EmptyLayout
16 |
--------------------------------------------------------------------------------
/EmptyLayout/res/values/styles.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
7 |
14 |
15 |
16 |
19 |
20 |
21 |
--------------------------------------------------------------------------------
/EmptyLayoutSample/res/values/styles.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
7 |
14 |
15 |
16 |
19 |
20 |
21 |
--------------------------------------------------------------------------------
/EmptyLayout/proguard-project.txt:
--------------------------------------------------------------------------------
1 | # To enable ProGuard in your project, edit project.properties
2 | # to define the proguard.config property as described in that file.
3 | #
4 | # Add project specific ProGuard rules here.
5 | # By default, the flags in this file are appended to flags specified
6 | # in ${sdk.dir}/tools/proguard/proguard-android.txt
7 | # You can edit the include path and order by changing the ProGuard
8 | # include property in project.properties.
9 | #
10 | # For more details, see
11 | # http://developer.android.com/guide/developing/tools/proguard.html
12 |
13 | # Add any project specific keep options here:
14 |
15 | # If your project uses WebView with JS, uncomment the following
16 | # and specify the fully qualified class name to the JavaScript interface
17 | # class:
18 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview {
19 | # public *;
20 | #}
21 |
--------------------------------------------------------------------------------
/EmptyLayoutSample/proguard-project.txt:
--------------------------------------------------------------------------------
1 | # To enable ProGuard in your project, edit project.properties
2 | # to define the proguard.config property as described in that file.
3 | #
4 | # Add project specific ProGuard rules here.
5 | # By default, the flags in this file are appended to flags specified
6 | # in ${sdk.dir}/tools/proguard/proguard-android.txt
7 | # You can edit the include path and order by changing the ProGuard
8 | # include property in project.properties.
9 | #
10 | # For more details, see
11 | # http://developer.android.com/guide/developing/tools/proguard.html
12 |
13 | # Add any project specific keep options here:
14 |
15 | # If your project uses WebView with JS, uncomment the following
16 | # and specify the fully qualified class name to the JavaScript interface
17 | # class:
18 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview {
19 | # public *;
20 | #}
21 |
--------------------------------------------------------------------------------
/EmptyLayoutSample/AndroidManifest.xml:
--------------------------------------------------------------------------------
1 |
2 |
6 |
7 |
10 |
11 |
16 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
--------------------------------------------------------------------------------
/EmptyLayout/res/layout/view_empty.xml:
--------------------------------------------------------------------------------
1 |
2 |
7 |
8 |
9 |
18 |
19 |
26 |
27 |
28 |
--------------------------------------------------------------------------------
/EmptyLayout/res/layout/view_error.xml:
--------------------------------------------------------------------------------
1 |
2 |
7 |
8 |
17 |
18 |
25 |
26 |
27 |
--------------------------------------------------------------------------------
/EmptyLayout/res/layout/view_loading.xml:
--------------------------------------------------------------------------------
1 |
2 |
7 |
8 |
14 |
15 |
24 |
25 |
31 |
32 |
33 |
--------------------------------------------------------------------------------
/EmptyLayoutSample/res/layout/activity_main.xml:
--------------------------------------------------------------------------------
1 |
6 |
7 |
14 |
15 |
20 |
21 |
26 |
27 |
32 |
37 |
38 |
39 |
45 |
46 |
47 |
--------------------------------------------------------------------------------
/EmptyLayoutSample/src/com/kanak/emptylayoutsample/MainActivity.java:
--------------------------------------------------------------------------------
1 | package com.kanak.emptylayoutsample;
2 |
3 | import java.util.ArrayList;
4 | import java.util.Arrays;
5 |
6 | import com.kanak.emptylayout.EmptyLayout;
7 |
8 |
9 | import android.os.Bundle;
10 | import android.view.View;
11 | import android.view.View.OnClickListener;
12 | import android.widget.ArrayAdapter;
13 | import android.widget.Toast;
14 | import android.app.ListActivity;
15 |
16 | public class MainActivity extends ListActivity {
17 |
18 | private EmptyLayout mEmptyLayout; // this is required to show different layouts (loading or empty or error)
19 | private ArrayAdapter mAdapter;
20 | private View.OnClickListener mErrorClickListener = new OnClickListener() {
21 | @Override
22 | public void onClick(View v) {
23 | Toast.makeText(MainActivity.this, "Try again button clicked", Toast.LENGTH_LONG).show();
24 | }
25 | };
26 |
27 | // the list items
28 | static final String[] MOVIES = new String[] {
29 | "Forrest Gump",
30 | "Toy Story",
31 | "Saving Private Ryan",
32 | "Toy Story 2",
33 | "The Green Mile",
34 | "Cast Away",
35 | "Road to Perdition",
36 | "Catch Me If You Can",
37 | "The Terminal",
38 | "The Polar Express",
39 | "The Da Vinci Code",
40 | "Angels & Demons",
41 | "Toy Story 3",
42 | "Extremely Loud & Incredibly Close",
43 | "Cloud Atlas",
44 | "Captain Phillips",
45 | "Toy Story 4",
46 | "The Lost Symbol"
47 | };
48 |
49 | @Override
50 | protected void onCreate(Bundle savedInstanceState) {
51 | super.onCreate(savedInstanceState);
52 | setContentView(R.layout.activity_main);
53 |
54 | // initialize the empty view
55 | mEmptyLayout = new EmptyLayout(this, getListView());
56 | mEmptyLayout.setErrorButtonClickListener(mErrorClickListener);
57 |
58 | // populate the list view
59 | populateList();
60 | }
61 |
62 | // Triggered when "Empty" button is clicked
63 | public void onShowEmpty(View view) {
64 | // clear the list and show the empty layout
65 | mAdapter.clear();
66 | mEmptyLayout.showEmpty();
67 | }
68 |
69 | // Triggered when "Loading" button is clicked
70 | public void onShowLoading(View view) {
71 | // clear the list and show the loading layout
72 | mAdapter.clear();
73 | mEmptyLayout.showLoading();
74 | }
75 |
76 | // Triggered when "Error" button is clicked
77 | public void onShowError(View view) {
78 | // clear the list and show the error layout
79 | mAdapter.clear();
80 | mEmptyLayout.showError();
81 | }
82 |
83 | // Triggered when "List" button is clicked
84 | public void onShowList(View view) {
85 | // show the list
86 | populateList();
87 | }
88 |
89 | private void populateList() {
90 | ArrayList list = new ArrayList();
91 | list.addAll(Arrays.asList(MOVIES));
92 | mAdapter = new ArrayAdapter(this, android.R.layout.simple_list_item_1, list);
93 | setListAdapter(mAdapter);
94 | }
95 | }
96 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | Android Empty Layout
2 | ====================
3 |
4 | **Please note that this project is not being maintained now. Hopefully a new version will be available soon.**
5 |
6 | A library for showing different types of layouts when a list view is empty. These layouts can be shown when,
7 | * the list is loading
8 | * the list has no item to display
9 | * an error occured trying to load items
10 |
11 | Loading animation is also supported.
12 |
13 | Screenshots
14 | -----------
15 | 
16 | 
17 | 
18 | 
19 |
20 | Usage
21 | -----
22 | 1. Import the [library project](https://github.com/alamkanak/Android-Empty-Layout/tree/master/EmptyLayout) into your workspace.
23 | 2. Use the imported [project as a library](http://developer.android.com/tools/projects/projects-eclipse.html#ReferencingLibraryProject) for your project.
24 | 3. In the `onCreate` event of your activity use the following code.
25 |
26 | ```java
27 | mListAdapter.clear();
28 | EmptyLayout emptyLayout = new EmptyLayout(this, getListView());
29 | ```
30 | 4. When you want to show the loading animation, use this code.
31 |
32 | ```java
33 | mListAdapter.clear();
34 | emptyLayout.showLoading();
35 | ```
36 | 5. When you want to show any error, use this code.
37 |
38 | ```java
39 | mListAdapter.clear();
40 | emptyLayout.showError();
41 | ```
42 | 6. When your list doesn't have any item to show, use this code.
43 |
44 | ```java
45 | mListAdapter.clear();
46 | emptyLayout.showEmpty();
47 | ```
48 | Thats all you have to do to use this library. You may want to customize its behavior though.
49 |
50 | P.S. Make sure you always clear the list adapter before calling `showEmpty`, `showLoading` and `showError`. The list have to empty after all.
51 |
52 | Customization
53 | -------------
54 | There are bunch of methods to let you customize this pattern. Use the methods like this.
55 |
56 | ```java
57 | emptyLayout.setLoadingMessage("Please wait...");
58 | ```
59 |
60 | Some useful methods are given below
61 | * `showEmpty`
62 | * `showLoading`
63 | * `showError`
64 | * `setLoadingView`
65 | * `setEmptyView`
66 | * `setErrorView`
67 | * `setLoadingAnimation`
68 | * `setErrorMessage`
69 | * `setLoadingMessage`
70 | * `setEmptyMessage`
71 | * `setEmptyViewButtonClickListener`
72 | * `setLoadingViewButtonClickListener`
73 | * `setErrorViewButtonClickListener`
74 | * `setShowEmptyButton`
75 | * `setShowLoadingButton`
76 | * `setShowErrorButton`
77 |
78 | and there is more...
79 |
80 | Example
81 | -------
82 | A [simple example](https://github.com/alamkanak/Android-Empty-Layout/tree/master/EmptyLayoutSample) is also available.
83 |
84 | License
85 | ----------
86 |
87 | Copyright 2014 Raquib-ul-Alam
88 |
89 | Licensed under the Apache License, Version 2.0 (the "License");
90 | you may not use this file except in compliance with the License.
91 | You may obtain a copy of the License at
92 |
93 | http://www.apache.org/licenses/LICENSE-2.0
94 |
95 | Unless required by applicable law or agreed to in writing, software
96 | distributed under the License is distributed on an "AS IS" BASIS,
97 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
98 | See the License for the specific language governing permissions and
99 | limitations under the License.
100 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "{}"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright {yyyy} {name of copyright owner}
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/EmptyLayout/src/com/kanak/emptylayout/EmptyLayout.java:
--------------------------------------------------------------------------------
1 | package com.kanak.emptylayout;
2 |
3 | import com.kanak.emptylayout.R;
4 |
5 | import android.app.Activity;
6 | import android.content.Context;
7 | import android.view.LayoutInflater;
8 | import android.view.View;
9 | import android.view.ViewGroup;
10 | import android.view.animation.Animation;
11 | import android.view.animation.AnimationUtils;
12 | import android.view.animation.LinearInterpolator;
13 | import android.view.animation.RotateAnimation;
14 | import android.widget.ListView;
15 | import android.widget.RelativeLayout;
16 | import android.widget.RelativeLayout.LayoutParams;
17 | import android.widget.TextView;
18 |
19 | public class EmptyLayout {
20 |
21 | private Context mContext;
22 | private ViewGroup mLoadingView;
23 | private ViewGroup mEmptyView;
24 | private ViewGroup mErrorView;
25 | private Animation mLoadingAnimation;
26 | private ListView mListView;
27 | private int mErrorMessageViewId;
28 | private int mEmptyMessageViewId;
29 | private int mLoadingMessageViewId;
30 | private LayoutInflater mInflater;
31 | private boolean mViewsAdded;
32 | private int mLoadingAnimationViewId;
33 | private View.OnClickListener mLoadingButtonClickListener;
34 | private View.OnClickListener mEmptyButtonClickListener;
35 | private View.OnClickListener mErrorButtonClickListener;
36 |
37 | // ---------------------------
38 | // static variables
39 | // ---------------------------
40 | /**
41 | * The empty state
42 | */
43 | public final static int TYPE_EMPTY = 1;
44 | /**
45 | * The loading state
46 | */
47 | public final static int TYPE_LOADING = 2;
48 | /**
49 | * The error state
50 | */
51 | public final static int TYPE_ERROR = 3;
52 |
53 | // ---------------------------
54 | // default values
55 | // ---------------------------
56 | private int mEmptyType = TYPE_LOADING;
57 | private String mErrorMessage = "Oops! Something wrong happened";
58 | private String mEmptyMessage = "No items yet";
59 | private String mLoadingMessage = "Please wait";
60 | private int mLoadingViewButtonId = R.id.buttonLoading;
61 | private int mErrorViewButtonId = R.id.buttonError;
62 | private int mEmptyViewButtonId = R.id.buttonEmpty;
63 | private boolean mShowEmptyButton = true;
64 | private boolean mShowLoadingButton = true;
65 | private boolean mShowErrorButton = true;
66 |
67 | // ---------------------------
68 | // getters and setters
69 | // ---------------------------
70 | /**
71 | * Gets the loading layout
72 | * @return the loading layout
73 | */
74 | public ViewGroup getLoadingView() {
75 | return mLoadingView;
76 | }
77 |
78 | /**
79 | * Sets loading layout
80 | * @param loadingView the layout to be shown when the list is loading
81 | */
82 | public void setLoadingView(ViewGroup loadingView) {
83 | this.mLoadingView = loadingView;
84 | }
85 |
86 | /**
87 | * Sets loading layout resource
88 | * @param res the resource of the layout to be shown when the list is loading
89 | */
90 | public void setLoadingViewRes(int res){
91 | this.mLoadingView = (ViewGroup) mInflater.inflate(res, null);
92 | }
93 |
94 | /**
95 | * Gets the empty layout
96 | * @return the empty layout
97 | */
98 | public ViewGroup getEmptyView() {
99 | return mEmptyView;
100 | }
101 |
102 | /**
103 | * Sets empty layout
104 | * @param emptyView the layout to be shown when no items are available to load in the list
105 | */
106 | public void setEmptyView(ViewGroup emptyView) {
107 | this.mEmptyView = emptyView;
108 | }
109 |
110 | /**
111 | * Sets empty layout resource
112 | * @param res the resource of the layout to be shown when no items are available to load in the list
113 | */
114 | public void setEmptyViewRes(int res){
115 | this.mEmptyView = (ViewGroup) mInflater.inflate(res, null);
116 | }
117 |
118 | /**
119 | * Gets the error layout
120 | * @return the error layout
121 | */
122 | public ViewGroup getErrorView() {
123 | return mErrorView;
124 | }
125 |
126 | /**
127 | * Sets error layout
128 | * @param errorView the layout to be shown when list could not be loaded due to some error
129 | */
130 | public void setErrorView(ViewGroup errorView) {
131 | this.mErrorView = errorView;
132 | }
133 |
134 | /**
135 | * Sets error layout resource
136 | * @param res the resource of the layout to be shown when list could not be loaded due to some error
137 | */
138 | public void setErrorViewRes(int res){
139 | this.mErrorView = (ViewGroup) mInflater.inflate(res, null);
140 | }
141 |
142 | /**
143 | * Gets the loading animation
144 | * @return the loading animation
145 | */
146 | public Animation getLoadingAnimation() {
147 | return mLoadingAnimation;
148 | }
149 |
150 | /**
151 | * Sets the loading animation
152 | * @param animation the animation to play when the list is being loaded
153 | */
154 | public void setLoadingAnimation(Animation animation) {
155 | this.mLoadingAnimation = animation;
156 | }
157 |
158 | /**
159 | * Sets the resource of loading animation
160 | * @param animationResource the animation resource to play when the list is being loaded
161 | */
162 | public void setLoadingAnimationRes(int animationResource) {
163 | mLoadingAnimation = AnimationUtils.loadAnimation(mContext, animationResource);
164 | }
165 |
166 | /**
167 | * Gets the list view for which this library is being used
168 | * @return the list view
169 | */
170 | public ListView getListView() {
171 | return mListView;
172 | }
173 |
174 | /**
175 | * Sets the list view for which this library is being used
176 | * @param listView
177 | */
178 | public void setListView(ListView listView) {
179 | this.mListView = listView;
180 | }
181 |
182 | /**
183 | * Gets the last set state of the list view
184 | * @return loading or empty or error
185 | */
186 | public int getEmptyType() {
187 | return mEmptyType;
188 | }
189 |
190 | /**
191 | * Sets the state of the empty view of the list view
192 | * @param emptyType loading or empty or error
193 | */
194 | public void setEmptyType(int emptyType) {
195 | this.mEmptyType = emptyType;
196 | changeEmptyType();
197 | }
198 |
199 | /**
200 | * Gets the message which is shown when the list could not be loaded due to some error
201 | * @return the error message
202 | */
203 | public String getErrorMessage() {
204 | return mErrorMessage;
205 | }
206 |
207 | /**
208 | * Sets the message to be shown when the list could not be loaded due to some error
209 | * @param errorMessage the error message
210 | * @param messageViewId the id of the text view within the error layout whose text will be changed into this message
211 | */
212 | public void setErrorMessage(String errorMessage, int messageViewId) {
213 | this.mErrorMessage = errorMessage;
214 | this.mErrorMessageViewId = messageViewId;
215 | }
216 |
217 | /**
218 | * Sets the message to be shown when the list could not be loaded due to some error
219 | * @param errorMessage the error message
220 | */
221 | public void setErrorMessage(String errorMessage) {
222 | this.mErrorMessage = errorMessage;
223 | }
224 |
225 | /**
226 | * Gets the message which will be shown when the list will be empty for not having any item to display
227 | * @return the message which will be shown when the list will be empty for not having any item to display
228 | */
229 | public String getEmptyMessage() {
230 | return mEmptyMessage;
231 | }
232 |
233 | /**
234 | * Sets the message to be shown when the list will be empty for not having any item to display
235 | * @param emptyMessage the message
236 | * @param messageId the id of the text view within the empty layout whose text will be changed into this message
237 | */
238 | public void setEmptyMessage(String emptyMessage, int messageViewId) {
239 | this.mEmptyMessage = emptyMessage;
240 | this.mEmptyMessageViewId = messageViewId;
241 | }
242 |
243 | /**
244 | * Sets the message to be shown when the list will be empty for not having any item to display
245 | * @param emptyMessage the message
246 | */
247 | public void setEmptyMessage(String emptyMessage) {
248 | this.mEmptyMessage = emptyMessage;
249 | }
250 |
251 | /**
252 | * Gets the message which will be shown when the list is being loaded
253 | * @return
254 | */
255 | public String getLoadingMessage() {
256 | return mLoadingMessage;
257 | }
258 |
259 | /**
260 | * Sets the message to be shown when the list is being loaded
261 | * @param loadingMessage the message
262 | * @param messageViewId the id of the text view within the loading layout whose text will be changed into this message
263 | */
264 | public void setLoadingMessage(String loadingMessage, int messageViewId) {
265 | this.mLoadingMessage = loadingMessage;
266 | this.mLoadingMessageViewId = messageViewId;
267 | }
268 |
269 | /**
270 | * Sets the message to be shown when the list is being loaded
271 | * @param loadingMessage the message
272 | */
273 | public void setLoadingMessage(String loadingMessage) {
274 | this.mLoadingMessage = loadingMessage;
275 | }
276 |
277 | /**
278 | * Gets the view in the loading layout which will be animated when the list is being loaded
279 | * @return the view in the loading layout which will be animated when the list is being loaded
280 | */
281 | public int getLoadingAnimationViewId() {
282 | return mLoadingAnimationViewId;
283 | }
284 |
285 | /**
286 | * Sets the view in the loading layout which will be animated when the list is being loaded
287 | * @param loadingAnimationViewId the id of the view
288 | */
289 | public void setLoadingAnimationViewId(int loadingAnimationViewId) {
290 | this.mLoadingAnimationViewId = loadingAnimationViewId;
291 | }
292 |
293 | /**
294 | * Gets the OnClickListener which perform when LoadingView was click
295 | * @return
296 | */
297 | public View.OnClickListener getLoadingButtonClickListener() {
298 | return mLoadingButtonClickListener;
299 | }
300 |
301 | /**
302 | * Sets the OnClickListener to LoadingView
303 | * @param loadingButtonClickListener OnClickListener Object
304 | */
305 | public void setLoadingButtonClickListener(View.OnClickListener loadingButtonClickListener) {
306 | this.mLoadingButtonClickListener = loadingButtonClickListener;
307 | }
308 |
309 | /**
310 | * Gets the OnClickListener which perform when EmptyView was click
311 | * @return
312 | */
313 | public View.OnClickListener getEmptyButtonClickListener() {
314 | return mEmptyButtonClickListener;
315 | }
316 |
317 | /**
318 | * Sets the OnClickListener to EmptyView
319 | * @param emptyButtonClickListener OnClickListener Object
320 | */
321 | public void setEmptyButtonClickListener(View.OnClickListener emptyButtonClickListener) {
322 | this.mEmptyButtonClickListener = emptyButtonClickListener;
323 | }
324 |
325 | /**
326 | * Gets the OnClickListener which perform when ErrorView was click
327 | * @return
328 | */
329 | public View.OnClickListener getErrorButtonClickListener() {
330 | return mErrorButtonClickListener;
331 | }
332 |
333 | /**
334 | * Sets the OnClickListener to ErrorView
335 | * @param errorButtonClickListener OnClickListener Object
336 | */
337 | public void setErrorButtonClickListener(View.OnClickListener errorButtonClickListener) {
338 | this.mErrorButtonClickListener = errorButtonClickListener;
339 | }
340 |
341 | /**
342 | * Gets if a button is shown in the empty view
343 | * @return if a button is shown in the empty view
344 | */
345 | public boolean isEmptyButtonShown() {
346 | return mShowEmptyButton;
347 | }
348 |
349 | /**
350 | * Sets if a button will be shown in the empty view
351 | * @param showEmptyButton will a button be shown in the empty view
352 | */
353 | public void setShowEmptyButton(boolean showEmptyButton) {
354 | this.mShowEmptyButton = showEmptyButton;
355 | }
356 |
357 | /**
358 | * Gets if a button is shown in the loading view
359 | * @return if a button is shown in the loading view
360 | */
361 | public boolean isLoadingButtonShown() {
362 | return mShowLoadingButton;
363 | }
364 |
365 | /**
366 | * Sets if a button will be shown in the loading view
367 | * @param showEmptyButton will a button be shown in the loading view
368 | */
369 | public void setShowLoadingButton(boolean showLoadingButton) {
370 | this.mShowLoadingButton = showLoadingButton;
371 | }
372 |
373 | /**
374 | * Gets if a button is shown in the error view
375 | * @return if a button is shown in the error view
376 | */
377 | public boolean isErrorButtonShown() {
378 | return mShowErrorButton;
379 | }
380 |
381 | /**
382 | * Sets if a button will be shown in the error view
383 | * @param showEmptyButton will a button be shown in the error view
384 | */
385 | public void setShowErrorButton(boolean showErrorButton) {
386 | this.mShowErrorButton = showErrorButton;
387 | }
388 |
389 | /**
390 | * Gets the ID of the button in the loading view
391 | * @return the ID of the button in the loading view
392 | */
393 | public int getmLoadingViewButtonId() {
394 | return mLoadingViewButtonId;
395 | }
396 |
397 | /**
398 | * Sets the ID of the button in the loading view. This ID is required if you want the button the loading view to be click-able.
399 | * @param loadingViewButtonId the ID of the button in the loading view
400 | */
401 | public void setLoadingViewButtonId(int loadingViewButtonId) {
402 | this.mLoadingViewButtonId = loadingViewButtonId;
403 | }
404 |
405 | /**
406 | * Gets the ID of the button in the error view
407 | * @return the ID of the button in the error view
408 | */
409 | public int getErrorViewButtonId() {
410 | return mErrorViewButtonId;
411 | }
412 |
413 | /**
414 | * Sets the ID of the button in the error view. This ID is required if you want the button the error view to be click-able.
415 | * @param errorViewButtonId the ID of the button in the error view
416 | */
417 | public void setErrorViewButtonId(int errorViewButtonId) {
418 | this.mErrorViewButtonId = errorViewButtonId;
419 | }
420 |
421 | /**
422 | * Gets the ID of the button in the empty view
423 | * @return the ID of the button in the empty view
424 | */
425 | public int getEmptyViewButtonId() {
426 | return mEmptyViewButtonId;
427 | }
428 |
429 | /**
430 | * Sets the ID of the button in the empty view. This ID is required if you want the button the empty view to be click-able.
431 | * @param emptyViewButtonId the ID of the button in the empty view
432 | */
433 | public void setEmptyViewButtonId(int emptyViewButtonId) {
434 | this.mEmptyViewButtonId = emptyViewButtonId;
435 | }
436 |
437 |
438 |
439 |
440 |
441 |
442 | // ---------------------------
443 | // private methods
444 | // ---------------------------
445 |
446 | private void changeEmptyType() {
447 |
448 | setDefaultValues();
449 | refreshMessages();
450 |
451 | // insert views in the root view
452 | if (!mViewsAdded) {
453 | RelativeLayout.LayoutParams lp = new LayoutParams(LayoutParams.WRAP_CONTENT, LayoutParams.WRAP_CONTENT);
454 | lp.addRule(RelativeLayout.CENTER_HORIZONTAL);
455 | lp.addRule(RelativeLayout.CENTER_VERTICAL);
456 | RelativeLayout rl = new RelativeLayout(mContext);
457 | rl.setLayoutParams(lp);
458 | if (mEmptyView!=null) rl.addView(mEmptyView);
459 | if (mLoadingView!=null) rl.addView(mLoadingView);
460 | if (mErrorView!=null) rl.addView(mErrorView);
461 | mViewsAdded = true;
462 |
463 | ViewGroup parent = (ViewGroup) mListView.getParent();
464 | parent.addView(rl);
465 | mListView.setEmptyView(rl);
466 | }
467 |
468 |
469 | // change empty type
470 | if (mListView!=null) {
471 | View loadingAnimationView = null;
472 | if (mLoadingAnimationViewId > 0) loadingAnimationView = ((Activity) mContext).findViewById(mLoadingAnimationViewId);
473 | switch (mEmptyType) {
474 | case TYPE_EMPTY:
475 | if (mEmptyView!=null) mEmptyView.setVisibility(View.VISIBLE);
476 | if (mErrorView!=null) mErrorView.setVisibility(View.GONE);
477 | if (mLoadingView!=null) {
478 | mLoadingView.setVisibility(View.GONE);
479 | if (loadingAnimationView!=null && loadingAnimationView.getAnimation()!=null) loadingAnimationView.getAnimation().cancel();
480 | }
481 | break;
482 | case TYPE_ERROR:
483 | if (mEmptyView!=null) mEmptyView.setVisibility(View.GONE);
484 | if (mErrorView!=null) mErrorView.setVisibility(View.VISIBLE);
485 | if (mLoadingView!=null) {
486 | mLoadingView.setVisibility(View.GONE);
487 | if (loadingAnimationView!=null && loadingAnimationView.getAnimation()!=null) loadingAnimationView.getAnimation().cancel();
488 | }
489 | break;
490 | case TYPE_LOADING:
491 | if (mEmptyView!=null) mEmptyView.setVisibility(View.GONE);
492 | if (mErrorView!=null) mErrorView.setVisibility(View.GONE);
493 | if (mLoadingView!=null) {
494 | mLoadingView.setVisibility(View.VISIBLE);
495 | if (mLoadingAnimation != null && loadingAnimationView!=null) {
496 | loadingAnimationView.startAnimation(mLoadingAnimation);
497 | }
498 | else if (loadingAnimationView!=null) {
499 | loadingAnimationView.startAnimation(getRotateAnimation());
500 | }
501 | }
502 | break;
503 | default:
504 | break;
505 | }
506 | }
507 | }
508 |
509 | private void refreshMessages() {
510 | if (mEmptyMessageViewId>0 && mEmptyMessage!=null) ((TextView)mEmptyView.findViewById(mEmptyMessageViewId)).setText(mEmptyMessage);
511 | if (mLoadingMessageViewId>0 && mLoadingMessage!=null) ((TextView)mLoadingView.findViewById(mLoadingMessageViewId)).setText(mLoadingMessage);
512 | if (mErrorMessageViewId>0 && mErrorMessage!=null) ((TextView)mErrorView.findViewById(mErrorMessageViewId)).setText(mErrorMessage);
513 | }
514 |
515 | private void setDefaultValues() {
516 | if (mEmptyView==null) {
517 | mEmptyView = (ViewGroup) mInflater.inflate(R.layout.view_empty, null);
518 | if (!(mEmptyMessageViewId>0)) mEmptyMessageViewId = R.id.textViewMessage;
519 | if (mShowEmptyButton && mEmptyViewButtonId>0 && mEmptyButtonClickListener!=null) {
520 | View emptyViewButton = mEmptyView.findViewById(mEmptyViewButtonId);
521 | if (emptyViewButton != null) {
522 | emptyViewButton.setOnClickListener(mEmptyButtonClickListener);
523 | emptyViewButton.setVisibility(View.VISIBLE);
524 | }
525 | }
526 | else if (mEmptyViewButtonId>0) {
527 | View emptyViewButton = mEmptyView.findViewById(mEmptyViewButtonId);
528 | emptyViewButton.setVisibility(View.GONE);
529 | }
530 | }
531 | if (mLoadingView==null) {
532 | mLoadingView = (ViewGroup) mInflater.inflate(R.layout.view_loading, null);
533 | mLoadingAnimationViewId = R.id.imageViewLoading;
534 | if (!(mLoadingMessageViewId>0)) mLoadingMessageViewId = R.id.textViewMessage;
535 | if (mShowLoadingButton && mLoadingViewButtonId>0 && mLoadingButtonClickListener!=null) {
536 | View loadingViewButton = mLoadingView.findViewById(mLoadingViewButtonId);
537 | if (loadingViewButton != null) {
538 | loadingViewButton.setOnClickListener(mLoadingButtonClickListener);
539 | loadingViewButton.setVisibility(View.VISIBLE);
540 | }
541 | }
542 | else if (mLoadingViewButtonId>0) {
543 | View loadingViewButton = mLoadingView.findViewById(mLoadingViewButtonId);
544 | loadingViewButton.setVisibility(View.GONE);
545 | }
546 | }
547 | if (mErrorView==null) {
548 | mErrorView = (ViewGroup) mInflater.inflate(R.layout.view_error, null);
549 | if (!(mErrorMessageViewId>0)) mErrorMessageViewId = R.id.textViewMessage;
550 | if (mShowErrorButton && mErrorViewButtonId>0 && mErrorButtonClickListener!=null) {
551 | View errorViewButton = mErrorView.findViewById(mErrorViewButtonId);
552 | if (errorViewButton != null) {
553 | errorViewButton.setOnClickListener(mErrorButtonClickListener);
554 | errorViewButton.setVisibility(View.VISIBLE);
555 | }
556 | }
557 | else if (mErrorViewButtonId>0) {
558 | View errorViewButton = mErrorView.findViewById(mErrorViewButtonId);
559 | errorViewButton.setVisibility(View.GONE);
560 | }
561 | }
562 | }
563 |
564 | private static Animation getRotateAnimation() {
565 | final RotateAnimation rotateAnimation = new RotateAnimation(0, 360, Animation.RELATIVE_TO_SELF, .5f, Animation.RELATIVE_TO_SELF, .5f);
566 | rotateAnimation.setDuration(1500);
567 | rotateAnimation.setInterpolator(new LinearInterpolator());
568 | rotateAnimation.setRepeatCount(Animation.INFINITE);
569 | return rotateAnimation;
570 | }
571 |
572 |
573 | // ---------------------------
574 | // public methods
575 | // ---------------------------
576 |
577 | /**
578 | * Constructor
579 | * @param context the context (preferred context is any activity)
580 | */
581 | public EmptyLayout(Context context) {
582 | mContext = context;
583 | mInflater = (LayoutInflater) mContext.getSystemService(Context.LAYOUT_INFLATER_SERVICE);
584 | }
585 |
586 | /**
587 | * Constructor
588 | * @param context the context (preferred context is any activity)
589 | * @param listView the list view for which this library is being used
590 | */
591 | public EmptyLayout(Context context, ListView listView) {
592 | mContext = context;
593 | mInflater = (LayoutInflater) mContext.getSystemService(Context.LAYOUT_INFLATER_SERVICE);
594 | mListView = listView;
595 | }
596 |
597 |
598 | /**
599 | * Shows the empty layout if the list is empty
600 | */
601 | public void showEmpty() {
602 | this.mEmptyType = TYPE_EMPTY;
603 | changeEmptyType();
604 | }
605 |
606 | /**
607 | * Shows loading layout if the list is empty
608 | */
609 | public void showLoading() {
610 | this.mEmptyType = TYPE_LOADING;
611 | changeEmptyType();
612 | }
613 |
614 | /**
615 | * Shows error layout if the list is empty
616 | */
617 | public void showError() {
618 | this.mEmptyType = TYPE_ERROR;
619 | changeEmptyType();
620 | }
621 |
622 |
623 | }
624 |
--------------------------------------------------------------------------------