Added ViewHolders for simple click/longClick and menu functionalities

Author: brianwernick

README.md

@@ -23,7 +23,7 @@ The latest AAR (Android Archive) files can be downloaded from JCenter [RecyclerE
 Or included in your gradle dependencies
 
 ```groovy
-compile 'com.devbrackets.android:recyclerext:0.12.2'
+compile 'com.devbrackets.android:recyclerext:0.12.3'
 ```
 
 

library/build.gradle

@@ -4,7 +4,7 @@ apply plugin: 'bintray-release'
 
 def versionMajor = 0
 def versionMinor = 12
-def versionPatch = 2
+def versionPatch = 3
 
 // Maven GAV
 def libraryGroupId = 'com.devbrackets.android'

library/src/main/java/com/devbrackets/android/recyclerext/adapter/viewholder/ClickableViewHolder.java

@@ -0,0 +1,82 @@
+package com.devbrackets.android.recyclerext.adapter.viewholder;
+
+import android.support.annotation.Nullable;
+import android.support.v7.widget.RecyclerView;
+import android.view.HapticFeedbackConstants;
+import android.view.View;
+
+/**
+ * A Simple ViewHolder that adds the ability to specify
+ * listeners that have access to the ViewHolder instead
+ * of a position when clicked
+ */
+public abstract class ClickableViewHolder extends RecyclerView.ViewHolder implements View.OnClickListener, View.OnLongClickListener {
+
+    public interface OnClickListener {
+        void onClick(ClickableViewHolder viewHolder);
+    }
+
+    public interface OnLongClickListener {
+        boolean onLongClick(ClickableViewHolder viewHolder);
+    }
+
+    @Nullable
+    private OnClickListener onClickListener;
+    @Nullable
+    private OnLongClickListener onLongClickListener;
+
+    protected boolean performLongClickHapticFeedback = true;
+
+    public ClickableViewHolder(View itemView) {
+        super(itemView);
+        initializeClickListener();
+    }
+
+    /**
+     * Sets the click and long click listeners on the root
+     * view (see {@link #itemView})
+     */
+    protected void initializeClickListener() {
+        itemView.setOnClickListener(this);
+        itemView.setOnLongClickListener(this);
+    }
+
+    /**
+     * Enables or Disables haptic feedback on long clicks.  If a
+     * long click listener has not been set with {@link #setOnLongClickListener(OnLongClickListener)}
+     * then no haptic feedback will be performed.
+     *
+     * @param enabled True if the long click should perform a haptic feedback [default: true]
+     */
+    public void setHapticFeedbackEnabled(boolean enabled) {
+        performLongClickHapticFeedback = enabled;
+    }
+
+    public void setOnClickListener(@Nullable OnClickListener onClickListener) {
+        this.onClickListener = onClickListener;
+    }
+
+    public void setOnLongClickListener(@Nullable OnLongClickListener onLongClickListener) {
+        this.onLongClickListener = onLongClickListener;
+    }
+
+    @Override
+    public void onClick(View view) {
+        if (onClickListener != null) {
+            onClickListener.onClick(this);
+        }
+    }
+
+    @Override
+    public boolean onLongClick(View v) {
+        if (onLongClickListener != null) {
+            if (performLongClickHapticFeedback) {
+                itemView.performHapticFeedback(HapticFeedbackConstants.LONG_PRESS);
+            }
+
+            return onLongClickListener.onLongClick(this);
+        }
+
+        return false;
+    }
+}

library/src/main/java/com/devbrackets/android/recyclerext/adapter/viewholder/MenuViewHolder.java

@@ -0,0 +1,104 @@
+package com.devbrackets.android.recyclerext.adapter.viewholder;
+
+import android.support.annotation.IdRes;
+import android.support.annotation.MenuRes;
+import android.support.annotation.Nullable;
+import android.support.v7.widget.PopupMenu;
+import android.view.Menu;
+import android.view.MenuInflater;
+import android.view.MenuItem;
+import android.view.View;
+
+/**
+ * A simple ViewHolder that extends {@link ClickableViewHolder} to provide the
+ * functionality for providing and registering for popup menu selection events
+ */
+public abstract class MenuViewHolder extends ClickableViewHolder implements PopupMenu.OnMenuItemClickListener {
+
+    public interface OnMenuItemSelectedListener {
+        boolean onMenuItemSelected(MenuViewHolder viewHolder, MenuItem menuItem);
+    }
+
+    @Nullable
+    private OnMenuItemSelectedListener onMenuItemSelectedListener;
+
+    /**
+     * Retrieves the id for the view that will be used to show the
+     * popup menu when clicked.
+     *
+     * @return The resource id for the menu view
+     */
+    @IdRes
+    protected abstract int getMenuViewId();
+
+    /**
+     * Retrieves the id for the xml menu resource that specifies
+     * the options for the popup menu.
+     *
+     * @return The resource id for the xml menu
+     */
+    @MenuRes
+    protected abstract int getMenuResourceId();
+
+    public MenuViewHolder(View itemView) {
+        super(itemView);
+        initializeMenuClickListener();
+    }
+
+    public void setOnMenuItemSelectedListener(@Nullable OnMenuItemSelectedListener listener) {
+        this.onMenuItemSelectedListener = listener;
+    }
+
+    @Override
+    public boolean onMenuItemClick(MenuItem item) {
+        return onMenuItemSelectedListener != null && onMenuItemSelectedListener.onMenuItemSelected(this, item);
+    }
+
+    /**
+     * Registers the view specified with {@link #getMenuViewId()} to
+     * show the popup menu specified with {@link #getMenuResourceId()}
+     */
+    protected void initializeMenuClickListener() {
+        View menuView = itemView.findViewById(getMenuViewId());
+        if (menuView != null) {
+            menuView.setOnClickListener(new MenuClickListener());
+        }
+    }
+
+    /**
+     * Shows the menu specified with the <code>menuResourceId</code> starting
+     * at the <code>anchor</code>
+     *
+     * @param anchor The view to show the popup menu from
+     * @param menuResourceId The resource id for the menu to show
+     */
+    protected void showMenu(View anchor, @MenuRes int menuResourceId) {
+        PopupMenu menu = new PopupMenu(anchor.getContext(), anchor);
+        MenuInflater inflater = menu.getMenuInflater();
+        inflater.inflate(menuResourceId, menu.getMenu());
+
+        onPreparePopupMenu(menu.getMenu());
+        menu.setOnMenuItemClickListener(this);
+        menu.show();
+    }
+
+    /**
+     * Allows the user to customize the popup menu specified with {@link #getMenuResourceId()}
+     * before it is shown
+     *
+     * @param menu The menu to customize
+     */
+    protected void onPreparePopupMenu(Menu menu) {
+        //Purposefully left blank
+    }
+
+    /**
+     * A simple click listener class to handle menu view clicks
+     */
+    protected class MenuClickListener implements View.OnClickListener {
+        @Override
+        public void onClick(View view) {
+            showMenu(view, getMenuResourceId());
+        }
+    }
+}