Note: You now can set a custom container by calling + * {@link #setStickyHeaderContainer(ViewGroup)}
*/ // @Override -// public ViewGroup getStickySectionHeadersHolder() { +// public ViewGroup getStickyHeaderContainer() { // FrameLayout frameLayout = new FrameLayout(mRecyclerView.getContext()); // frameLayout.setLayoutParams(new ViewGroup.LayoutParams( -// ViewGroup.LayoutParams.WRAP_CONTENT,//or MATCH_PARENT +// ViewGroup.LayoutParams.WRAP_CONTENT, //or MATCH_PARENT // ViewGroup.LayoutParams.WRAP_CONTENT)); -// ((ViewGroup) mRecyclerView.getParent()).addView(frameLayout);//This is important otherwise the Header disappears! +// ((ViewGroup) mRecyclerView.getParent()).addView(frameLayout); //This is important otherwise the Header disappears! // return (ViewGroup) mInflater.inflate(R.layout.sticky_header_layout, frameLayout); // } @@ -124,7 +178,7 @@ public void filterItems(@NonNull ListThis handler can launch asynchronous tasks.
+ * If you catch the reserved "what", keep in mind that this code should be executed + * before that task has been completed. + *Note: numbers 0-9 are reserved for the Adapter, use others for new values.
+ */ + private class MyHandlerCallback extends HandlerCallback { + @Override + public boolean handleMessage(Message message) { + boolean done = super.handleMessage(message); + switch (message.what) { + // Currently reserved (you don't need to check these numbers!) + case 0: //async updateDataSet + case 1: //async filterItems + case 2: //confirm delete + case 8: //onLoadMore remove progress item + return done; + + // Free to use, example: + case 10: + case 11: + return true; + } + return false; + } + } + } \ No newline at end of file diff --git a/flexible-adapter-app/src/main/java/eu/davidea/samples/flexibleadapter/MainActivity.java b/flexible-adapter-app/src/main/java/eu/davidea/samples/flexibleadapter/MainActivity.java index 3ffcdbe5..4b569dc5 100644 --- a/flexible-adapter-app/src/main/java/eu/davidea/samples/flexibleadapter/MainActivity.java +++ b/flexible-adapter-app/src/main/java/eu/davidea/samples/flexibleadapter/MainActivity.java @@ -2,6 +2,8 @@ import android.app.SearchManager; import android.content.Context; +import android.content.Intent; +import android.net.Uri; import android.os.Bundle; import android.os.Handler; import android.os.Looper; @@ -11,6 +13,8 @@ import android.support.design.widget.FloatingActionButton; import android.support.design.widget.NavigationView; import android.support.design.widget.Snackbar; +import android.support.v4.app.ActivityCompat; +import android.support.v4.app.ActivityOptionsCompat; import android.support.v4.app.FragmentManager; import android.support.v4.view.GravityCompat; import android.support.v4.view.MenuItemCompat; @@ -47,7 +51,6 @@ import eu.davidea.flexibleadapter.items.AbstractFlexibleItem; import eu.davidea.flexibleadapter.items.IExpandable; import eu.davidea.flexibleadapter.items.IFlexible; -import eu.davidea.flexibleadapter.items.IHeader; import eu.davidea.samples.flexibleadapter.dialogs.EditItemDialog; import eu.davidea.samples.flexibleadapter.dialogs.MessageDialog; import eu.davidea.samples.flexibleadapter.fragments.AbstractFragment; @@ -57,21 +60,23 @@ import eu.davidea.samples.flexibleadapter.fragments.FragmentExpandableMultiLevel; import eu.davidea.samples.flexibleadapter.fragments.FragmentExpandableSections; import eu.davidea.samples.flexibleadapter.fragments.FragmentHeadersSections; +import eu.davidea.samples.flexibleadapter.fragments.FragmentHolderSections; import eu.davidea.samples.flexibleadapter.fragments.FragmentInstagramHeaders; import eu.davidea.samples.flexibleadapter.fragments.FragmentOverall; import eu.davidea.samples.flexibleadapter.fragments.FragmentSelectionModes; import eu.davidea.samples.flexibleadapter.fragments.FragmentStaggeredLayout; import eu.davidea.samples.flexibleadapter.fragments.OnFragmentInteractionListener; -import eu.davidea.samples.flexibleadapter.models.AbstractModelItem; -import eu.davidea.samples.flexibleadapter.models.ExpandableItem; -import eu.davidea.samples.flexibleadapter.models.HeaderItem; -import eu.davidea.samples.flexibleadapter.models.OverallItem; -import eu.davidea.samples.flexibleadapter.models.SimpleItem; -import eu.davidea.samples.flexibleadapter.models.StaggeredItem; -import eu.davidea.samples.flexibleadapter.models.SubItem; +import eu.davidea.samples.flexibleadapter.items.AbstractItem; +import eu.davidea.samples.flexibleadapter.items.ExpandableItem; +import eu.davidea.samples.flexibleadapter.items.HeaderItem; +import eu.davidea.samples.flexibleadapter.items.OverallItem; +import eu.davidea.samples.flexibleadapter.items.SimpleItem; +import eu.davidea.samples.flexibleadapter.items.StaggeredItem; +import eu.davidea.samples.flexibleadapter.items.SubItem; import eu.davidea.samples.flexibleadapter.services.DatabaseConfiguration; import eu.davidea.samples.flexibleadapter.services.DatabaseService; import eu.davidea.samples.flexibleadapter.services.DatabaseType; +import eu.davidea.samples.flexibleadapter.views.HeaderView; import eu.davidea.utils.ScrollAwareFABBehavior; import eu.davidea.utils.Utils; @@ -79,9 +84,9 @@ * The Demo application is organized in Fragments with 1 Activity {@code MainActivity} * implementing most of the methods. Each Fragment shows a different example and can assemble * more functionalities at once. - * + **
The Activity implementation is organized in this order:
- * + **
* The Fragments may use Activity implementations or may override specific behaviors * themselves. Fragments have {@code AbstractFragment} in common to have some methods reusable. - * + *
*
...more on * Demo app Wiki page.
*/ @@ -136,18 +141,17 @@ public class MainActivity extends AppCompatActivity implements private NavigationView mNavigationView; private AbstractFragment mFragment; private SearchView mSearchView; + private final Handler mRefreshHandler = new Handler(Looper.getMainLooper(), new Handler.Callback() { public boolean handleMessage(Message message) { switch (message.what) { - case 0: //Stop + case 0: // Stop mSwipeRefreshLayout.setRefreshing(false); - mSwipeRefreshLayout.setEnabled(true); return true; - case 1: //Start + case 1: // Start mSwipeRefreshLayout.setRefreshing(true); - mSwipeRefreshLayout.setEnabled(false); return true; - case 2: //Show empty view + case 2: // Show empty view ViewCompat.animate(findViewById(R.id.empty_view)).alpha(1); return true; default: @@ -156,7 +160,9 @@ public boolean handleMessage(Message message) { } }); - /* ACTIVITY MANAGEMENT */ + /* =================== + * ACTIVITY MANAGEMENT + * =================== */ @Override protected void onCreate(Bundle savedInstanceState) { @@ -171,15 +177,15 @@ protected void onCreate(Bundle savedInstanceState) { Log.d(TAG, "onCreate"); FlexibleAdapter.enableLogs(true); - //Initialize Toolbar, Drawer & FAB + // Initialize Toolbar, Drawer & FAB initializeToolbar(); initializeDrawer(); initializeFab(); - //Initialize Fragment containing Adapter & RecyclerView + // Initialize Fragment containing Adapter & RecyclerView initializeFragment(savedInstanceState); - //With FlexibleAdapter v5.0.0 we don't need to call this function anymore - //It is automatically called if Activity implements FlexibleAdapter.OnUpdateListener + // With FlexibleAdapter v5.0.0 we don't need to call this function anymore + // It is automatically called if Activity implements FlexibleAdapter.OnUpdateListener //updateEmptyView(); } @@ -194,9 +200,9 @@ public void onSaveInstanceState(Bundle outState) { @Override protected void onRestoreInstanceState(Bundle savedInstanceState) { super.onRestoreInstanceState(savedInstanceState); - //Restore previous state + // Restore previous state if (savedInstanceState != null && mAdapter != null) { - //Selection + // Selection mAdapter.onRestoreInstanceState(savedInstanceState); mActionModeHelper.restoreSelection(this); } @@ -211,7 +217,9 @@ public void onFragmentChange(SwipeRefreshLayout swipeRefreshLayout, RecyclerView initializeActionModeHelper(mode); } - /* INITIALIZATION METHODS */ + /* ====================== + * INITIALIZATION METHODS + * ====================== */ private void initializeActionModeHelper(int mode) { mActionModeHelper = new ActionModeHelper(mAdapter, mFragment.getContextMenuResId(), this) { @@ -239,20 +247,21 @@ private void initializeFragment(Bundle savedInstanceState) { } private void initializeSwipeToRefresh() { - //Swipe down to force synchronize + // Swipe down to force synchronize //mSwipeRefreshLayout = (SwipeRefreshLayout) findViewById(R.id.swipeRefreshLayout); mSwipeRefreshLayout.setDistanceToTriggerSync(390); - //mSwipeRefreshLayout.setEnabled(true); Controlled by fragments! + //mSwipeRefreshLayout.setEnabled(true); //Controlled by fragments! mSwipeRefreshLayout.setColorSchemeResources( android.R.color.holo_purple, android.R.color.holo_blue_light, android.R.color.holo_green_light, android.R.color.holo_orange_light); mSwipeRefreshLayout.setOnRefreshListener(new SwipeRefreshLayout.OnRefreshListener() { @Override public void onRefresh() { - //Passing true as parameter we always animate the changes between the old and the new data set + // Passing true as parameter we always animate the changes between the old and the new data set + DatabaseService.getInstance().updateNewItems(); mAdapter.updateDataSet(DatabaseService.getInstance().getDatabaseList(), DatabaseConfiguration.animateOnUpdate); - mSwipeRefreshLayout.setEnabled(false); - mRefreshHandler.sendEmptyMessageDelayed(0, 100L);//Simulate network time + mSwipeRefreshLayout.setRefreshing(true); + mRefreshHandler.sendEmptyMessageDelayed(0, 1500L); //Simulate network time mActionModeHelper.destroyActionModeIfCan(); } }); @@ -264,7 +273,7 @@ private void initializeToolbar() { mHeaderView = (HeaderView) findViewById(R.id.toolbar_header_view); mHeaderView.bindTo(getString(R.string.app_name), getString(R.string.overall)); //mToolbarLayout = (CollapsingToolbarLayout) findViewById(R.id.toolbar_layout); - //Toolbar will now take on default Action Bar characteristics + // Toolbar will now take on default Action Bar characteristics setSupportActionBar(mToolbar); } @@ -278,7 +287,7 @@ private void initializeDrawer() { mNavigationView = (NavigationView) findViewById(R.id.nav_view); mNavigationView.setNavigationItemSelectedListener(this); - //Version + // Version TextView appVersion = (TextView) mNavigationView.getHeaderView(0).findViewById(R.id.app_version); appVersion.setText(getString(R.string.about_version, Utils.getVersionName(this), @@ -294,7 +303,7 @@ public void onClick(View v) { mFragment.performFabAction(); } }); - //No Fab on 1st fragment + // No Fab on 1st fragment hideFabSilently(); } @@ -307,7 +316,9 @@ public void onFastScrollerStateChange(boolean scrolling) { } } - /* NAVIGATION DRAWER & FRAGMENT MANAGEMENT */ + /* ======================================= + * NAVIGATION DRAWER & FRAGMENT MANAGEMENT + * ======================================= */ /** * IMPORTANT!! READ THE COMMENT FOR THE FRAGMENT REPLACE @@ -320,7 +331,7 @@ public boolean onNavigationItemSelected(@NonNull MenuItem item) { ScrollAwareFABBehavior fabBehavior = ((ScrollAwareFABBehavior) layoutParams.getBehavior()); fabBehavior.setEnabled(false); - //Handle navigation view item clicks + // Handle navigation view item clicks int id = item.getItemId(); if (id == R.id.nav_overall) { mFragment = FragmentOverall.newInstance(2); @@ -343,6 +354,20 @@ public boolean onNavigationItemSelected(@NonNull MenuItem item) { mFragment = FragmentExpandableSections.newInstance(3); } else if (id == R.id.nav_staggered) { mFragment = FragmentStaggeredLayout.newInstance(2); + } else if (id == R.id.nav_model_holders) { + mFragment = FragmentHolderSections.newInstance(); + } else if (id == R.id.nav_viewpager) { + Intent intent = new Intent(this, ViewPagerActivity.class); + ActivityOptionsCompat activityOptionsCompat = ActivityOptionsCompat.makeBasic(); + ActivityCompat.startActivity(this, intent, activityOptionsCompat.toBundle()); + // Close drawer + mRecyclerView.post(new Runnable() { + @Override + public void run() { + mDrawer.closeDrawer(GravityCompat.START); + } + }); + return true; } else if (id == R.id.nav_about) { MessageDialog.newInstance( R.drawable.ic_info_grey600_24dp, @@ -353,22 +378,25 @@ public boolean onNavigationItemSelected(@NonNull MenuItem item) { .show(getFragmentManager(), MessageDialog.TAG); return true; } else if (id == R.id.nav_github) { - + Intent intent = new Intent(Intent.ACTION_VIEW); + intent.setData(Uri.parse("https://github.com/davideas/FlexibleAdapter")); + startActivity(Intent.createChooser(intent, getString(R.string.intent_chooser))); + return true; } // Insert the fragment by replacing any existing fragment if (mFragment != null) { - //Highlight the selected item has been done by NavigationView + // Highlight the selected item has been done by NavigationView item.setChecked(true); - //THIS IS VERY IMPORTANT. Because you are going to inflate a new RecyclerView, its - //Adapter will be null, therefore the following method cannot be called automatically! - //If your StickyHeaderContainer is in the main view, you must call this method to clean - //the previous sticky view. Alternatively you can move theThis method is called if any limit is reached (targetCount or pageSize + * must be set) AND if new data is temporary unavailable (ex. no connection or no + * new updates remotely). If no new data, a {@link FlexibleAdapter#notifyItemChanged(int, Object)} + * with a payload {@link Payload#NO_MORE_LOAD} is triggered on the progressItem.
+ * + * @param newItemsSize the last size of the new items loaded + * @see FlexibleAdapter#setEndlessTargetCount(int) + * @see FlexibleAdapter#setEndlessPageSize(int) + * @since 5.0.0-rc1 + */ + @Override + public void noMoreLoad(int newItemsSize) { + Log.d(TAG, "newItemsSize=" + newItemsSize); + Log.d(TAG, "Total pages loaded=" + mAdapter.getEndlessCurrentPage()); + Log.d(TAG, "Total items loaded=" + mAdapter.getMainItemCount()); } /** * Loads more data. + *Use {@code lastPosition} and {@code currentPage} to know what to load next.
+ * {@code lastPosition} is the count of the main items without Scrollable Headers. + * + * @param lastPosition the position of the last main item in the adapter + * @param currentPage the current page + * @since 5.0.0-b6 + *This method is called if any limit is reached (targetCount or pageSize + * must be set) AND if new data is temporary unavailable (ex. no connection or no + * new updates remotely). If no new data, a {@link FlexibleAdapter#notifyItemChanged(int, Object)} + * with a payload {@link Payload#NO_MORE_LOAD} is triggered on the progressItem.
+ * + * @param newItemsSize the last size of the new items loaded + * @see FlexibleAdapter#setEndlessTargetCount(int) + * @see FlexibleAdapter#setEndlessPageSize(int) + * @since 5.0.0-rc1 + */ + @Override + public void noMoreLoad(int newItemsSize) { + // This method will never be called if No limits are set and loading more will always + // produce new items (as this example does) + } + /** * Loads more data. + *Use {@code lastPosition} and {@code currentPage} to know what to load next.
+ * {@code lastPosition} is the count of the main items without Scrollable Headers. + * + * @param lastPosition the position of the last main item in the adapter + * @param currentPage the current page + * @since 5.0.0-b6 + *Holder item can be used to display the same modelData in multiple RecyclerViews managed by + * different Adapters, you can implement a derived IFlexible item to HOLD your data model object!
+ * + * In this way you can separate the memory zones of the flags (enabled, expanded, hidden, + * selectable) used by a specific Adapter, to be independent by another Adapter. For instance, + * an item can be Shown and Expanded in a RV, while in the other RV can be Hidden or Not Expanded! + * + * @author Davide Steduto + * @since 19/10/2016 + */ +public class ItemHolder extends AbstractSectionableItemThis method returns always true; Extend with "return false" to Not expand or collapse + * this ItemView onClick events.
+ * + * @return always true, if not overridden + * @since 5.0.0-b1 + */ @Override protected boolean isViewExpandableOnClick() { - return true;//true by default + return true;//default=true + } + + /** + * Allows to collapse child views of this ItemView when {@link View.OnLongClickListener} + * event occurs on the entire view. + *This method returns always true; Extend with "return false" to Not collapse this + * ItemView onLongClick events.
+ * + * @return always true, if not overridden + * @since 5.0.0-b1 + */ + protected boolean isViewCollapsibleOnLongClick() { + return true;//default=true + } + + /** + * Allows to notify change and rebound this itemView on expanding and collapsing events, + * in order to update the content (so, user can decide to display the current expanding status). + *This method returns always false; Override with {@code "return true"} to trigger the + * notification.
+ * + * @return true to rebound the content of this itemView on expanding and collapsing events, + * false to ignore the events + * @see #expandView(int) + * @see #collapseView(int) + * @since 5.0.0-rc1 + */ + @Override + protected boolean shouldNotifyParentOnClick() { + return true;//default=false + } + + /** + * Expands or Collapses based on the current state. + * + * @see #shouldNotifyParentOnClick() + * @see #expandView(int) + * @see #collapseView(int) + * @since 5.0.0-b1 + */ + @Override + protected void toggleExpansion() { + super.toggleExpansion(); //If overridden, you must call the super method } + /** + * Triggers expansion of this itemView. + *If {@link #shouldNotifyParentOnClick()} returns {@code true}, this view is rebound + * with payload {@link Payload#EXPANDED}.
+ * + * @see #shouldNotifyParentOnClick() + * @since 5.0.0-b1 + */ @Override protected void expandView(int position) { - super.expandView(position); - //Let's notify the item has been expanded - if (mAdapter.isExpanded(position)) mAdapter.notifyItemChanged(position, true); + super.expandView(position); //If overridden, you must call the super method + // Let's notify the item has been expanded. Note: from 5.0.0-rc1 the next line becomes + // obsolete, override the new method shouldNotifyParentOnClick() as showcased here + //if (mAdapter.isExpanded(position)) mAdapter.notifyItemChanged(position, true); } + /** + * Triggers collapse of this itemView. + *If {@link #shouldNotifyParentOnClick()} returns {@code true}, this view is rebound + * with payload {@link Payload#COLLAPSED}.
+ * + * @see #shouldNotifyParentOnClick() + * @since 5.0.0-b1 + */ @Override protected void collapseView(int position) { - super.collapseView(position); - //Let's notify the item has been collapsed - if (!mAdapter.isExpanded(position)) mAdapter.notifyItemChanged(position, true); + super.collapseView(position); //If overridden, you must call the super method + // Let's notify the item has been collapsed. Note: from 5.0.0-rc1 the next line becomes + // obsolete, override the new method shouldNotifyParentOnClick() as showcased here + //if (!mAdapter.isExpanded(position)) mAdapter.notifyItemChanged(position, true); } } diff --git a/flexible-adapter-app/src/main/java/eu/davidea/samples/flexibleadapter/items/ExpandableItem.java b/flexible-adapter-app/src/main/java/eu/davidea/samples/flexibleadapter/items/ExpandableItem.java new file mode 100644 index 00000000..e45ec988 --- /dev/null +++ b/flexible-adapter-app/src/main/java/eu/davidea/samples/flexibleadapter/items/ExpandableItem.java @@ -0,0 +1,299 @@ +package eu.davidea.samples.flexibleadapter.items; + +import android.animation.Animator; +import android.content.Context; +import android.graphics.Color; +import android.graphics.drawable.Drawable; +import android.support.annotation.NonNull; +import android.support.v7.widget.GridLayoutManager; +import android.support.v7.widget.StaggeredGridLayoutManager; +import android.support.v7.widget.helper.ItemTouchHelper; +import android.util.Log; +import android.view.LayoutInflater; +import android.view.View; +import android.view.ViewGroup; +import android.widget.ImageView; +import android.widget.TextView; +import android.widget.Toast; + +import java.util.ArrayList; +import java.util.List; + +import eu.davidea.flexibleadapter.FlexibleAdapter; +import eu.davidea.flexibleadapter.helpers.AnimatorHelper; +import eu.davidea.flexibleadapter.items.IExpandable; +import eu.davidea.flexibleadapter.items.IFilterable; +import eu.davidea.flexibleadapter.items.ISectionable; +import eu.davidea.flexibleadapter.utils.DrawableUtils; +import eu.davidea.flexibleadapter.utils.Utils; +import eu.davidea.flipview.FlipView; +import eu.davidea.samples.flexibleadapter.R; +import eu.davidea.viewholders.ExpandableViewHolder; + +/** + * If you don't have fields in common better to extend directly from + * {@link eu.davidea.flexibleadapter.items.AbstractExpandableItem} to benefit of the already + * implemented methods around subItems list. + */ +public class ExpandableItem extends AbstractItemA Section should not contain others Sections!
- * Headers are not Sectionable! + * This is a header item with custom layout for section headers. + *Note: THIS ITEM IS NOT A SCROLLABLE HEADER.
+ * A Section should not contain others Sections and headers are not Sectionable! */ public class HeaderItem extends AbstractHeaderItemIf you don't have many fields in common better to extend directly from - * {@link eu.davidea.flexibleadapter.items.AbstractFlexibleItem} to benefit of the already - * implemented methods (getter and setters).
+ * Item dedicated only for User Learns Selection view (located always at the top in the Adapter). + * This item is a Scrollable Header. */ -public class ULSItem extends AbstractModelItemIf you don't have many fields in common better to extend directly from - * {@link eu.davidea.flexibleadapter.items.AbstractFlexibleItem} to benefit of the already - * implemented methods (getter and setters).
- */ -public class LayoutItem extends AbstractModelItemIn this way you can separate the memory zones of the flags (enabled, expanded, hidden, selectable, - * draggable, swipeable, etc...) used by an Adapter, to be independent by another Adapter. - * For instance an item can be Shown and Expanded in a RV, while in the other RV can be Hidden or - * Not Expanded!
- */ -public class FlexibleItemHolderExampleDefault value is {@code 0ms}.
* * @param initialDelay any non negative delay @@ -136,12 +137,13 @@ void setAnimate(boolean animate) { * @since 5.0.0-b1 */ public AnimatorAdapter setAnimationInitialDelay(long initialDelay) { + if (DEBUG) Log.i(TAG, "Set animationInitialDelay=" + initialDelay); mInitialDelay = initialDelay; return this; } /** - * Customize the step delay between an animation and the next to be added to the initial delay. + * Sets the step delay between an animation and the next to be added to the initial delay. *The delay is added on top of the previous delay.
* Default value is {@code 100ms}. * @@ -150,6 +152,7 @@ public AnimatorAdapter setAnimationInitialDelay(long initialDelay) { * @since 5.0.0-b1 */ public AnimatorAdapter setAnimationDelay(@IntRange(from = 0) long delay) { + if (DEBUG) Log.i(TAG, "Set animationDelay=" + delay); mStepDelay = delay; return this; } @@ -165,12 +168,13 @@ public AnimatorAdapter setAnimationDelay(@IntRange(from = 0) long delay) { * since 5.0.0-b8 */ public AnimatorAdapter setAnimationEntryStep(boolean entryStep) { + if (DEBUG) Log.i(TAG, "Set animationEntryStep=" + entryStep); this.mEntryStep = entryStep; return this; } /** - * Customize the duration of the animation for ALL items. + * Sets the duration of the animation for ALL items. *Default value is {@code 300ms}.
* * @param duration any positive time @@ -178,41 +182,46 @@ public AnimatorAdapter setAnimationEntryStep(boolean entryStep) { * @since 5.0.0-b1 */ public AnimatorAdapter setAnimationDuration(@IntRange(from = 1) long duration) { + if (DEBUG) Log.i(TAG, "Set animationDuration=" + duration); mDuration = duration; return this; } /** - * Define a custom interpolator for ALL items. + * Sets a custom interpolator for ALL items. *Default value is {@link LinearInterpolator}.
* * @param interpolator any valid non null interpolator * @return this AnimatorAdapter, so the call can be chained */ public AnimatorAdapter setAnimationInterpolator(@NonNull Interpolator interpolator) { + if (DEBUG) Log.i(TAG, "Set animationInterpolator=" + getClassName(interpolator)); mInterpolator = interpolator; return this; } /** - * Define an initial start animation adapter position. + * Sets an initial start animation adapter position. *Default value is {@code 0} (1st position).
* * @param start non negative minimum position to start animation. * @since 5.0.0-b1 + * @deprecated Can't be supported anymore due to the new internal condition of non-animations. */ + @Deprecated public AnimatorAdapter setAnimationStartPosition(@IntRange(from = 0) int start) { + if (DEBUG) Log.i(TAG, "Set animationStartPosition=" + start); mLastAnimatedPosition = start; return this; } /** - * Enable/Disable item animation while scrolling and on loading. + * Enables/Disables item animation while scrolling and on loading. *Enabling scrolling will disable onlyEntryAnimation.
- * Disabling scrolling will disable also reverse scrolling!
Note: Loading animation can only be performed if the Adapter is initialized + * with some items using the constructor.
* * @param enabled true to enable item animation, false to disable them all. * @return this AnimatorAdapter, so the call can be chained @@ -221,6 +230,7 @@ public AnimatorAdapter setAnimationStartPosition(@IntRange(from = 0) int start) * @since 5.0.0-b1 */ public AnimatorAdapter setAnimationOnScrolling(boolean enabled) { + if (DEBUG) Log.i(TAG, "Set animationOnScrolling=" + enabled); if (enabled) this.onlyEntryAnimation = false; shouldAnimate = enabled; return this; @@ -231,7 +241,7 @@ public boolean isAnimationOnScrollingEnabled() { } /** - * Enable reverse scrolling animation if AnimationOnScrolling is also enabled! + * Enables reverse scrolling animation if AnimationOnScrolling is also enabled! *Value is ignored if basic animation on scrolling is disabled.
* Default value is {@code false} (only forward). * @@ -241,6 +251,7 @@ public boolean isAnimationOnScrollingEnabled() { * @since 5.0.0-b1 */ public AnimatorAdapter setAnimationOnReverseScrolling(boolean enabled) { + if (DEBUG) Log.i(TAG, "Set animationOnReverseScrolling=" + enabled); isReverseEnabled = enabled; return this; } @@ -248,11 +259,21 @@ public AnimatorAdapter setAnimationOnReverseScrolling(boolean enabled) { /** * @return true if items are animated also on reverse scrolling, false only forward * @since 5.0.0-b1 + * @deprecated use {@link #isAnimationOnReverseScrollingEnabled()} */ + @Deprecated public boolean isAnimationOnReverseScrolling() { return isReverseEnabled; } + /** + * @return true if items are animated also on reverse scrolling, false only forward + * @since 5.0.0-b1 + */ + public boolean isAnimationOnReverseScrollingEnabled() { + return isReverseEnabled; + } + /** * Performs only entry animation during the initial loading. Stops the animation after * the last visible item in the RecyclerView has been animated. @@ -266,6 +287,7 @@ public boolean isAnimationOnReverseScrolling() { * @since 5.0.0-b8 */ public AnimatorAdapter setOnlyEntryAnimation(boolean enabled) { + if (DEBUG) Log.i(TAG, "Set onlyEntryAnimation=" + enabled); if (enabled) this.shouldAnimate = true; this.onlyEntryAnimation = enabled; return this; @@ -280,34 +302,10 @@ public boolean isOnlyEntryAnimation() { return onlyEntryAnimation; } - /** - * Triggered by the FastScroller when handle is touched - * - * @param scrolling boolean to indicate that the handle is being fast scrolled - * @since 5.0.0-b1 - */ - @Override - public void onFastScrollerStateChange(boolean scrolling) { - super.onFastScrollerStateChange(scrolling); - isFastScroll = scrolling; - } - /*--------------*/ /* MAIN METHODS */ /*--------------*/ - @Override - @CallSuper - public void onViewAttachedToWindow(RecyclerView.ViewHolder holder) { - int position = holder.getAdapterPosition(); -// if (DEBUG) { -// Log.v(TAG, "onViewAttached Holder=" + holder.getClass().getSimpleName() + -// " position=" + position + -// " itemId=" + holder.getItemId()); -// } - animateView(holder, position); - } - /** * Build your custom list of {@link Animator} to apply on the ItemView.Note: If you have to change at runtime the LayoutManager and add + * Scrollable Headers too, consider to add them in post, using a {@code delay >= 0}, + * otherwise scroll animations on all items will not start correctly.
+ * + * @param holder the ViewHolder just bound + * @param position the current item position + */ + @SuppressWarnings("ConstantConditions") + protected final void animateView(final RecyclerView.ViewHolder holder, final int position) { + if (mRecyclerView == null) return; + + // Use always the max child count reached + if (mMaxChildViews < mRecyclerView.getChildCount()) { + mMaxChildViews = mRecyclerView.getChildCount(); + } + // Animate only during initial loading? + if (onlyEntryAnimation && mLastAnimatedPosition >= mMaxChildViews) { + shouldAnimate = false; + } + int lastVisiblePosition = Utils.findLastVisibleItemPosition(mRecyclerView.getLayoutManager()); +// if (DEBUG) { // Log.v(TAG, "shouldAnimate=" + shouldAnimate // + " isFastScroll=" + isFastScroll // + " isNotified=" + mAnimatorNotifierObserver.isPositionNotified() // + " isReverseEnabled=" + isReverseEnabled // + " mLastAnimatedPosition=" + mLastAnimatedPosition -// + (!isReverseEnabled ? " Pos>AniPos=" + (position > mLastAnimatedPosition) : "") +// + (!isReverseEnabled ? " Pos>LasVisPos=" + (position > lastVisiblePosition) : "") +// + " mMaxChildViews=" + mMaxChildViews // ); - +// } if (holder instanceof FlexibleViewHolder && shouldAnimate && !isFastScroll && !mAnimatorNotifierObserver.isPositionNotified() && - (isReverseEnabled || position > mLastAnimatedPosition || (position == 0 && mRecyclerView.getChildCount() == 0)) ) { + (position > lastVisiblePosition || isReverseEnabled || isScrollableHeaderOrFooter(position) || (position == 0 && mMaxChildViews == 0))) { - //Cancel animation is necessary when fling + // Cancel animation is necessary when fling int hashCode = holder.itemView.hashCode(); cancelExistingAnimation(hashCode); - //User animators + // User animators ListAlso, some items at the edge, are rebounded by Android and should not be animated.
+ *Also, some items at the edge, are rebound by Android and should not be animated.
*/ private class AnimatorAdapterDataObserver extends RecyclerView.AdapterDataObserver { private boolean notified; private Handler mAnimatorHandler = new Handler(Looper.getMainLooper(), new Handler.Callback() { public boolean handleMessage(Message message) { - if (DEBUG) Log.v(TAG, "Clear notified for binding Animations"); + if (DEBUG) Log.v(TAG, "Clear notified for scrolling Animations"); notified = false; return true; } @@ -696,6 +692,8 @@ public void clearNotified() { private void markNotified() { notified = !animateFromObserver; +// if (DEBUG) +// Log.v(TAG, "animateFromObserver=" + animateFromObserver + " notified=" + notified); } @Override @@ -737,7 +735,6 @@ private class HelperAnimatorListener implements Animator.AnimatorListener { @Override public void onAnimationStart(Animator animation) { - } @Override diff --git a/flexible-adapter/src/main/java/eu/davidea/flexibleadapter/FlexibleAdapter.java b/flexible-adapter/src/main/java/eu/davidea/flexibleadapter/FlexibleAdapter.java index 63022538..77a798df 100644 --- a/flexible-adapter/src/main/java/eu/davidea/flexibleadapter/FlexibleAdapter.java +++ b/flexible-adapter/src/main/java/eu/davidea/flexibleadapter/FlexibleAdapter.java @@ -22,10 +22,11 @@ import android.os.Looper; import android.os.Message; import android.support.annotation.CallSuper; +import android.support.annotation.FloatRange; import android.support.annotation.IntRange; import android.support.annotation.NonNull; import android.support.annotation.Nullable; -import android.support.v4.view.ViewCompat; +import android.support.v7.util.DiffUtil; import android.support.v7.widget.RecyclerView; import android.support.v7.widget.helper.ItemTouchHelper; import android.util.Log; @@ -43,6 +44,7 @@ import java.util.LinkedHashSet; import java.util.List; import java.util.Locale; +import java.util.Map; import java.util.Set; import eu.davidea.flexibleadapter.common.SmoothScrollGridLayoutManager; @@ -58,20 +60,21 @@ import eu.davidea.viewholders.ExpandableViewHolder; import eu.davidea.viewholders.FlexibleViewHolder; +import static eu.davidea.flexibleadapter.utils.Utils.getClassName; + /** - * This class is backed by an ArrayList of arbitrary objects of T, where T is - * your Model object containing the data, with version 5.0.0 it must implement {@link IFlexible} - * interface. Read Wiki page on - * Github for more details. - *This class provides a set of standard methods to handle changes on the data set such as - * filtering, adding, removing, moving and animating an item.
- * With version 5.0.0, this Adapter supports a set of standard methods for Headers/Sections to - * expand and collapse an Expandable item, to Drag&Drop and Swipe any item. - *NOTE: This Adapter supports multi level of Expandable, but do not enable Drag&Drop.
- * Something might not work as expected, so better to change approach in favor of a clearer
- * design/layout: Open the sub list in a new Activity/Fragment...
- *
Instead, this extra level of expansion is useful in situations where information is in
- * read only mode or with action buttons.
+ * With version 5.0.0, T item must implement {@link IFlexible} item interface as base item + * for all view types and new methods have been added in order to: + *
You can use and override this Handler, but you must keep the "What" by calling super():
- *
0 = updateDataSet.
- *
1 = filterItems, optionally delayed.
- *
2 = deleteConfirmed when Undo timeout is over.
- *
8 = remove the progress item from the list, optionally delayed.
- *
9 = reset flag to load more items, delayed.
The listener must be a single instance of a class, usually Activity or Fragment, - * where you can implement how to handle the different events.
- * Any write operation performed on the items list is synchronized. - *PASS ALWAYS A COPY OF THE ORIGINAL LIST: new ArrayList<T>(originalList);
+ *The listener must be a single instance of a class, usually Activity or + * Fragment, where you can implement how to handle the different events.
+ *PROVIDE ALWAYS A COPY OF THE ORIGINAL LIST:
+ * {@code new ArrayList
Note: Setting true allows the RecyclerView to rebind only items really changed - * after a refresh or after swapping Adapter. This increase performance, you loose scrolling - * animations.
- * Set {@code true} if items implements {@code hashcode()} and have stable ids. The method + * after a refresh or after swapping Adapter. This increase performance, but you loose + * scrolling animations. + * Set {@code true} only if items implement {@code hashcode()} and have stable ids. The method * {@link #setHasStableIds(boolean)} will be called. * - * @param stableIds set {@code true} if items implements {@code hashcode()} and have stable ids. + * @param stableIds set {@code true} if item implements {@code hashcode()} and have stable ids. + * @see #FlexibleAdapter(List) + * @see #FlexibleAdapter(List, Object) + * @see #addListener(Object) * @since 5.0.0-b8 */ public FlexibleAdapter(@Nullable ListThis method is automatically called from the Constructor.
* - * @param listeners the object(s) instance(s) of any listener + * @param listener the object(s) instance(s) of any listener + * @return this Adapter, so the call can be chained + * @deprecated Use {@link #addListener(Object)} + */ + @Deprecated + public FlexibleAdapter initializeListeners(@Nullable Object listener) { + return addListener(listener); + } + + /** + * Initializes the listener(s) of this Adapter. + *This method is automatically called from the Constructor.
+ * + * @param listener the object(s) instance(s) of any listener * @return this Adapter, so the call can be chained * @since 5.0.0-b6 */ - public FlexibleAdapter initializeListeners(@Nullable Object listeners) { - if (listeners instanceof OnUpdateListener) { - mUpdateListener = (OnUpdateListener) listeners; - mUpdateListener.onUpdateEmptyView(getItemCount()); - } - if (listeners instanceof OnItemClickListener) - mItemClickListener = (OnItemClickListener) listeners; - if (listeners instanceof OnItemLongClickListener) - mItemLongClickListener = (OnItemLongClickListener) listeners; - if (listeners instanceof OnItemMoveListener) - mItemMoveListener = (OnItemMoveListener) listeners; - if (listeners instanceof OnItemSwipeListener) - mItemSwipeListener = (OnItemSwipeListener) listeners; - if (listeners instanceof OnStickyHeaderChangeListener) - mStickyHeaderChangeListener = (OnStickyHeaderChangeListener) listeners; + @CallSuper + public FlexibleAdapter addListener(@Nullable Object listener) { + if (DEBUG && listener != null) { + Log.i(TAG, "Adding listener class " + getClassName(listener) + " as:"); + } + if (listener instanceof OnItemClickListener) { + if (DEBUG) Log.i(TAG, "- OnItemClickListener"); + mItemClickListener = (OnItemClickListener) listener; + } + if (listener instanceof OnItemLongClickListener) { + if (DEBUG) Log.i(TAG, "- OnItemLongClickListener"); + mItemLongClickListener = (OnItemLongClickListener) listener; + } + if (listener instanceof OnItemMoveListener) { + if (DEBUG) Log.i(TAG, "- OnItemMoveListener"); + mItemMoveListener = (OnItemMoveListener) listener; + } + if (listener instanceof OnItemSwipeListener) { + if (DEBUG) Log.i(TAG, "- OnItemSwipeListener"); + mItemSwipeListener = (OnItemSwipeListener) listener; + } + if (listener instanceof OnStickyHeaderChangeListener) { + if (DEBUG) Log.i(TAG, "- OnStickyHeaderChangeListener"); + mStickyHeaderChangeListener = (OnStickyHeaderChangeListener) listener; + } + if (listener instanceof OnUpdateListener) { + if (DEBUG) Log.i(TAG, "- OnUpdateListener"); + mUpdateListener = (OnUpdateListener) listener; + mUpdateListener.onUpdateEmptyView(getMainItemCount()); + } return this; } /** * {@inheritDoc} - *Attaches the StickyHeaderHelper from the RecyclerView when necessary
+ *Attaches the StickyHeaderHelper from the RecyclerView if necessary.
* * @since 5.0.0-b6 */ @@ -315,7 +325,7 @@ public void onAttachedToRecyclerView(RecyclerView recyclerView) { @Override public void onDetachedFromRecyclerView(RecyclerView recyclerView) { if (mStickyHeaderHelper != null) { - mStickyHeaderHelper.detachFromRecyclerView(mRecyclerView); + mStickyHeaderHelper.detachFromRecyclerView(); mStickyHeaderHelper = null; } super.onDetachedFromRecyclerView(recyclerView); @@ -325,17 +335,16 @@ public void onDetachedFromRecyclerView(RecyclerView recyclerView) { * Maps and expands items that are initially configured to be shown as expanded. *This method should be called during the creation of the Activity/Fragment, useful also
* after a screen rotation.
- *
It is also called after DataSet is updated.
When an item is disabled, user cannot interact with it.
* * @param position the current position of the item to check * @return true if the item property enabled is set true, false otherwise @@ -379,33 +389,33 @@ public boolean isSelectable(int position) { /** * {@inheritDoc} * - * @param position Position of the item to toggle the selection status for. + * @param position position of the item to toggle the selection status for. * @since 5.0.0-b1 */ + //TODO: Review the logic of selection coherence @Override public void toggleSelection(@IntRange(from = 0) int position) { T item = getItem(position); - //Allow selection only for selectable items + // Allow selection only for selectable items if (item != null && item.isSelectable()) { IExpandable parent = getExpandableOf(item); boolean hasParent = parent != null; if ((isExpandable(item) || !hasParent) && !childSelected) { - //Allow selection of Parent if no Child has been previously selected + // Allow selection of Parent if no Child has been previously selected parentSelected = true; - if (hasParent) selectedLevel = parent.getExpansionLevel(); + if (hasParent) mSelectedLevel = parent.getExpansionLevel(); super.toggleSelection(position); - } else if (!parentSelected && hasParent && parent.getExpansionLevel() + 1 == selectedLevel - || selectedLevel == -1) { - //Allow selection of Child of same level and if no Parent has been previously selected + } else if (!parentSelected && hasParent && parent.getExpansionLevel() + 1 == mSelectedLevel + || mSelectedLevel == -1) { + // Allow selection of Child of same level and if no Parent has been previously selected childSelected = true; - selectedLevel = parent.getExpansionLevel() + 1; + mSelectedLevel = parent.getExpansionLevel() + 1; super.toggleSelection(position); } } - - //Reset flags if necessary, just to be sure + // Reset flags if necessary, just to be sure if (getSelectedItemCount() == 0) { - selectedLevel = -1; + mSelectedLevel = -1; parentSelected = childSelected = false; } } @@ -416,21 +426,21 @@ public void toggleSelection(@IntRange(from = 0) int position) { *Examples:
*
- if user initially selects an expandable of type A, then only expandable items of
* type A will be selected.
- *
- if user initially selects a non-expandable of type B, then only items of Type B
+ *
- if user initially selects a non-expandable of type B, then only items of type B
* will be selected.
*
- The developer can override this behaviour by passing a list of viewTypes for which
* he wants to force the selection.
In this case changes will NOT be animated: {@link #notifyDataSetChanged()} will be invoked.
+ * Convenience method of {@link #updateDataSet(List, boolean)} (You should read the comments + * of this method). + *In this call, changes will NOT be animated: Warning! + * {@link #notifyDataSetChanged()} will be invoked.
* * @param items the new data set * @see #updateDataSet(List, boolean) @@ -480,47 +492,59 @@ public void updateDataSet(ListOptionally all changes can be animated, limited by the value previously set with - * {@link #setAnimateToLimit(int)} to improve performance on big list.
- * Pass {@code animate = false} to directly invoke {@link #notifyDataSetChanged()} - * without any animations. - *Note: This methods calls {@link #expandItemsAtStartUp()} and - * {@link #showAllHeaders()} if headers are shown.
+ * This method will refresh the entire data set content. Optionally, all changes can be + * animated, limited by the value previously set with {@link #setAnimateToLimit(int)} + * to improve performance on very big list. Should provide {@code animate=false} to + * directly invoke {@link #notifyDataSetChanged()} without any animations, if {@code stableIds} + * is not set! + *Note: + *
This cannot be overridden since the entire library relies on it.
+ * Returns the object of type T. + *This method cannot be overridden since the entire library relies on it.
* * @param position the position of the item in the list - * @return The custom "Item" object or null if item not found + * @return The T object for the position provided or null if item not found * @since 1.0.0 */ public final T getItem(@IntRange(from = 0) int position) { - if (position < 0 || position >= mItems.size()) return null; + if (position < 0 || position >= getItemCount()) return null; return mItems.get(position); } /** + * This method is mostly used by the adapter if items have stableIds. + * * @param position the position of the current item * @return Hashcode of the item at the specific position * @since 5.0.0-b1 @@ -532,17 +556,39 @@ public long getItemId(int position) { } /** - * This cannot be overridden since the selection relies on it. + * Returns the total number of items in the data set held by the adapter (headers and footers + * INCLUDED). Use {@link #getMainItemCount()} with {@code false} as parameter to retrieve + * only real items excluding headers and footers. + *Note: This method cannot be overridden since the selection and the internal + * methods rely on it.
* - * @return the total number of the items currently displayed by the adapter + * @return the total number of items (headers and footers INCLUDED) held by the adapter + * @see #getMainItemCount() * @see #getItemCountOfTypes(Integer...) - * @see #getItemCountOfTypesUntil(int, Integer...) * @see #isEmpty() * @since 1.0.0 */ @Override public final int getItemCount() { - return mItems != null ? mItems.size() : 0; + return mItems.size(); + } + + /** + * Returns the total number of items in the data set held by the adapter. + *This method cannot be overridden since the entire library relies on it.
* * @param item the item to find * @return the global position in the Adapter if found, -1 otherwise * @since 5.0.0-b1 */ - public int getGlobalPositionOf(@NonNull IFlexible item) { - return item != null && mItems != null && !mItems.isEmpty() ? mItems.indexOf(item) : -1; + public final int getGlobalPositionOf(@NonNull IFlexible item) { + return item != null ? mItems.indexOf(item) : -1; + } + + /** + * Retrieves the position of the Main item in the Adapter list excluding the scrollable Headers. + * If no scrollable Headers are added, the cardinal position coincides with the global position. + *Note:
+ *
- This method is NOT suitable to call when managing items: ALL insert, remove, move and
+ * swap operations, should done with global position {@link #getGlobalPositionOf(IFlexible)}.
+ *
- This method cannot be overridden.
Note: The Comparator should be customized to support all the types of items - * this Adapter is displaying or a ClassCastException will be raised.
- * If Comparator is {@code null} the returned position is 0. + *Note: The {@code Comparator} object should be customized to support all + * types of items this Adapter is managing or a {@code ClassCastException} will be raised.
+ * If the {@code Comparator} is {@code null} the returned position is 0 (first position). * * @param item the item to evaluate the insertion * @param comparator the Comparator object with the logic to sort the list @@ -630,10 +702,10 @@ public boolean contains(@NonNull T item) { * @since 5.0.0-b7 */ public int calculatePositionFor(@NonNull Object item, @Nullable Comparator comparator) { - //There's nothing to compare + // There's nothing to compare if (comparator == null) return 0; - //Header is visible + // Header is visible if (item instanceof ISectionable) { IHeader header = ((ISectionable) item).getHeader(); if (header != null && !header.isHidden()) { @@ -642,8 +714,8 @@ public int calculatePositionFor(@NonNull Object item, @Nullable Comparator compa Collections.sort(sortedList, comparator); int itemPosition = mItems.indexOf(item); int headerPosition = getGlobalPositionOf(header); - //#143 - calculatePositionFor() missing a +1 when addItem (fixed by condition: itemPosition != -1) - //fix represents the situation when item is before the target position (used in moveItem) + // #143 - calculatePositionFor() missing a +1 when addItem (fixed by condition: itemPosition != -1) + // fix represents the situation when item is before the target position (used in moveItem) int fix = itemPosition != -1 && itemPosition < headerPosition ? 0 : 1; int result = headerPosition + sortedList.indexOf(item) + fix; if (DEBUG) { @@ -654,7 +726,7 @@ public int calculatePositionFor(@NonNull Object item, @Nullable Comparator compa return result; } } - //All other cases + // All other cases List sortedList = new ArrayList(mItems); if (!sortedList.contains(item)) sortedList.add(item); Collections.sort(sortedList, comparator); @@ -663,6 +735,280 @@ public int calculatePositionFor(@NonNull Object item, @Nullable Comparator compa return Math.max(0, sortedList.indexOf(item)); } + /*------------------------------------*/ + /* SCROLLABLE HEADERS/FOOTERS METHODS */ + /*------------------------------------*/ + + /** + * @return unmodifiable list of Scrollable Headers currently held by the Adapter + * @see #addScrollableHeader(IFlexible) + * @see #addScrollableHeaderWithDelay(IFlexible, long, boolean) + * @since 5.0.0-rc1 + */ + public final ListScrollable Headers have the following characteristic: + *
Scrollable Footers have the following characteristic: + *
Default value is {@code false}.
* - * @param unlinkOnRemoveHeader true to unlink also all items with the just deleted header, - * false otherwise + * @param unlinkOnRemoveHeader true to unlink the deleted header from items having that header + * linked, false otherwise * @return this Adapter, so the call can be chained * @since 5.0.0-b6 */ public FlexibleAdapter setUnlinkAllItemsOnRemoveHeaders(boolean unlinkOnRemoveHeader) { + if (DEBUG) Log.i(TAG, "Set unlinkOnRemoveHeader=" + unlinkOnRemoveHeader); this.unlinkOnRemoveHeader = unlinkOnRemoveHeader; return this; } @@ -713,8 +1065,10 @@ public FlexibleAdapter setUnlinkAllItemsOnRemoveHeaders(boolean unlinkOnRemoveHe * @return the list of the orphan headers collected until this moment * @see #setRemoveOrphanHeaders(boolean) * @since 5.0.0-b6 + * @deprecated Orphan headers methods series: There's no advantage to keep in the adapter such + * references, most of the time, user has the control on the items to remove, headers as well. */ - //TODO: deprecation? + @Deprecated @NonNull public ListHeaders can be sticky only if they are shown. Command is otherwise ignored!
- * NOTE: - *Headers can be sticky only if they are shown.
+ * Note: + *Note: + *
+ * <FrameLayout + * android:layout_width="match_parent" + * android:layout_height="match_parent"> + * + * <android.support.v7.widget.RecyclerView + * android:id="@+id/recycler_view" + * android:layout_width="match_parent" + * android:layout_height="match_parent"/> + * + * </FrameLayout> + *+ * + * @param sticky true to initialize sticky headers with default container, false to disable them + * @return this Adapter, so the call can be chained + * @throws IllegalStateException if this Adapter was not attached to the RecyclerView + * @see #setStickyHeaders(boolean, ViewGroup) + * @see #setDisplayHeadersAtStartUp(boolean) + * @see #setStickyHeaderElevation(float) + * @since 5.0.0-rc1 + */ + public FlexibleAdapter setStickyHeaders(boolean sticky) { + return setStickyHeaders(sticky, mStickyContainer); + } + + /** + * Enables/Disables the sticky header feature with a custom sticky layout container. + *
Important: Read the javaDoc of the overloaded method {@link #setStickyHeaders(boolean)}.
+ * + * @param sticky true to initialize sticky headers, false to disable them + * @param stickyContainer user defined and already inflated sticky layout that will + * hold the sticky header itemViews + * @return this Adapter, so the call can be chained + * @throws IllegalStateException if this Adapter was not attached to the RecyclerView + * @see #setStickyHeaders(boolean) + * @see #setDisplayHeadersAtStartUp(boolean) + * @see #setStickyHeaderElevation(float) + * @since 5.0.0-rc1 + */ + public FlexibleAdapter setStickyHeaders(final boolean sticky, @NonNull ViewGroup stickyContainer) { + if (DEBUG) Log.i(TAG, "Set stickyHeaders=" + sticky + " (in Post!)" + + (stickyContainer != null ? " with user defined Sticky Container" : "")); + + // With user defined container + mStickyContainer = stickyContainer; + + // Run in post to be sure about the RecyclerView initialization mHandler.post(new Runnable() { @Override public void run() { - // Add or Remove the sticky headers + // Enable or Disable the sticky headers layout if (sticky) { - headersSticky = true; - if (mStickyHeaderHelper == null) - mStickyHeaderHelper = new StickyHeaderHelper(FlexibleAdapter.this, mStickyHeaderChangeListener); - if (!mStickyHeaderHelper.isAttachedToRecyclerView()) + if (mStickyHeaderHelper == null) { + mStickyHeaderHelper = new StickyHeaderHelper(FlexibleAdapter.this, + mStickyHeaderChangeListener, mStickyContainer); mStickyHeaderHelper.attachToRecyclerView(mRecyclerView); - if (DEBUG) Log.i(TAG, "Sticky headers enabled"); + if (DEBUG) Log.i(TAG, "Sticky headers enabled"); + } } else if (mStickyHeaderHelper != null) { - headersSticky = false; - mStickyHeaderHelper.detachFromRecyclerView(mRecyclerView); + mStickyHeaderHelper.detachFromRecyclerView(); mStickyHeaderHelper = null; if (DEBUG) Log.i(TAG, "Sticky headers disabled"); } @@ -973,6 +1405,35 @@ public void run() { return this; } + /** + * Gets the layout elevation for sticky header. + *Note: This setting is ignored if the header item has already an elevation. The + * header elevation overrides this setting.
+ * + * @return the elevation in pixel + * @see #setStickyHeaderElevation(float) + * @since 5.0.0-rc1 + */ + public float getStickyHeaderElevation() { + return mStickyElevation; + } + + /** + * Sets the elevation for the sticky header layout. + *Note: This setting is ignored if the header item has already an elevation. The + * header elevation overrides this setting.
+ * Default value is 0. + * + * @param stickyElevation the elevation in pixel + * @return this Adapter, so the call can be chained + * @see #getStickyHeaderElevation() + * @since 5.0.0-rc1 + */ + public FlexibleAdapter setStickyHeaderElevation(@FloatRange(from = 0) float stickyElevation) { + mStickyElevation = stickyElevation; + return this; + } + /** * Returns the ViewGroup (FrameLayout) that will hold the headers when sticky. *INCLUDE the predefined layout after the RecyclerView widget, example: @@ -987,21 +1448,57 @@ public void run() { * * @return ViewGroup layout that will hold the sticky header ItemViews * @since 5.0.0-b6 + * @deprecated Unused. Use {@link #setStickyHeaders(boolean, ViewGroup)}. */ + @Deprecated public ViewGroup getStickySectionHeadersHolder() { - return (ViewGroup) Utils.scanForActivity(mRecyclerView.getContext()).findViewById(R.id.sticky_header_container); + if (mStickyContainer == null) { + mStickyContainer = (ViewGroup) Utils + .scanForActivity(mRecyclerView.getContext()) + .findViewById(R.id.sticky_header_container); + } + return mStickyContainer; } /** - * Sets if all headers should be shown at startup. 2 effects are possible depending by - * the current flag of scrolling animation: - *
- if enabled, scrolling animations are performed as configured for the header item;
- *
- if disabled, {@code notifyItemInserted()} is instead performed for each header
- * item.
Default value is {@code false} (headers are NOT shown at startup).
+ * Returns the ViewGroup (FrameLayout) that will hold the headers when sticky. + * Set a custom container with {@link #setStickyHeaderContainer(ViewGroup)} before enabling + * sticky headers. + * + * @return ViewGroup layout that will hold the sticky header itemViews + * @since 5.0.0-rc1 + * @deprecated Unused, not needed anymore. + */ + @Deprecated + public ViewGroup getStickyHeaderContainer() { + return mStickyContainer; + } + + /** + * Sets a custom {@link ViewGroup} container for Sticky Headers when the default can't be used. + * + * @param stickyContainer custom container for Sticky Headers + * @since 5.0.0-rc1 + * @deprecated Use {@link #setStickyHeaders(boolean, ViewGroup)}. + */ + @Deprecated + public FlexibleAdapter setStickyHeaderContainer(@NonNull ViewGroup stickyContainer) { + if (mStickyHeaderHelper != null) { + Log.w(TAG, "StickyHeader has been already initialized! Call this method before enabling StickyHeaders"); + } + if (DEBUG && stickyContainer != null) + Log.i(TAG, "Set stickyHeaderContainer=" + getClassName(stickyContainer)); + this.mStickyContainer = stickyContainer; + return this; + } + + /** + * Sets if all headers should be shown at startup. + *If called, this method won't trigger {@code notifyItemInserted()} and scrolling + * animations are instead performed if the header item was configured with animation: + * Headers will be loaded/bound along with others items.
+ * Note: Headers can only be shown or hidden all together. + *Default value is {@code false} (headers are not shown at startup).
* * @param displayHeaders true to display headers, false to keep them hidden * @return this Adapter, so the call can be chained @@ -1009,51 +1506,54 @@ public ViewGroup getStickySectionHeadersHolder() { * @see #setAnimationOnScrolling(boolean) * @since 5.0.0-b6 */ - //TODO: deprecation, rename to displayHeadersAtStartUp() with no parameters? public FlexibleAdapter setDisplayHeadersAtStartUp(boolean displayHeaders) { if (!headersShown && displayHeaders) { - showAllHeaders(isAnimationOnScrollingEnabled()); + showAllHeaders(true); } return this; } /** - * Shows all headers in the RecyclerView at their linked position. Not intended to be called at - * startup.Note: Headers can only be shown or hidden all together.
+ * Shows all headers in the RecyclerView at their linked position. + *If called at startup, this method will trigger {@code notifyItemInserted} for a + * different loading effect: Headers will be inserted after the items!
+ * Note: Headers can only be shown or hidden all together. * + * @return this Adapter, so the call can be chained * @see #hideAllHeaders() * @see #setDisplayHeadersAtStartUp(boolean) * @since 5.0.0-b1 */ - public void showAllHeaders() { + public FlexibleAdapter showAllHeaders() { showAllHeaders(false); + return this; } /** - * @param init true to skip {@code notifyItemInserted}, false to make the call in Post and - * notify single insertion + * @param init true to skip {@code notifyItemInserted}, false to make the call in Post + * and notify single insertion */ private void showAllHeaders(boolean init) { if (init) { - //No notifyItemInserted! + if (DEBUG) Log.i(TAG, "showAllHeaders at startup"); + // No notifyItemInserted! showAllHeadersWithReset(true); } else { - //In post, let's notifyItemInserted! + if (DEBUG) Log.i(TAG, "showAllHeaders with insert notification (in Post!)"); + // In post, let's notifyItemInserted! mHandler.post(new Runnable() { @Override public void run() { - //#144 - Check if headers are already shown, discard the call to not duplicate headers + // #144 - Check if headers are already shown, discard the call to not duplicate headers if (headersShown) { - Log.w(TAG, "Headers already shown OR the method setDisplayHeadersAtStartUp() was already called!"); + Log.w(TAG, "Double call detected! Headers already shown OR the method showAllHeaders() was already called!"); return; } showAllHeadersWithReset(false); - //#142 - At startup, when scrolling animation is disabled, insert notifications - // are performed to show headers for the first time. Header item is not visible - // at position 0: it has to be displayed by scrolling to it. This resolves the - // first item below sticky header when enabled as well. + // #142 - At startup, when insert notifications are performed to show headers + // for the first time. Header item is not visible at position 0: it has to be + // displayed by scrolling to it. This resolves the first item below sticky + // header when enabled as well. if (mRecyclerView != null) { int firstVisibleItem = Utils.findFirstCompletelyVisibleItemPosition(mRecyclerView.getLayoutManager()); if (firstVisibleItem == 0 && isHeader(getItem(0)) && !isHeader(getItem(1))) { @@ -1069,16 +1569,21 @@ public void run() { * @param init true to skip the call to notifyItemInserted, false otherwise */ private void showAllHeadersWithReset(boolean init) { - multiRange = true; int position = 0; - resetHiddenStatus();//Necessary after the filter and the update - while (position < mItems.size()) { - if (showHeaderOf(position, mItems.get(position), init)) - position++;//It's the same element, skip it + IHeader sameHeader = null; + while (position < getItemCount() - mScrollableFooters.size()) { + T item = mItems.get(position); + // Reset hidden status! Necessary after the filter and the update + IHeader header = getHeaderOf(item); + if (header != sameHeader && header != null && !isExpandable((T) header)) { + sameHeader = header; + header.setHidden(true); + } + if (showHeaderOf(position, item, init)) + position++; //It's the same element, skip it position++; } headersShown = true; - multiRange = false; } /** @@ -1086,27 +1591,20 @@ private void showAllHeadersWithReset(boolean init) { * * @param position the position where the header will be displayed * @param item the item that holds the header - * @param init for silent initialization + * @param init for silent initialization: skip notifyItemInserted * @since 5.0.0-b1 */ private boolean showHeaderOf(int position, @NonNull T item, boolean init) { - //Take the header + // Take the header IHeader header = getHeaderOf(item); - //Check header existence + // Check header existence if (header == null || getPendingRemovedItem(item) != null) return false; if (header.isHidden()) { if (DEBUG) Log.v(TAG, "Showing header at position " + position + " header=" + header); header.setHidden(false); - if (init) {//Skip notifyItemInserted! - if (position < mItems.size()) { - mItems.add(position, (T) header); - } else { - mItems.add((T) header); - } - return true; - } else { - return addItem(position, (T) header); - } + // Insert header, but skip notifyItemInserted when init=true! + performInsert(position, Collections.singletonList((T) header), !init); + return true; } return false; } @@ -1116,6 +1614,7 @@ private boolean showHeaderOf(int position, @NonNull T item, boolean init) { *Headers can be shown or hidden all together.
* * @see #showAllHeaders() + * @see #setDisplayHeadersAtStartUp(boolean) * @since 5.0.0-b1 */ public void hideAllHeaders() { @@ -1123,20 +1622,20 @@ public void hideAllHeaders() { @Override public void run() { multiRange = true; - //Hide orphan headers first - for (IHeader header : getOrphanHeaders()) { - hideHeader(getGlobalPositionOf(header), header); - } - //Hide linked headers - int position = mItems.size() - 1; - while (position >= 0) { + // Hide linked headers between Scrollable Headers and Footers + int position = getItemCount() - mScrollableFooters.size() - 1; + while (position >= Math.max(0, mScrollableHeaders.size() - 1)) { T item = mItems.get(position); if (isHeader(item)) hideHeader(position, (IHeader) item); position--; } headersShown = false; - setStickyHeaders(false); + // Clear the header currently sticky + if (areHeadersSticky()) { + mStickyHeaderHelper.clearHeaderWithAnimation(); + } + // setStickyHeaders(false); multiRange = false; } }); @@ -1149,9 +1648,9 @@ public void run() { * @since 5.0.0-b1 */ private boolean hideHeaderOf(@NonNull T item) { - //Take the header + // Take the header IHeader header = getHeaderOf(item); - //Check header existence + // Check header existence return header != null && !header.isHidden() && hideHeader(getGlobalPositionOf(header), header); } @@ -1159,7 +1658,7 @@ private boolean hideHeader(int position, IHeader header) { if (position >= 0) { if (DEBUG) Log.v(TAG, "Hiding header at position " + position + " header=" + header); header.setHidden(true); - //Remove and notify removals + // Remove and notify removals mItems.remove(position); notifyItemRemoved(position); return true; @@ -1167,23 +1666,6 @@ private boolean hideHeader(int position, IHeader header) { return false; } - /** - * Helper method to ensure that all current headers are hidden before they are shown again. - *This method is already called inside {@link #showAllHeadersWithReset(boolean)}.
- * This is necessary when {@link #setDisplayHeadersAtStartUp(boolean)} is set true and also - * if an Activity/Fragment has been closed and then reopened. We need to reset hidden status, - * the process is very fast. - * - * @since 5.0.0-b6 - */ - private void resetHiddenStatus() { - for (T item : mItems) { - IHeader header = getHeaderOf(item); - if (header != null && !isExpandable((T) header)) - header.setHidden(true); - } - } - /** * Internal method to link the header to the new item. *Used by the Adapter during the Remove/Restore/Move operations.
@@ -1201,16 +1683,17 @@ private boolean linkHeaderTo(@NonNull T item, @NonNull IHeader header, @Nullable boolean linked = false; if (item != null && item instanceof ISectionable) { ISectionable sectionable = (ISectionable) item; - //Unlink header only if different + // Unlink header only if different if (sectionable.getHeader() != null && !sectionable.getHeader().equals(header)) { unlinkHeaderFrom((T) sectionable, Payload.UNLINK); } if (sectionable.getHeader() == null && header != null) { if (DEBUG) Log.v(TAG, "Link header " + header + " to " + sectionable); + //TODO: try-catch for when sectionable item has a different header class signature, if so, they just can't accept that header! sectionable.setHeader(header); linked = true; removeFromOrphanList(header); - //Notify items + // Notify items if (payload != null) { if (!header.isHidden()) notifyItemChanged(getGlobalPositionOf(header), payload); if (!item.isHidden()) notifyItemChanged(getGlobalPositionOf(item), payload); @@ -1240,7 +1723,7 @@ private IHeader unlinkHeaderFrom(@NonNull T item, @Nullable Object payload) { if (DEBUG) Log.v(TAG, "Unlink header " + header + " from " + sectionable); sectionable.setHeader(null); addToOrphanListIfNeeded(header, getGlobalPositionOf(item), 1); - //Notify items + // Notify items if (payload != null) { if (!header.isHidden()) notifyItemChanged(getGlobalPositionOf(header), payload); if (!item.isHidden()) notifyItemChanged(getGlobalPositionOf(item), payload); @@ -1250,9 +1733,9 @@ private IHeader unlinkHeaderFrom(@NonNull T item, @Nullable Object payload) { return null; } - //TODO: deprecation? + @Deprecated private void addToOrphanListIfNeeded(IHeader header, int positionStart, int itemCount) { - //Check if the header is not already added (happens after un-linkage with un-success linkage) + // Check if the header is not already added (happens after un-linkage with un-success linkage) if (!mOrphanHeaders.contains(header) && !isHeaderShared(header, positionStart, itemCount)) { mOrphanHeaders.add(header); if (DEBUG) @@ -1260,22 +1743,22 @@ private void addToOrphanListIfNeeded(IHeader header, int positionStart, int item } } - //TODO: deprecation? + @Deprecated private void removeFromOrphanList(IHeader header) { if (mOrphanHeaders.remove(header) && DEBUG) Log.v(TAG, "Removed from orphan list [" + mOrphanHeaders.size() + "] Header " + header); } - //TODO: deprecation? + @Deprecated private boolean isHeaderShared(IHeader header, int positionStart, int itemCount) { int firstElementWithHeader = getGlobalPositionOf(header) + 1; - for (int i = firstElementWithHeader; i < mItems.size(); i++) { + for (int i = firstElementWithHeader; i < getItemCount() - mScrollableFooters.size(); i++) { T item = getItem(i); - //Another header is met, we can stop here + // Another header is met, we can stop here if (item instanceof IHeader) break; - //Skip the items under modification + // Skip the items under modification if (i >= positionStart && i < positionStart + itemCount) continue; - //An element with same header is met + // An element with same header is met if (hasSameHeader(item, header)) return true; } @@ -1287,45 +1770,47 @@ private boolean isHeaderShared(IHeader header, int positionStart, int itemCount) /*---------------------*/ /** - * Returns the ViewType for all Items depends by the current position. - *You can override this method to return specific values (don't call super) or you can + * Returns the ViewType for all Items depends by the provided position. + *
You can override this method to return specific values (don't call super) OR you can * let this method to call the implementation of {@code IFlexible#getLayoutRes()} so ViewTypes * are automatically mapped (AutoMap).
* * @param position position for which ViewType is requested - * @return if Item is found, any integer value from user layout resource if defined in + * @return if item is found, any integer value from user layout resource if defined in * {@code IFlexible#getLayoutRes()} * @since 5.0.0-b1 */ @Override public int getItemViewType(int position) { T item = getItem(position); - //Map the view type if not done yet + // Map the view type if not done yet mapViewTypeFrom(item); autoMap = true; return item.getLayoutRes(); } /** - * You can override this method to create ViewHolder from inside the Adapter or you can let + * You can override this method to create ViewHolder from inside the Adapter OR you can let * this method to call the implementation of {@code IFlexible#createViewHolder()} to create - * ViewHolder from inside the Item (AutoMap). + * ViewHolder from inside the item (AutoMap). + *HELP: To know how to implement AutoMap for ViewTypes please refer to the + * FlexibleAdapter Wiki Page + * on GitHub. *
{@inheritDoc} * * @return a new ViewHolder that holds a View of the given view type - * @throws IllegalStateException if {@code IFlexible#createViewHolder()} is not implemented and - * if this method is not overridden OR if ViewType instance has - * not been correctly mapped. + * @throws IllegalStateException if this method is not overridden OR AutoMap is not active + * OR if ViewType instance has not been properly mapped. * @see IFlexible#createViewHolder(FlexibleAdapter, LayoutInflater, ViewGroup) * @since 5.0.0-b1 */ @Override public RecyclerView.ViewHolder onCreateViewHolder(ViewGroup parent, int viewType) { T item = getViewTypeInstance(viewType); - if (item == null) { - //If everything has been set properly, this should never happen ;-) - throw new IllegalStateException("ViewType instance has not been correctly mapped for viewType " - + viewType + " or AutoMap is not active: super() cannot be called."); + if (item == null || !autoMap) { + // If everything has been set properly, this should never happen ;-) + throw new IllegalStateException("ViewType instance not found for viewType " + viewType + + ". Override this method or implement the AutoMap properly."); } if (mInflater == null) { mInflater = LayoutInflater.from(parent.getContext()); @@ -1335,12 +1820,15 @@ public RecyclerView.ViewHolder onCreateViewHolder(ViewGroup parent, int viewType /** * You can override this method to bind the items into the corresponding ViewHolder from - * inside the Adapter or you can let this method to call the implementation of + * inside the Adapter OR you can let this method to call the implementation of * {@code IFlexible#bindViewHolder()} to bind the item inside itself (AutoMap). + *HELP: To know how to implement AutoMap for ViewTypes please refer to the + * FlexibleAdapter Wiki Page + * on GitHub. *
{@inheritDoc} * - * @throws IllegalStateException if {@code IFlexible#bindViewHolder()} is not implemented OR - * if {@code super()} is called when AutoMap is not active. + * @throws IllegalStateException if this method is not overridden OR AutoMap has not been + * properly implemented. * @see IFlexible#bindViewHolder(FlexibleAdapter, RecyclerView.ViewHolder, int, List) * @since 5.0.0-b1 */ @@ -1353,50 +1841,42 @@ public void onBindViewHolder(RecyclerView.ViewHolder holder, int position) { * Same concept of {@code #onBindViewHolder()} but with Payload. * {@inheritDoc} * - * @throws IllegalStateException if {@code IFlexible#bindViewHolder()} is not implemented OR - * if {@code super()} is called when AutoMap is not active. + * @throws IllegalStateException if this method is not overridden OR AutoMap has not been + * properly implemented. * @see IFlexible#bindViewHolder(FlexibleAdapter, RecyclerView.ViewHolder, int, List) * @see #onBindViewHolder(RecyclerView.ViewHolder, int) * @since 5.0.0-b1 */ @Override - public void onBindViewHolder(RecyclerView.ViewHolder holder, int position, List payloads) { + public void onBindViewHolder(final RecyclerView.ViewHolder holder, int position, List payloads) { if (DEBUG) { - Log.v(TAG, "onViewBound Holder=" + holder.getClass().getSimpleName() + - " position=" + position + - " itemId=" + holder.getItemId() + - " layoutPosition=" + holder.getLayoutPosition()); - } - //This check is necessary when using Expandable items, it helps to optimize binding. - // Expandable items can lay out of the screen during the initialization/refresh - // as soon as they are expanded one by one. -// if (holder.getLayoutPosition() > mRecyclerView.getChildCount()) { -// Log.w(TAG, "onViewBound Skip binding for view out of screen " + -// holder.getLayoutPosition() + "/" + mRecyclerView.getChildCount()); -// return; -// } + Log.v(TAG, "onViewBound Holder=" + getClassName(holder) + " position=" + position + + " itemId=" + holder.getItemId() + " layoutPosition=" + holder.getLayoutPosition()); + } if (!autoMap) { - throw new IllegalStateException("AutoMap is not active: super() cannot be called."); - } - //When user scrolls, this line binds the correct selection status - holder.itemView.setActivated(isSelected(position)); - //Bind the correct view elevation - if (holder instanceof FlexibleViewHolder) { - FlexibleViewHolder flexHolder = (FlexibleViewHolder) holder; - float elevation = flexHolder.getActivationElevation(); - if (holder.itemView.isActivated() && elevation > 0) - ViewCompat.setElevation(holder.itemView, elevation); - else if (elevation > 0)//Leave unaltered the default elevation - ViewCompat.setElevation(holder.itemView, 0); - } - //Bind the item + // If everything has been set properly, this should never happen ;-) + throw new IllegalStateException("AutoMap is not active, this method cannot be called." + + " Override this method or implement the AutoMap properly."); + } + // Bind view activation with current selection + super.onBindViewHolder(holder, position, payloads); + // Bind the item T item = getItem(position); if (item != null) { holder.itemView.setEnabled(item.isEnabled()); item.bindViewHolder(this, holder, position, payloads); + // Avoid to show the double background in case header has transparency + // The visibility will be restored when header is reset in StickyHeaderHelper + if (areHeadersSticky() && !isFastScroll && mStickyHeaderHelper.getStickyPosition() >= 0 && payloads.isEmpty()) { + int headerPos = Utils.findFirstVisibleItemPosition(mRecyclerView.getLayoutManager()) - 1; + if (headerPos == position && isHeader(item)) + holder.itemView.setVisibility(View.INVISIBLE); + } } - //Endless Scroll + // Endless Scroll onLoadMore(position); + // Scroll Animation + animateView(holder, position); } /*------------------------*/ @@ -1404,39 +1884,133 @@ else if (elevation > 0)//Leave unaltered the default elevation /*------------------------*/ /** - * Sets the ProgressItem to be displayed at the end of the list and activate the Loading More - * functionality. + * Evaluates if the Adapter is in Endless Scroll mode. When no more load, this method will + * return {@code false}. To enable again the progress item you MUST be set again. + * + * @return true if the progress item is set, false otherwise + * @see #setEndlessProgressItem(IFlexible) + * @since 5.0.0-rc1 + */ + public boolean isEndlessScrollEnabled() { + return endlessScrollEnabled; + } + + /** + * Provides the current endless page if the page size limit is set, if not set the returned + * value is always 1. + * + * @return the current endless page + * @see #getEndlessPageSize() + * @see #setEndlessPageSize(int) + * @since 5.0.0-rc1 + */ + public int getEndlessCurrentPage() { + return Math.max(1, mEndlessPageSize > 0 ? getMainItemCount() / mEndlessPageSize : 0); + } + + /** + * The current setting for the endless page size limit. + *Note: This limit is ignored if value is 0.
+ * + * @return the page size limit, if the limit is not set, 0 is returned. + * @see #getEndlessCurrentPage() + * @see #setEndlessPageSize(int) + * @since 5.0.0-rc1 + */ + public int getEndlessPageSize() { + return mEndlessPageSize; + } + + /** + * Sets the limit to automatically disable the endless feature when coming items size is less + * than the page size. + *When endless feature is disabled a {@link #notifyItemChanged(int, Object)} with payload + * {@link Payload#NO_MORE_LOAD} will be triggered on the progressItem, so you can display a + * message or change the views in this item.
+ * Default value is 0 (limit is ignored). + * + * @param endlessPageSize the size limit for each page + * @return this Adapter, so the call can be chained + * @since 5.0.0-rc1 + */ + public FlexibleAdapter setEndlessPageSize(@IntRange(from = 0) int endlessPageSize) { + mEndlessPageSize = endlessPageSize; + return this; + } + + /** + * The current setting for the endless target item count limit. + *Note: This limit is ignored if value is 0.
+ * + * @return the target items count limit, if the limit is not set, 0 is returned. + * @see #setEndlessTargetCount(int) + * @since 5.0.0-rc1 + */ + public int getEndlessTargetCount() { + return mEndlessTargetCount; + } + + /** + * Sets the limit to automatically disable the endless feature when the total items count in + * the Adapter is equals or bigger than the target count. + *When endless feature is disabled a {@link #notifyItemChanged(int, Object)} with payload + * {@link Payload#NO_MORE_LOAD} will be triggered on the progressItem, so you can display a + * message or change the views in this item.
+ * Default value is 0 (limit is ignored). + * + * @param endlessTargetCount the total items count limit + * @return this Adapter, so the call can be chained + * @see #getEndlessTargetCount() + * @since 5.0.0-rc1 + */ + public FlexibleAdapter setEndlessTargetCount(@IntRange(from = 0) int endlessTargetCount) { + mEndlessTargetCount = endlessTargetCount; + return this; + } + + /** + * Sets the progressItem to be displayed at the end of the list and activate the Loading More + * feature. *Using this method, the {@link EndlessScrollListener} won't be called so that you can * handle a click event to load more items upon a user request.
* To correctly implement "Load more upon a user request" check the Wiki page of this library. * * @param progressItem the item representing the progress bar * @return this Adapter, so the call can be chained + * @see #isEndlessScrollEnabled() * @see #setEndlessScrollListener(EndlessScrollListener, IFlexible) * @since 5.0.0-b8 */ - public FlexibleAdapter setEndlessProgressItem(@NonNull T progressItem) { + public FlexibleAdapter setEndlessProgressItem(@Nullable T progressItem) { + endlessScrollEnabled = progressItem != null; if (progressItem != null) { setEndlessScrollThreshold(mEndlessScrollThreshold); - progressItem.setEnabled(false); mProgressItem = progressItem; + if (DEBUG) { + Log.i(TAG, "Set progressItem=" + getClassName(progressItem)); + Log.i(TAG, "Enabled EndlessScrolling"); + } + } else if (DEBUG) { + Log.i(TAG, "Disabled EndlessScrolling"); } return this; } /** - * Sets the ProgressItem to be displayed at the end of the list and Sets the callback to - * automatically load more items asynchronously (no further user action is needed but the - * scroll). + * Sets the progressItem to be displayed at the end of the list and Sets the callback to + * automatically load more items asynchronously(your duty) (no further user action is needed + * but the scroll). * * @param endlessScrollListener the callback to invoke the asynchronous loading * @param progressItem the item representing the progress bar * @return this Adapter, so the call can be chained + * @see #isEndlessScrollEnabled() * @see #setEndlessProgressItem(IFlexible) * @since 5.0.0-b6 */ public FlexibleAdapter setEndlessScrollListener(@Nullable EndlessScrollListener endlessScrollListener, @NonNull T progressItem) { + if (DEBUG) Log.i(TAG, "Set endlessScrollListener=" + getClassName(endlessScrollListener)); mEndlessScrollListener = endlessScrollListener; return setEndlessProgressItem(progressItem); } @@ -1450,37 +2024,57 @@ public FlexibleAdapter setEndlessScrollListener(@Nullable EndlessScrollListener * @since 5.0.0-b6 */ public FlexibleAdapter setEndlessScrollThreshold(@IntRange(from = 1) int thresholdItems) { - //Increase visible threshold based on number of columns + // Increase visible threshold based on number of columns if (mRecyclerView != null) { - int spanCount = getSpanCount(mRecyclerView.getLayoutManager()); + int spanCount = Utils.getSpanCount(mRecyclerView.getLayoutManager()); thresholdItems = thresholdItems * spanCount; } mEndlessScrollThreshold = thresholdItems; + if (DEBUG) Log.i(TAG, "Set endlessScrollThreshold=" + mEndlessScrollThreshold); return this; } /** * This method is called automatically if METHOD A is implemented. If instead you chose the - * classic way (METHOD B) to bind the items, you have to manually call this method at the end - * of {@code onBindViewHolder()}. + * classic way (METHOD B) to bind the items, you have to manually call this method + * at the end of {@code onBindViewHolder()}. * * @param position the current binding position + * @since 5.0.0-b6 + *When noMoreLoad OR onError OR onCancel, pass empty list or null to hide the - * progressItem.
+ * progressItem. When limits are set, endless feature will be disabled. To enable + * again call {@link #setEndlessProgressItem(IFlexible)}. * Optionally you can pass a delay time to still display the item with the latest information - * inside. The message has to be handled inside the bindViewHolder of the item. + * inside. The message has to be handled inside the {@code bindViewHolder} of the item. + *A {@link #notifyItemChanged(int, Object)} with payload {@link Payload#NO_MORE_LOAD} + * will be triggered on the progressItem, so you can display a message or change the views in + * this item.
* * @param newItems the list of the new items, can be empty or null * @param delay the delay used to remove the progress item or -1 to disable the - * loading forever and to keep the progress item. + * loading forever and to keep the progress item visible. * @since 5.0.0-b8 + *Default value is disabled.
+ * Automatically collapse all previous expanded parents before expand the new clicked parent. + *Default value is {@code false} (disabled).
* * @param collapseOnExpand true to collapse others items, false to just expand the current * @return this Adapter, so the call can be chained * @since 5.0.0-b1 */ public FlexibleAdapter setAutoCollapseOnExpand(boolean collapseOnExpand) { + if (DEBUG) Log.i(TAG, "Set autoCollapseOnExpand=" + collapseOnExpand); this.collapseOnExpand = collapseOnExpand; return this; } /** - * @return true if autoScrollOnExpand is enabled, false otherwise + * @return true if {@code scrollOnExpand} is enabled, false otherwise * @since 5.0.0-b8 */ public boolean isAutoScrollOnExpand() { @@ -1589,15 +2201,16 @@ public boolean isAutoScrollOnExpand() { /** * Automatically scroll the clicked expandable item to the first visible position.This works ONLY in combination with {@link SmoothScrollLinearLayoutManager} or with - * {@link SmoothScrollGridLayoutManager}.
+ *Default value is {@code false} (disabled).
+ * This works ONLY in combination with {@link SmoothScrollLinearLayoutManager} or with + * {@link SmoothScrollGridLayoutManager}. * * @param scrollOnExpand true to enable automatic scroll, false to disable * @return this Adapter, so the call can be chained * @since 5.0.0-b1 */ public FlexibleAdapter setAutoScrollOnExpand(boolean scrollOnExpand) { + if (DEBUG) Log.i(TAG, "Set setAutoScrollOnExpand=" + scrollOnExpand); this.scrollOnExpand = scrollOnExpand; return this; } @@ -1636,23 +2249,24 @@ public boolean isExpandable(@NonNull T item) { } /** - * @return the level of the minium collapsible level used in MultiLevel expandable + * @return the level of the minimum collapsible level used in MultiLevel expandable * @since 5.0.0-b6 */ public int getMinCollapsibleLevel() { - return minCollapsibleLevel; + return mMinCollapsibleLevel; } /** * Sets the minimum level which all sub expandable items will be collapsed too. - *Default value is {@link #minCollapsibleLevel} (All levels including 0).
+ *Default value is {@link #mMinCollapsibleLevel} (All levels including 0).
* * @param minCollapsibleLevel the minimum level to auto-collapse sub expandable items * @return this Adapter, so the call can be chained * @since 5.0.0-b6 */ public FlexibleAdapter setMinCollapsibleLevel(int minCollapsibleLevel) { - this.minCollapsibleLevel = minCollapsibleLevel; + if (DEBUG) Log.i(TAG, "Set minCollapsibleLevel=" + minCollapsibleLevel); + this.mMinCollapsibleLevel = minCollapsibleLevel; return this; } @@ -1669,7 +2283,7 @@ public boolean hasSubItems(@NonNull IExpandable expandable) { } /** - * Retrieves the parent of a child. + * Retrieves the parent of a child for the provided position. *Only for a real child of an expanded parent.
* * @param position the position of the child item @@ -1687,7 +2301,7 @@ public IExpandable getExpandableOf(@IntRange(from = 0) int position) { * @param child the child item * @return the parent of this child item or null if item has no parent * @see #getExpandablePositionOf(IFlexible) - * @see #getRelativePositionOf(IFlexible) + * @see #getSubPositionOf(IFlexible) * @since 5.0.0-b1 */ public IExpandable getExpandableOf(@NonNull T child) { @@ -1714,7 +2328,7 @@ public IExpandable getExpandableOf(@NonNull T child) { * @param child the child item * @return the parent position of this child item or -1 if not found * @see #getExpandableOf(IFlexible) - * @see #getRelativePositionOf(IFlexible) + * @see #getSubPositionOf(IFlexible) * @since 5.0.0-b1 */ public int getExpandablePositionOf(@NonNull T child) { @@ -1722,34 +2336,50 @@ public int getExpandablePositionOf(@NonNull T child) { } /** - * Provides the list where the child currently lays. + * Retrieves the position of a child item in the list where it lays. + *Only for a real child of an expanded parent.
* * @param child the child item - * @return the list of the child element, or a new list if item + * @return the position in the parent or -1 if the child is a parent itself or not found * @see #getExpandableOf(IFlexible) * @see #getExpandablePositionOf(IFlexible) - * @see #getRelativePositionOf(IFlexible) - * @see #getExpandedItems() * @since 5.0.0-b1 + * @deprecated Use {@link #getSubPositionOf(IFlexible)} */ - @NonNull - public ListOnly for a real child of an expanded parent.
+ * + * @param child the child item + * @return the position in the parent or -1 if the child is a parent itself or not found + * @see #getExpandableOf(IFlexible) + * @see #getExpandablePositionOf(IFlexible) + * @since 5.0.0-b1 + */ + public int getSubPositionOf(@NonNull T child) { + return getSiblingsOf(child).indexOf(child); } /** - * Retrieves the position of a child in the list where it lays. - *Only for a real child of an expanded parent.
+ * Provides the full sub list where the child currently lays. * * @param child the child item - * @return the position in the parent or -1 if, child is a parent itself or not found + * @return the list of the child element, or an empty list if the child item has no parent * @see #getExpandableOf(IFlexible) * @see #getExpandablePositionOf(IFlexible) + * @see #getSubPositionOf(IFlexible) + * @see #getExpandedItems() * @since 5.0.0-b1 */ - public int getRelativePositionOf(@NonNull T child) { - return getSiblingsOf(child).indexOf(child); + @NonNull + public ListIf configured, automatic smooth scroll will be performed when necessary.
* * @param position the position of the item to expand @@ -1826,8 +2457,8 @@ public int expand(T item) { * initially expanded. * WARNING! *Multilevel behaviour: all IExpandable subItem, that are expanded, are recursively + * Collapses an {@code IExpandable} item that is already expanded, if no subItem is selected. + *
Multilevel behaviour: all {@code IExpandable} subItem, that are expanded, are recursively * collapsed.
* * @param position the position of the item to collapse @@ -1950,11 +2600,11 @@ public int collapse(@IntRange(from = 0) int position) { if (!isExpandable(item)) return 0; IExpandable expandable = (IExpandable) item; - //Take the current subList (will improve the performance when collapseAll) + // Take the current subList (will improve the performance when collapseAll) ListScrolling animation is automatically preserved, meaning that, notification for animation * is ignored.
@@ -2098,89 +2759,106 @@ public void addItemWithDelay(@IntRange(from = 0) final int position, @NonNull fi mHandler.postDelayed(new Runnable() { @Override public void run() { - setAnimate(true); - if (addItem(position, item) && scrollToPosition && mRecyclerView != null) { - mRecyclerView.smoothScrollToPosition( - Math.min(Math.max(0, position), getItemCount() - 1)); - } - setAnimate(false); + if (addItem(position, item) && scrollToPosition) performScroll(position); } }, delay); } /** - * Inserts the given item in the internal list at the specified position or Adds the item - * at last position. + * Simply append the provided item to the end of the list. + *Convenience method of {@link #addItem(int, IFlexible)} with + * {@code position = getMainItemCount()}.
+ * + * @param item the item to add + * @return true if the internal list was successfully modified, false otherwise + */ + public boolean addItem(@NonNull T item) { + return addItem(getItemCount(), item); + } + + /** + * Inserts the given item at the specified position or Adds the item to the end of the list + * (no matters if the new position is out of bounds!). * - * @param position position of the item to add + * @param position position inside the list, if negative, items will be added to the end * @param item the item to add * @return true if the internal list was successfully modified, false otherwise - * @see #addItemWithDelay(int, IFlexible, long, boolean) + * @see #addItem(IFlexible) * @see #addItems(int, List) * @see #addSubItems(int, int, IExpandable, List, boolean, Object) + * @see #addItemWithDelay(int, IFlexible, long, boolean) * @since 1.0.0 */ public boolean addItem(@IntRange(from = 0) int position, @NonNull T item) { if (item == null) { - Log.e(TAG, "No items to add!"); + Log.e(TAG, "addItem No items to add!"); return false; } if (DEBUG) Log.v(TAG, "addItem delegates addition to addItems!"); - ListNOTE: When all headers are shown, the header (if exists) of this item will be - * shown as well, unless it's already shown, so it will not be shown twice.
+ * Inserts a set of items at specified position or Adds the items to the end of the list + * (no matters if the new position is out of bounds!). + *Note:
+ *
- When all headers are shown, if exists, the header of this item will be shown as well,
+ * unless it's already shown, so it won't be shown twice.
+ *
- Items will be always added between any scrollable header and footers.
In order to add subItems, the following condition must be satisfied:
*
- The item resulting from the parent position is actually an {@link IExpandable}.
The new section is a {@link IHeader} item and the position is calculated after sorting
- * the Data Set.
- *
- To add Sections to the top, set null the Comparator object or simply call
+ * Adds and shows an empty section. The new section is a {@link IHeader} item and the
+ * position is calculated after sorting the data set.
+ *
- To add Sections to the top, set null the Comparator object or simply call
* {@link #addSection(IHeader)};
*
- To add Sections to the bottom or in the middle, implement a Comparator
* object able to support all the item types this Adapter is displaying or a
- * ClassCastException will be raised.
+ * ClassCastException will be raised.
Note:- This method is opposite of {@link #removeItemsOfType(Integer...)}.
+ *
+ * @param viewTypes the viewTypes to retain
+ * @see #clear()
+ * @see #removeItems(List)
+ * @see #removeItemsOfType(Integer...)
+ * @since 5.0.0-rc1
+ */
+ public void clearAllBut(Integer... viewTypes) {
+ List Scrolling animation is automatically preserved, meaning that notification for animation
* is ignored. Every item is retained for an eventual Undo. This method delegates the removal to removeRange. Note:
+ * If the item, resulting from the passed position: If the item, resulting from the provided position: Parent will not be notified about the change, if a child is removed. Parent will not be notified about the change if a child is removed.
- * Optionally the Parent can be notified about the change, if a child is removed, by passing
- * any payload.
+ * Convenience method to remove all items that are currently selected.
+ * Optionally, the parent item can be notified about the change if a child is removed,
+ * by providing any non-null payload. NOTE: If filter is active, only items that match that filter will be shown(restored). Note: If filter is active, only items that match that filter will be shown(restored). Note: This method is automatically called after timer is over and after a
* restoration. Note: text is always trimmed and to lowercase. If the items have highlighted text, those items must be refreshed in order to change the
* text back to normal. This happens systematically when searchText is reduced in length by
* the user. Default value is {@code false}. This method filters the provided list with the search text previously set with
+ * This method filters the provided list with the searchText previously set with
* {@link #setSearchText(String)}. NOTE:
+ * Note:
* Default value is {@value mAnimateToLimit} items, number new items. Default value is {@value ANIMATE_TO_LIMIT} items, number new items. A time, to compare the 2 different approaches, is calculated and displayed in the log.
+ * To see the logs call {@link #enableLogs(boolean)} before creating the Adapter instance! Used by filter and updateDataSet. Note: In case the animations are performed, unchanged items will be notified if
- * {@code notifyChangeOfUnfilteredItems} is set true, and payload will be set as a Boolean. If called, Helper will be reinitialized.
@@ -3536,6 +4413,7 @@ public final ItemTouchHelperCallback getItemTouchHelperCallback() {
*
* @return true if ItemTouchHelper should start dragging an item when it is long pressed,
* false otherwise. Default value is {@code false}.
+ * @see #setLongPressDragEnabled(boolean)
* @since 5.0.0-b1
*/
public final boolean isLongPressDragEnabled() {
@@ -3543,8 +4421,8 @@ public final boolean isLongPressDragEnabled() {
}
/**
- * Enable the Drag on LongPress on the entire ViewHolder.
- * NOTE: This will skip LongClick on the view in order to handle the LongPress,
+ * Enable / Disable the Drag on LongPress on the entire ViewHolder.
+ * Note: This will skip LongClick on the view in order to handle the LongPress,
* however the LongClick listener will be called if necessary in the new
* {@link FlexibleViewHolder#onActionStateChanged(int, int)}. To use, it is sufficient to set the HandleView by calling
- * {@link FlexibleViewHolder#setDragHandleView(View)}. Default value is {@code false}. Default value is {@code false}. Note: Having any Scrollable Headers/Footers visible, the {@code size}
+ * will represents only the main items. Due to Java Generic, it's too complicated and not
- * well manageable if we pass the List<T> object. Delegates the click event to the listener and checks if selection MODE if
- * SINGLE or MULTI is enabled in order to activate the ItemView. This method receives the click event generated from the itemView to check if one
+ * of the selection mode ({@code SINGLE or MULTI}) is enabled in order to activate the
+ * itemView. This method always calls
- * {@link FlexibleViewHolder#toggleActivation}
- * after listener event is consumed in order to activate the ItemView. This method always calls {@link FlexibleViewHolder#toggleActivation()}
+ * after the listener event is consumed in order to activate the itemView. Override this method to receive touch events with its state. This method is called if any limit is reached (targetCount or pageSize
+ * must be set) AND if new data is temporary unavailable (ex. no connection or no
+ * new updates remotely). If no new data, a {@link FlexibleAdapter#notifyItemChanged(int, Object)}
+ * with a payload {@link Payload#NO_MORE_LOAD} is triggered on the progressItem. Use {@code lastPosition} and {@code currentPage} to know what to load next. You can use and override this Callback, current values used by the Adapter: Note: numbers 0-9 are reserved for the Adapter, use others. - {@code protected List
+ * For example, if your items have unique ids, this method should check their id equality.
+ *
+ * @param oldItemPosition The position of the item in the old list
+ * @param newItemPosition The position of the item in the new list
+ * @return True if the two items represent the same object or false if they are different.
+ */
+ @Override
+ public boolean areItemsTheSame(int oldItemPosition, int newItemPosition) {
+ T oldItem = oldItems.get(oldItemPosition);
+ T newItem = newItems.get(newItemPosition);
+ return oldItem.equals(newItem);
+ }
+
+ /**
+ * Called by the DiffUtil when it wants to check whether two items have the same data.
+ * DiffUtil uses this information to detect if the contents of an item has changed.
+ *
+ * DiffUtil uses this method to check equality instead of {@link Object#equals(Object)}
+ * so that you can change its behavior depending on your UI.
+ * For example, if you are using DiffUtil with a
+ * {@link RecyclerView.Adapter RecyclerView.Adapter}, you should
+ * return whether the items' visual representations are the same.
+ *
+ * This method is called only if {@link #areItemsTheSame(int, int)} returns
+ * {@code true} for these items.
+ *
+ * @param oldItemPosition The position of the item in the old list
+ * @param newItemPosition The position of the item in the new list which replaces the
+ * oldItem
+ * @return True if the contents of the items are the same or false if they are different.
+ */
+ @Override
+ public boolean areContentsTheSame(int oldItemPosition, int newItemPosition) {
+ return false;
+ }
+
+ /**
+ * When {@link #areItemsTheSame(int, int)} returns {@code true} for two items and
+ * {@link #areContentsTheSame(int, int)} returns false for them, DiffUtil
+ * calls this method to get a payload about the change.
+ *
+ * For example, if you are using DiffUtil with {@link RecyclerView}, you can return the
+ * particular field that changed in the item and your
+ * {@link android.support.v7.widget.RecyclerView.ItemAnimator ItemAnimator} can use that
+ * information to run the correct animation.
+ *
+ * Default implementation returns {@code null}.
+ *
+ * @param oldItemPosition The position of the item in the old list
+ * @param newItemPosition The position of the item in the new list
+ * @return A payload object that represents the change between the two items.
+ */
+ @Nullable
+ @Override
+ public Object getChangePayload(int oldItemPosition, int newItemPosition) {
+ return Payload.CHANGE;
+ }
}
}
\ No newline at end of file
diff --git a/flexible-adapter/src/main/java/eu/davidea/flexibleadapter/Payload.java b/flexible-adapter/src/main/java/eu/davidea/flexibleadapter/Payload.java
index 058d5e6e..feef4913 100644
--- a/flexible-adapter/src/main/java/eu/davidea/flexibleadapter/Payload.java
+++ b/flexible-adapter/src/main/java/eu/davidea/flexibleadapter/Payload.java
@@ -17,8 +17,8 @@
/**
* Payload occurs only for {@code notifyItemChanged()}.
- * The value of this enumeration will be passed to the bind method to optimize the view binding
- * in order to update only the inner views interested for the change. The value of this enumeration will be provided to the bind method to optimize the view
+ * binding in order to update only the inner views interested for the change. Used to know if user is fast scrolling. Used when user click on selectAll action button in ActionMode. All Layouts are supported. IMPORTANT: To be called with delay in {@code holder.itemView.postDelayed()}. To call once! Then call {@link #getSelectedPositions()}. To be called in the onUndo method after the restoration is done or in the
- * onRestoreInstanceState. To be called in the {@code onUndo} method after the restoration is done or at the end
+ * of {@code onRestoreInstanceState}. Default value is {@code false}. Default value is {@code false}. Only from version 5.0.0-b8, by calling this constructor,
- * {@link FlexibleAdapter#setPermanentDelete(boolean)} is set {@code false} automatically.
+ * By calling this constructor, {@link FlexibleAdapter#setPermanentDelete(boolean)}
+ * is set {@code false} automatically.
*
* @param adapter the instance of {@code FlexibleAdapter}
* @param undoListener the callback for the Undo and Delete confirmation
@@ -107,15 +111,26 @@ public UndoHelper withAction(@Action int action, @NonNull OnActionListener actio
return this;
}
+ /**
+ * Sets the text color of the action.
+ *
+ * @param color the color for the action button
+ * @return this object, so it can be chained
+ */
+ public UndoHelper withActionTextColor(@ColorInt int color) {
+ this.mActionTextColor = color;
+ return this;
+ }
+
/**
* As {@link #remove(List, View, CharSequence, CharSequence, int)} but with String
* resources instead of CharSequence.
*/
- public Snackbar remove(List Due to Java Generic, it's too complicated and not well manageable if we pass the
* List<T> object. Adapter needs this method to distinguish them and pick up correct items. Basic Java implementation:
* NOTE: Should identify a resource Layout reference {@link android.R.layout} used
- * by FlexibleAdapter to auto-map the ViewTypes. HELP: To know how to implement auto-map for ViewTypes please refer to the
- * FlexibleAdapter WikiPage
+ * Delegates the creation of the ViewHolder to the user if AutoMap has been implemented.
+ * HELP: To know how to implement AutoMap for ViewTypes please refer to the
+ * FlexibleAdapter Wiki Page
* on GitHub. HELP: To know how to implement auto-map for ViewTypes please refer to the
- * FlexibleAdapter WikiPage
+ * Binds the data of this item to the given Layout if AutoMap has been implemented.
+ * HELP: To know how to implement AutoMap for ViewTypes please refer to the
+ * FlexibleAdapter Wiki Page
* on GitHub. Internally calls {@link #fetchAccentColor(Context, int)}. Internally calls {@link #fetchAccentColor(Context, int)}. All Layouts are supported. This class extends {@link FlexibleViewHolder}, which means it will benefit of all implemented
- * methods the super class holds. This class extends {@link FlexibleViewHolder}, which means it will benefit of all
+ * implemented methods the super class holds. This method returns always true; Extend with "return false" to Not expand or collapse
* this ItemView onClick events. This method returns always false; Override with {@code "return true"} to trigger the
+ * notification. If {@link #shouldNotifyParentOnClick()} returns {@code true}, this view is rebound
+ * with payload {@link Payload#EXPANDED}. If {@link #shouldNotifyParentOnClick()} returns {@code true}, this view is rebound
+ * with payload {@link Payload#COLLAPSED}. Note: In Expandable version, it tries to expand, but before,
* it checks if the view {@link #isViewExpandableOnClick()}. Note: In Expandable version, it tries to collapse, but before,
* it checks if the view {@link #isViewCollapsibleOnLongClick()}. Note: In the Expandable version, expanded items are forced to collapse. IMPORTANT NOTE! the change of the background is visible if you added
- * android:background="?attr/selectableItemBackground" on the item layout AND
- * in the style.xml. This must be called every time we want the activation state visible on the ItemView,
- * for instance, after a Click (to add the item to the selection list) or after a LongClick
- * (to activate the ActionMode) or during a Drag (to show that we enabled the Drag). IMPORTANT NOTE! the selected background is visible if you added
+ * {@code android:background="?attr/selectableItemBackground"} on the item layout AND
+ * customized the file {@code style.xml}. Note: This method must be called every time we want the activation state visible
+ * on the itemView, for instance: after a Click (to add the item to the selection list) or
+ * after a LongClick (to activate the ActionMode) or during dragging (to show that we enabled
+ * the Drag). Override to return desired value of elevation on this itemView. This method returns always false; Extend with "return true" to Not expand or collapse
- * this ItemView onClick events. This method returns always false; Override with {@code "return true"} to Not expand or
+ * collapse this itemView onClick events. This method returns always false; Extend with "return true" to add item to the ActionMode
- * count. This method returns always false;Override with {@code "return true"} to add the item
+ * to the ActionMode count. Implement your logic for different animators based on position, selection and/or
* direction. In this implementations, View activation is automatically handled in case of Drag:
- * The Item will be added to the selection list if not selected yet and mode MULTI is activated. In this implementation, View activation is automatically handled if dragged: The Item
+ * will be added to the selection list if not selected yet and mode MULTI is activated.
- This method is opposite of {@link #clearAllBut(Integer...)}.
+ *
- View types of Scrollable Headers and Footers are ignored!
* - is not expandable with a parent, it is removed only if the parent is expanded.
* - is expandable implementing {@link IExpandable}, it is removed as usual, but
@@ -2635,12 +3367,13 @@ public void removeRange(@IntRange(from = 0) int positionStart,
* @param payload any non-null user object to notify the parent (the payload will be
* therefore passed to the bind method of the parent ViewHolder),
* pass null to not notify the parent
+ * @see #clear()
+ * @see #clearAllBut(Integer...)
* @see #removeItem(int, Object)
* @see #removeItems(List, Object)
* @see #removeRange(int, int)
* @see #removeAllSelectedItems(Object)
* @see #setPermanentDelete(boolean)
- * @see #setRemoveOrphanHeaders(boolean)
* @see #setRestoreSelectionOnUndo(boolean)
* @see #getDeletedItems()
* @see #getDeletedChildren(IExpandable)
@@ -2649,6 +3382,7 @@ public void removeRange(@IntRange(from = 0) int positionStart,
* @see #emptyBin()
* @since 5.0.0-b1
*/
+ //FIXME: Fix payload message if customized
public void removeRange(@IntRange(from = 0) int positionStart,
@IntRange(from = 0) int itemCount, @Nullable Object payload) {
int initialCount = getItemCount();
@@ -2659,11 +3393,12 @@ public void removeRange(@IntRange(from = 0) int positionStart,
return;
}
- //Handle header linkage
- IHeader header = getHeaderOf(getItem(positionStart));
+ // Update content of the header linked to first item of the range
+ T item = getItem(positionStart);
+ IHeader header = getHeaderOf(item);
int headerPosition = getGlobalPositionOf(header);
if (header != null && headerPosition >= 0) {
- //The header does not represents a group anymore, add it to the Orphan list
+ // The header does not represents a group anymore, add it to the Orphan list
addToOrphanListIfNeeded(header, positionStart, itemCount);
notifyItemChanged(headerPosition, payload);
}
@@ -2671,7 +3406,7 @@ public void removeRange(@IntRange(from = 0) int positionStart,
int parentPosition = -1;
IExpandable parent = null;
for (int position = positionStart; position < positionStart + itemCount; position++) {
- T item = getItem(positionStart);
+ item = getItem(positionStart);
if (!permanentDelete) {
//When removing a range of children, parent is always the same :-)
if (parent == null) parent = getExpandableOf(item);
@@ -2682,37 +3417,33 @@ public void removeRange(@IntRange(from = 0) int positionStart,
parentPosition = createRestoreSubItemInfo(parent, item, Payload.UNDO);
}
}
- //Change to hidden status for section headers
+ // Change to hidden status for section headers
if (isHeader(item)) {
header = (IHeader) item;
header.setHidden(true);
- }
- //If item is a Header, remove linkage from ALL Sectionable items if exist
- if (unlinkOnRemoveHeader && isHeader(item)) {
- List
5.0.0-b8 Synchronization animations limit + AsyncFilter
@@ -3136,28 +3877,33 @@ public void filterItems(@NonNull List
+ *
*
* @param unfilteredItems the list to filter
* @see #filterObject(IFlexible, String)
+ * @see #onPostFilter()
* @see #setAnimateToLimit(int)
* @since 4.1.0 Created
*
5.0.0-b1 Expandable + Child filtering
*
5.0.0-b8 Synchronization animations limit + AsyncFilter
+ *
5.0.0-rc1 Scrollable Headers and Footers adaptation
*/
public void filterItems(@NonNull List
- The item will be collected if the implemented method returns true.
*
- {@code IExpandable} items are automatically picked up and displayed if at least a
* child is collected by the current filter. You DON'T NEED to implement the scan for the
@@ -3285,11 +4033,7 @@ private boolean filterExpandableObject(T item) {
*
5.0.0-b1 Expandable + Child filtering
*/
protected boolean filterObject(T item, String constraint) {
- if (item instanceof IFilterable) {
- IFilterable filterable = (IFilterable) item;
- return filterable.filter(constraint);
- }
- return false;
+ return item instanceof IFilterable && ((IFilterable) item).filter(constraint);
}
/**
@@ -3299,7 +4043,7 @@ private int addFilteredSubItems(List
5.0.0-b8 Synchronization animation limit
*/
- private synchronized void animateTo(@Nullable List
- * To get deleted items, use {@link #getDeletedItems()} from the
+ * well manageable if we pass the List<T> object.
+ * To get deleted items, use {@link FlexibleAdapter#getDeletedItems()} from the
* implementation of this method.
5.0.0-rc1 added {@code lastPosition} and {@code currentPage} as parameters
*/
- void onLoadMore();
+ void onLoadMore(int lastPosition, int currentPage);
}
/**
@@ -4206,8 +5136,8 @@ public interface EndlessScrollListener {
private class AdapterDataObserver extends RecyclerView.AdapterDataObserver {
private void adjustPositions(int positionStart, int itemCount) {
- if (!filtering) {//Filtering has multiple insert and removal, we skip this process
- if (adjustSelected)//Don't, if remove range / restore
+ if (!filtering) { //Filtering has multiple insert and removal, we skip this process
+ if (adjustSelected) //Don't, if remove range / restore
adjustSelected(positionStart, itemCount);
adjustSelected = true;
}
@@ -4263,7 +5193,7 @@ public RestoreInfo(T refItem, T item, Object payload) {
}
public RestoreInfo(T refItem, T item, int relativePosition, Object payload) {
- this.refItem = refItem;//This can be an Expandable or a Header
+ this.refItem = refItem; //This can be an Expandable or a Header
this.item = item;
this.relativePosition = relativePosition;
this.payload = payload;
@@ -4278,7 +5208,7 @@ public int getRestorePosition(boolean isChild) {
}
T item = getItem(refPosition);
if (isChild && isExpandable(item)) {
- //Assert the expandable children are collapsed
+ // Assert the expandable children are collapsed
recursiveCollapse(refPosition, getCurrentChildren((IExpandable) item), 0);
} else if (isExpanded(item) && !isChild) {
refPosition += getExpandableList((IExpandable) item).size() + 1;
@@ -4344,10 +5274,12 @@ protected void onPreExecute() {
@Override
protected Void doInBackground(Void... params) {
+ start = System.currentTimeMillis();
switch (what) {
case UPDATE:
if (DEBUG) Log.d(TAG, "doInBackground - started UPDATE");
- animateTo(newItems);
+ animateDiff(newItems, Payload.CHANGE);
+ //animateTo(newItems, Payload.CHANGE);
if (DEBUG) Log.d(TAG, "doInBackground - ended UPDATE");
break;
case FILTER:
@@ -4361,51 +5293,211 @@ protected Void doInBackground(Void... params) {
@Override
protected void onPostExecute(Void result) {
- //Notify all the changes
- executeNotifications();
- //Execute post data
- switch (what) {
- case UPDATE:
- postUpdate(false);
- break;
- case FILTER:
- postFilter();
- break;
+ if (diffResult != null || mNotifications != null) {
+ //Execute post data
+ switch (what) {
+ case UPDATE:
+ // Notify all the changes
+ executeNotifications(Payload.CHANGE);
+ postUpdate(false);
+ break;
+ case FILTER:
+ // Notify all the changes
+ executeNotifications(Payload.FILTER);
+ postFilter();
+ break;
+ }
}
mFilterAsyncTask = null;
}
}
/**
- * @param init true to skip all notifications and instant reset by calling notifyDataSetChanged
+ * @param init true to skip all notifications and instant refresh the list by calling
+ * {@link #notifyDataSetChanged()}
*/
private void postUpdate(boolean init) {
- //Show headers and expanded items if Data Set not empty
+ // Show headers and expanded items if Data Set not empty
if (getItemCount() > 0) {
expandItemsAtStartUp();
if (headersShown) {
showAllHeadersWithReset(init);
}
}
- //Execute instant reset on init
+ // Execute instant reset on init
if (init) {
- if (DEBUG) Log.w(TAG, "notifyDataSetChanged!");
+ if (DEBUG) Log.w(TAG, "updateDataSet with notifyDataSetChanged!");
notifyDataSetChanged();
}
- //Update empty view
+ // Perform user code
+ onPostUpdate();
+ // Update empty view
if (mUpdateListener != null) {
- mUpdateListener.onUpdateEmptyView(getItemCount());
+ mUpdateListener.onUpdateEmptyView(getMainItemCount());
}
}
+ /**
+ * This method is called after the execution of Async Update and before the call to the
+ * {@link OnUpdateListener#onUpdateEmptyView(int)}.
+ *
+ * @see #updateDataSet(List, boolean)
+ */
+ protected void onPostUpdate() {
+ // Dedicated for user implementation
+ }
+
private void postFilter() {
- //Restore headers if necessary
+ // Restore headers if necessary
if (headersShown && !hasSearchText()) {
showAllHeadersWithReset(false);
}
- //Call listener to update EmptyView, assuming the filter always made a change
+ // Perform user code
+ onPostFilter();
+ // Call listener to update EmptyView, assuming the filter always made a change
if (mUpdateListener != null)
- mUpdateListener.onUpdateEmptyView(getItemCount());
+ mUpdateListener.onUpdateEmptyView(getMainItemCount());
+ }
+
+ /**
+ * This method is called after the execution of Async Filter and before the call to the
+ * {@link OnUpdateListener#onUpdateEmptyView(int)}.
+ *
+ * @see #filterItems(List)
+ */
+ protected void onPostFilter() {
+ // Dedicated for user implementation
+ }
+
+ /**
+ * Handler callback for delayed actions.
+ *
1 = async call for filterItems, optionally delayed.
+ *
2 = deleteConfirmed when Undo timeout is over.
+ *
8 = hide the progress item from the list, optionally delayed.
+ *
- {@code protected List
@@ -180,10 +174,11 @@ public static int getSpanCount(RecyclerView.LayoutManager layoutManager) {
* @since 2.0.0
*/
public void setMode(@Mode int mode) {
+ if (DEBUG) Log.i(TAG, Utils.getModeName(mode) + " enabled");
if (mMode == MODE_SINGLE && mode == MODE_IDLE)
clearSelection();
this.mMode = mode;
- mLastItemInActionMode = (mode == MODE_IDLE);
+ this.mLastItemInActionMode = (mode != MODE_MULTI);
}
/**
@@ -205,26 +200,37 @@ public int getMode() {
* @since 5.0.0-b1
*/
public boolean isSelectAll() {
+ // Reset the flags with delay
+ resetActionModeFlags();
return mSelectAll;
}
/**
- * @return true if user returns to {@link #MODE_IDLE} and no selection is active, false otherwise
+ * @return true if user returns to {@link #MODE_IDLE} or {@link #MODE_SINGLE} and no
+ * selection is active, false otherwise
* @since 5.0.0-b1
*/
public boolean isLastItemInActionMode() {
+ // Reset the flags with delay
+ resetActionModeFlags();
return mLastItemInActionMode;
}
/**
- * Reset to false the ActionMode flags: {@code SelectAll} and {@code LastItemInActionMode}.
- *
true.
* When this is the case:
*
- *
*/
@Override
diff --git a/flexible-adapter/src/main/java/eu/davidea/flexibleadapter/helpers/ActionModeHelper.java b/flexible-adapter/src/main/java/eu/davidea/flexibleadapter/helpers/ActionModeHelper.java
index df11e797..83a75fa0 100644
--- a/flexible-adapter/src/main/java/eu/davidea/flexibleadapter/helpers/ActionModeHelper.java
+++ b/flexible-adapter/src/main/java/eu/davidea/flexibleadapter/helpers/ActionModeHelper.java
@@ -25,6 +25,8 @@
import android.view.Menu;
import android.view.MenuItem;
+import java.util.List;
+
import eu.davidea.flexibleadapter.FlexibleAdapter;
import eu.davidea.flexibleadapter.SelectableAdapter;
import eu.davidea.flexibleadapter.SelectableAdapter.Mode;
@@ -99,6 +101,21 @@ public ActionMode getActionMode() {
return mActionMode;
}
+ /**
+ * Gets the activated position only when mode is {@code MODE_SINGLE}.
+ *
+ * @return the activated position when {@code MODE_SINGLE}. -1 if no item is selected
+ * @since 5.0.0-rc1
+ */
+ public int getActivatedPosition() {
+ List
- * To get deleted items, use {@link FlexibleAdapter#getDeletedItems()} from the
+ * So, to get deleted items, use {@link FlexibleAdapter#getDeletedItems()} from the
* implementation of this method.
diff --git a/flexible-adapter/src/main/java/eu/davidea/flexibleadapter/items/IFlexible.java b/flexible-adapter/src/main/java/eu/davidea/flexibleadapter/items/IFlexible.java
index ebe9561d..4ebe0616 100644
--- a/flexible-adapter/src/main/java/eu/davidea/flexibleadapter/items/IFlexible.java
+++ b/flexible-adapter/src/main/java/eu/davidea/flexibleadapter/items/IFlexible.java
@@ -107,11 +107,11 @@ public interface IFlexible
5.0.0-rc1 Now returns the real color (not the resourceId)
+ */
+ @ColorInt
public static int getColorControlHighlight(Context context) {
TypedValue outValue = new TypedValue();
- //it is important here to not use the android.R because this wouldn't add the latest drawable
+ // It's important to not use the android.R because this wouldn't add the overridden drawable
context.getTheme().resolveAttribute(R.attr.colorControlHighlight, outValue, true);
- return outValue.resourceId;
+ if (Utils.hasMarshmallow()) return context.getColor(outValue.resourceId);
+ else return context.getResources().getColor(outValue.resourceId);
}
/**
* Helper to get a custom selectable background with Ripple if device has at least Lollipop.
*
- * @param rippleColor the color of the ripple
* @param normalColor the color in normal state
* @param pressedColor the pressed color
+ * @param rippleColor the color of the ripple
* @return the RippleDrawable with StateListDrawable if at least Lollipop, the normal
* StateListDrawable otherwise
- * @since 5.0.0-b7
+ * @since 5.0.0-b7 Created
+ *
5.0.0-rc1 RippleColor becomes the 3rd parameter
*/
- public static Drawable getSelectableBackgroundCompat(@ColorInt int rippleColor,
- @ColorInt int normalColor,
- @ColorInt int pressedColor) {
+ public static Drawable getSelectableBackgroundCompat(@ColorInt int normalColor,
+ @ColorInt int pressedColor,
+ @ColorInt int rippleColor) {
if (Utils.hasLollipop()) {
return new RippleDrawable(ColorStateList.valueOf(rippleColor),
- getStateListDrawable(normalColor, pressedColor, true),
+ getStateListDrawable(normalColor, pressedColor),
getRippleMask(normalColor));
} else {
- return getStateListDrawable(normalColor, pressedColor, false);
+ return getStateListDrawable(normalColor, pressedColor);
+ }
+ }
+
+ /**
+ * Adds a ripple effect to any background.
+ *
+ * @param drawable any background drawable
+ * @param rippleColor the color of the ripple
+ * @return the RippleDrawable with the chosen background drawable if at least Lollipop,
+ * the provided drawable otherwise
+ * @since 5.0.0-rc1
+ */
+ public static Drawable getRippleDrawable(Drawable drawable, @ColorInt int rippleColor) {
+ if (Utils.hasLollipop()) {
+ return new RippleDrawable(ColorStateList.valueOf(rippleColor),
+ drawable, getRippleMask(Color.BLACK));
+ } else {
+ return drawable;
}
}
private static Drawable getRippleMask(@ColorInt int color) {
float[] outerRadii = new float[8];
- //3 is the radius of final ripple, instead of 3 we can give required final radius
+ // 3 is the radius of final ripple, instead of 3 we can give required final radius
Arrays.fill(outerRadii, 3);
RoundRectShape r = new RoundRectShape(outerRadii, null, null);
ShapeDrawable shapeDrawable = new ShapeDrawable(r);
@@ -149,15 +211,13 @@ private static Drawable getRippleMask(@ColorInt int color) {
}
private static StateListDrawable getStateListDrawable(@ColorInt int normalColor,
- @ColorInt int pressedColor,
- boolean withRipple) {
+ @ColorInt int pressedColor) {
StateListDrawable states = new StateListDrawable();
- if (!withRipple)
- states.addState(new int[]{android.R.attr.state_pressed}, getColorDrawable(pressedColor));
states.addState(new int[]{android.R.attr.state_activated}, getColorDrawable(pressedColor));
states.addState(new int[]{}, getColorDrawable(normalColor));
- //if possible we enable animating across states
- if (!withRipple) {
+ // Animating across states.
+ // It seems item background is lost on scrolling out of the screen, 21 <= API <= 23
+ if (!Utils.hasLollipop() || Utils.hasNougat()) {
int duration = 200; //android.R.integer.config_shortAnimTime
states.setEnterFadeDuration(duration);
states.setExitFadeDuration(duration);
@@ -165,7 +225,14 @@ private static StateListDrawable getStateListDrawable(@ColorInt int normalColor,
return states;
}
- private static ColorDrawable getColorDrawable(@ColorInt int color) {
+ /**
+ * Generate the {@code ColorDrawable} object from the provided Color.
+ *
+ * @param color the color
+ * @return the {@code ColorDrawable} object
+ * @since 5.0.0-rc1
+ */
+ public static ColorDrawable getColorDrawable(@ColorInt int color) {
return new ColorDrawable(color);
}
diff --git a/flexible-adapter/src/main/java/eu/davidea/flexibleadapter/utils/Utils.java b/flexible-adapter/src/main/java/eu/davidea/flexibleadapter/utils/Utils.java
index 5af4c249..05f12c51 100644
--- a/flexible-adapter/src/main/java/eu/davidea/flexibleadapter/utils/Utils.java
+++ b/flexible-adapter/src/main/java/eu/davidea/flexibleadapter/utils/Utils.java
@@ -15,7 +15,7 @@
*/
package eu.davidea.flexibleadapter.utils;
-import android.annotation.TargetApi;
+import android.annotation.SuppressLint;
import android.app.Activity;
import android.content.Context;
import android.content.ContextWrapper;
@@ -25,6 +25,8 @@
import android.os.Build.VERSION_CODES;
import android.support.annotation.ColorInt;
import android.support.annotation.NonNull;
+import android.support.annotation.Nullable;
+import android.support.v7.widget.GridLayoutManager;
import android.support.v7.widget.LinearLayoutManager;
import android.support.v7.widget.OrientationHelper;
import android.support.v7.widget.RecyclerView;
@@ -36,6 +38,9 @@
import java.util.Locale;
+import eu.davidea.flexibleadapter.R;
+import eu.davidea.flexibleadapter.SelectableAdapter;
+
/**
* @author Davide Steduto
* @since 27/01/2016 Created
@@ -45,6 +50,22 @@ public final class Utils {
public static final int INVALID_COLOR = -1;
public static int colorAccent = INVALID_COLOR;
+ /**
+ * API 24
+ * @see VERSION_CODES#N
+ */
+ public static boolean hasNougat() {
+ return Build.VERSION.SDK_INT >= VERSION_CODES.N;
+ }
+
+ /**
+ * API 23
+ * @see VERSION_CODES#M
+ */
+ public static boolean hasMarshmallow() {
+ return Build.VERSION.SDK_INT >= VERSION_CODES.M;
+ }
+
/**
* API 21
*
@@ -63,6 +84,30 @@ public static boolean hasJellyBean() {
return Build.VERSION.SDK_INT >= VERSION_CODES.JELLY_BEAN;
}
+ /**
+ * @return the string representation of the provided {@link eu.davidea.flexibleadapter.SelectableAdapter.Mode}
+ * @since 5.0.0-rc1
+ */
+ @SuppressLint("SwitchIntDef")
+ public static String getModeName(@SelectableAdapter.Mode int mode) {
+ switch (mode) {
+ case SelectableAdapter.MODE_SINGLE:
+ return "MODE_SINGLE";
+ case SelectableAdapter.MODE_MULTI:
+ return "MODE_MULTI";
+ default:
+ return "MODE_IDLE";
+ }
+ }
+
+ /**
+ * @return the SimpleClassName of the provided object
+ * @since 5.0.0-rc1
+ */
+ public static String getClassName(@NonNull Object o) {
+ return o.getClass().getSimpleName();
+ }
+
/**
* Sets a spannable text with the accent color (if available) into the provided TextView.
*
- * Adapter must have a reference to its instance to check selection state.