Friday, June 8, 2012

How can I make a horizontal ListView in Android?


Like many things in Android, you wouldn't think this would be such a hard problem but ohhh, by golly, would you be wrong. And, like many things in Android, the API doesn't even provide a reasonably extensible starting point. I'll be damned if I'm going to roll my own ListView, when all I want is to take the thing and turn it on its side. \rant



Okay, now that I'm done fuming, let's talk about the problem itself. What I need is basically something exactly like the Gallery , but without the center-locking feature. I don't really need ListView 's listSelector but it's a nice-to-have. Mostly, I could do what I want with a LinearLayout inside a ScrollView , but I need the child views to come from a ListAdapter and I would really like to have a view recycler. And I really don't want to write any layout code.



I peeked into the source code for some of these classes...



Gallery: It looks like I could use the Gallery if I override most of the 'onXyz' methods, copy all their source code, but refrain from calling scrollIntoSlots() . But I'm sure that if I do that I'll run into some member field that's inaccessible or some other unforeseen consequence.



AbsSpinner: Since the mRecycler field is package-private I doubt I'll be able to extend this class.



AbsListView: It looks like this class is only meant for vertical scrolling, so no help there.



AdapterView: I've never had to extend this class directly. If you tell me it's easy to do, and that it's easy to roll my own RecycleBin , I'll be very skeptical but I'll give it a shot.



I suppose I could possibly copy both AbsSpinner and Gallery to get what I want... hopefully those classes aren't using some package-private variable I can't access. Do y'all think that's a good practice? Does anyone have any tutorials or third-party solutions that might put me in the right direction?



Update:

The only solution I've found so far is to do it all myself. Since asking this question, I have overridden AdapterView and implemented my own "HorizontalListView" from scratch. The only way to truly override the Gallery's center-locking feature is to override the private scrollIntoSlots method, which I believe would require generating a subclass at runtime. If you're bold enough to do that, it's arguably the best solution, but I don't want to rely on undocumented methods that could change.



Swathi EP below suggested that I give the Gallery an OnTouchListener and override the scroll functionality. If you don't care about having fling support in your list, or if it's okay for the views to snap to the center at the end of the fling animation, then this will work for you! However, in the end it still proves impossible to remove the center-locking feature without removing fling support. And I ask you, what kind of list doesn't fling?



So, alas, this did not work for me. :-( But if you're interested in this approach, read on...



I also had to make some additions to Swathi's code to get what I wanted. In GestureListener.onTouch , in addition to delegating to the gesture detector, I also had to return true for ACTION_UP and ACTION_CANCEL events. That successfully disabled the center-locking feature, but it also disabled flinging. I was able to re-enable fling by having my own GestureListener delegate to the Gallery's onFling method. If you want to try it out, go into your ApiDemos sample code and replace the Gallery1.java class with the following code:




import com.example.android.apis.R;

import android.app.Activity;
import android.content.Context;
import android.content.res.TypedArray;
import android.os.Bundle;
import android.view.ContextMenu;
import android.view.GestureDetector;
import android.view.MenuItem;
import android.view.MotionEvent;
import android.view.View;
import android.view.ViewGroup;
import android.view.ContextMenu.ContextMenuInfo;
import android.view.GestureDetector.SimpleOnGestureListener;
import android.view.View.OnTouchListener;
import android.widget.AdapterView;
import android.widget.BaseAdapter;
import android.widget.Gallery;
import android.widget.ImageView;
import android.widget.Toast;
import android.widget.AdapterView.AdapterContextMenuInfo;
import android.widget.AdapterView.OnItemClickListener;

public class Gallery1 extends Activity {

@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.gallery_1);

// Reference the Gallery view
final Gallery g = (Gallery) findViewById(R.id.gallery);

// Set the adapter to our custom adapter (below)
g.setAdapter(new ImageAdapter(this));

// Set a item click listener, and just Toast the clicked position
g.setOnItemClickListener(new OnItemClickListener() {
public void onItemClick(AdapterView parent, View v, int position, long id) {
Toast.makeText(Gallery1.this, "" + position, Toast.LENGTH_SHORT).show();
}
});

// Gesture detection
final GestureDetector gestureDetector = new GestureDetector(new MyGestureDetector(g));
OnTouchListener gestureListener = new OnTouchListener() {
@Override
public boolean onTouch(View v, MotionEvent event) {
boolean retVal = gestureDetector.onTouchEvent(event);
int action = event.getAction();
if (action == MotionEvent.ACTION_UP || action == MotionEvent.ACTION_CANCEL) {
retVal = true;
onUp();
}
return retVal;
}

public void onUp() {
// Here I am merely copying the Gallery's onUp() method.
for (int i = g.getChildCount() - 1; i >= 0; i--) {
g.getChildAt(i).setPressed(false);
}
g.setPressed(false);
}
};
g.setOnTouchListener(gestureListener);

// We also want to show context menu for longpressed items in the gallery
registerForContextMenu(g);
}

@Override
public void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo) {
menu.add(R.string.gallery_2_text);
}

@Override
public boolean onContextItemSelected(MenuItem item) {
AdapterContextMenuInfo info = (AdapterContextMenuInfo) item.getMenuInfo();
Toast.makeText(this, "Longpress: " + info.position, Toast.LENGTH_SHORT).show();
return true;
}

public class ImageAdapter extends BaseAdapter {
int mGalleryItemBackground;

public ImageAdapter(Context c) {
mContext = c;
// See res/values/attrs.xml for the <declare-styleable> that defines
// Gallery1.
TypedArray a = obtainStyledAttributes(R.styleable.Gallery1);
mGalleryItemBackground = a.getResourceId(
R.styleable.Gallery1_android_galleryItemBackground, 0);
a.recycle();
}

public int getCount() {
return mImageIds.length;
}

public Object getItem(int position) {
return position;
}

public long getItemId(int position) {
return position;
}

public View getView(int position, View convertView, ViewGroup parent) {
ImageView i = new ImageView(mContext);

i.setImageResource(mImageIds[position]);
i.setScaleType(ImageView.ScaleType.FIT_XY);
i.setLayoutParams(new Gallery.LayoutParams(136, 88));

// The preferred Gallery item background
i.setBackgroundResource(mGalleryItemBackground);

return i;
}

private Context mContext;

private Integer[] mImageIds = {
R.drawable.gallery_photo_1,
R.drawable.gallery_photo_2,
R.drawable.gallery_photo_3,
R.drawable.gallery_photo_4,
R.drawable.gallery_photo_5,
R.drawable.gallery_photo_6,
R.drawable.gallery_photo_7,
R.drawable.gallery_photo_8
};
}

public class MyGestureDetector extends SimpleOnGestureListener {

private Gallery gallery;

public MyGestureDetector(Gallery gallery) {
this.gallery = gallery;
}

@Override
public boolean onFling(MotionEvent e1, MotionEvent e2, float velocityX,
float velocityY) {
return gallery.onFling(e1, e2, velocityX, velocityY);
}
}

}


Source: Tips4all

8 comments:

  1. After reading this post, I have implemented my own Horizontal listview. You can find it: http://www.dev-smart.com/?p=34 Let me know if this helps...

    ReplyDelete
  2. Have you looked into using a HorizontalScrollView to wrap your list items? That will allow each of your list items to be horizontally scrollable (what you put in there is up to you, and can make them dynamic items similar to ListView). This will work well if you are only after a single row of items.

    ReplyDelete
  3. You know, it might be possible to use an existing ListView with some judicious overriding of dispatchDraw() (to rotate the Canvas by 90 degrees), onTouch() (to swap the X and Y of the MotionEvent coords) and maybe onMeasure() or whatever to fool it into thinking it's y by x rather than x by y...

    I have no idea if this would actually work but it'd be fun to find out. :)

    ReplyDelete
  4. I used Pauls (see his answer) Implementation of HorizontalListview and it works, thank you so much for sharing!

    I slightly changed his HorizontalListView-Class (btw. Paul there is a typo in your classname, your classname is "HorizontialListView" instead of "HorizontalListView", the "i" is too much) to update child-views when selected.

    UPDATE: My code that I posted here was wrong I suppose, as I ran into trouble with selection (i think it has to do with view recycling), I have to go back to the drawing board...

    UPDATE 2: Ok Problem solved, I simply commented "removeNonVisibleItems(dx);" in "onLayout(..)", I guess this will hurt performance, but since I am using only very small Lists this is no Problem for me.

    I basically used this tutorial here on developerlife and just replaced ListView with Pauls HorizontalListView, and made the changes to allow for "permanent" selection (a child that is clicked on changes its appearance, and when its clicked on again it changes it back).

    I am a beginner, so probably many ugly things in the code, let me know if you need more details.

    ReplyDelete
  5. This might be a very late reply but it is working for us. We are using the same gallery provided by Android, just that, we have adjusted the left margin such a way that the screens left end is considered as Gallery's center. That really worked well for us.

    ReplyDelete
  6. Gallery is the best solution, i have tried it. I was working on one mail app, in which mails in the inbox where displayed as listview, i wanted an horizontal view, i just converted listview to gallery and everything worked fine as i needed without any errors. For the scroll effect i enabled gesture listener for the gallery. I hope this answer may help u.

    ReplyDelete
  7. My app uses a ListView in portraint mode which is simply switches to Gallery in landscape mode. Both of them use one BaseAdapter. This looks like shown below.

    setContentView(R.layout.somelayout);
    orientation = getResources().getConfiguration().orientation;

    if ( orientation == Configuration.ORIENTATION_LANDSCAPE )
    {

    Gallery gallery = (Gallery)findViewById( R.id.somegallery );

    gallery.setAdapter( someAdapter );

    gallery.setOnItemClickListener( new OnItemClickListener() {
    @Override
    public void onItemClick( AdapterView<?> parent, View view,
    int position, long id ) {

    onClick( position );
    }
    });
    }
    else
    {
    setListAdapter( someAdapter );

    getListView().setOnScrollListener(this);
    }


    To handle scrolling events I've inherited my own widget from Gallery and override onFling().
    Here's the layout.xml:

    <view
    class="package$somegallery"
    android:id="@+id/somegallery"
    android:layout_height="fill_parent"
    android:layout_width="fill_parent">
    </view>


    and code:

    public static class somegallery extends Gallery
    {
    private Context mCtx;

    public somegallery(Context context, AttributeSet attrs)
    {
    super(context, attrs);
    mCtx = context;
    }

    @Override
    public boolean onFling(MotionEvent e1, MotionEvent e2, float velocityX,
    float velocityY) {

    ( (CurrentActivity)mCtx ).onScroll();

    return super.onFling(e1, e2, velocityX, velocityY);
    }
    }

    ReplyDelete
  8. Have you looked into the ViewFlipper component? Maybe it can help you.

    http://developer.android.com/reference/android/widget/ViewFlipper.html

    With this component, you can attach two or more view childs. If you add some translate animation and capture Gesture detection, you can have a nicely horizontal scroll.

    ReplyDelete