Ported and Maintained by: James Montemagno (@JamesMontemagno)
Original StickyListHeaders by: (Emil Sjölander on GitHub)
StickyListHeaders is an Android library that makes it easy to integrate section headers in your ListView. These section headers stick to the top like in the new People app of Android 4.0 Ice Cream Sandwich. This behavior is also found in lists with sections on iOS devices. This library can also be used for without the sticky functionality if you just want section headers.
StickyListHeaders actively supports android versions 2.3 (gingerbread) and above It should be compatible with much older versions of android as well but these are not actively tested.
###Installing the library Install from Component Store or Clone and add project or dll to your solution.
###Code Adding a StickyListHeadersList view is as easy as adding this code into your axml layout
<?xml version="1.0" encoding="utf-8"?>
<com.refractored.components.stickylistheaders.StickyListHeadersListView
android:id="@+id/list"
android:layout_width="match_parent"
android:layout_height="match_parent"/>Now in your activities onCreate() or your fragments onCreateView() you would want to do something like this
var stickyList = FindViewById<StickyListHeadersListView>(R.id.list);
var adapter = new MyAdapter(this);
stickyList.Adapter = adapter;
MyAdapter in the above example would look something like this if your list was a list of countries where each header was for a letter in the alphabet.
public class HeaderViewHolder : Java.Lang.Object
{
public TextView Text1 { get; set; }
}
public class ViewHolder : Java.Lang.Object
{
public TextView Text { get; set; }
}
public class MyAdapter : BaseAdapter, IStickyListHeadersAdapter, ISectionIndexer
{
private string[] m_Countries;
private LayoutInflater m_Inflater;
private Context m_Context;
public TestBaseAdapter(Context context)
{
m_Context = context;
m_Inflater = LayoutInflater.From(context);
m_Countries = context.Resources.GetStringArray(Resource.Array.countries);
}
public override int Count
{
get { return m_Countries.Length; }
}
public override Java.Lang.Object GetItem(int position)
{
return m_Countries[position];
}
public override long GetItemId(int position)
{
return position;//unique
}
public override View GetView(int position, View convertView, ViewGroup parent)
{
ViewHolder holder = null;
if (convertView == null)
{
holder = new ViewHolder();
convertView = m_Inflater.Inflate(Resource.Layout.test_list_item_layout, parent, false);
holder.Text = convertView.FindViewById<TextView>(Resource.Id.text);
convertView.Tag = holder;
}
else
{
holder = convertView.Tag as ViewHolder;
}
holder.Text.Text = m_Countries[position];
return convertView;
}
public View GetHeaderView(int position, View convertView, ViewGroup parent)
{
HeaderViewHolder holder = null;
if (convertView == null)
{
holder = new HeaderViewHolder();
convertView = m_Inflater.Inflate(Resource.Layout.header, parent, false);
holder.Text1 = convertView.FindViewById<TextView>(Resource.Id.text1);
convertView.Tag = holder;
}
else
{
holder = convertView.Tag as HeaderViewHolder;
}
var headerChar = m_Countries[position].Substring(0, 1)[0];
string headerText = headerChar.ToString();
holder.Text1.Text = headerText;
return convertView;
}
public long GetHeaderId(int position)
{
return m_Countries[position].Substring(0, 1)[0];
}
}
}
Thats it! look through the api docs below to get know about things to customize and if you have any problems getting started please open an issue as it probably means the getting started guide need some improvement!
###IStickyListHeadersAdapter
public interface IStickyListHeadersAdapter : IListAdapter
{
View GetHeaderView(int position, View convertView, ViewGroup parent);
long GetHeaderId(int position);
}
Your adapter must implement this interface to function with IStickyListHeadersListView.
GetHeaderId() must return a unique integer for every section. A valid implementation for a list with alphabetical sections is the return the char value of the section that position is a part of.
GetHeaderView() works exactly like GetView() in a regular ListAdapter.
###StickyListHeadersListView Headers are sticky by default but that can easily be changed with this setter. There is of course also a matching getter for the sticky property.
public bool AreHeadersSticky{get;set;}
A IOnHeaderClickListener is the header version of IOnItemClickListener. This is the setter for it and the interface of the listener. The currentlySticky boolean flag indicated if the header that was clicked was sticking to the top at the time it was clicked.
public IOnHeaderListClickListener {get;set;}
public interface OnHeaderListClickListener
{
public void OnHeaderClick(StickyListHeadersListView l, View header, int itemPosition, long headerId, boolean currentlySticky);
}
StickyListHeaders wraps the adapter passed to Adapter{set;} is it's own adapter, so Adapter{get;} will not return the adapter that Adapter{set;} was passed. It is often recomended that you keep a reference to the adapter in your activity/fragment but if this does not fit you there is a method to retrieve the original adapter.
public IStickyListHeadersAdapter WrappedAdapter{get;}
This is a setter and getter for an internal attribute that controlls if the list should be drawn under the stuck header. The default value is false. If you want to see the list scroll under your header(the header should have a semi-transparent background) you will want to set this attribute to true.
public bool IsDrawingListUnderStickyHeader {get;set;}
There is currently two limitations with this library, they both have to do with what kind of views the header can contain and the both only apply for when sticky header are activated.
The first limitation is that the header can as of now not contain anything that animates, the list will not crash but the animation will just not run as expected while the header is stuck. The other limitation is that it is currently not possible to have interactive elements in the header, Buttons, switches, etc. will only work when the header is not stuck.
Contributions are very welcome and I will contstantly bring in new features from Emil Sjölander Branch. So if you find a big in the library or want a feature and think you can fix it yourself, fork + pull request and i will greatly appreciate it!
Copyright 2013 Emil Sjölander
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.
Copyright 2013 James Montemagno
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.