NavigationViewFragmentAdapters


Source link: https://github.com/patloew/NavigationViewFragmentAdapters

NavigationViewFragmentAdapters

A small library containing two adapters which allow for easy fragment management with a NavigationView or BottomNavigationView.

The library handles replacing the fragments and saving/restoring the fragment state, including showing the right fragment when opening an app again after it was killed.

Usage

First, decide which adapter suits your use case better.

The NavigationViewFragmentAdapter detaches fragments after another menu item is selected. This means that each Fragment for a menu item is kept in memory, but there is no overhead for recreating when it is attached again.

The NavigationViewStateFragmentAdapter saves the state and removes the fragment after another menu item is selected. This means that only the fragment for the current menu item is kept in memory, but there is overhead for recreating other fragments when they are selected again.

After you decided, create your adapter implementation:

private class MyNavigationViewAdapter extends NavigationViewFragmentAdapter {

public MyNavigationViewAdapter(FragmentManager fragmentManager, @IdRes int containerId, @IdRes int defaultMenuItemId, Bundle savedInstanceState) {

super(fragmentManager, containerId, defaultMenuItemId, savedInstanceState);

  
}

@NonNull
  @Override
  public Fragment getFragment(@IdRes int menuItemId) {

switch (menuItemId) {

 case R.id.navitem_1:

  return SampleFragment.newInstance("Fragment 1");

 case R.id.navitem_2:

  return SampleFragment.newInstance("Fragment 2");

 case R.id.navitem_3:

  return SampleFragment.newInstance("Fragment 3");

 default:

  return SettingsFragment.newInstance();

}

  
}
 
}
 

Now, create an instance and attach it to your NavigationView in your Activity onCreate():

adapter = new MyNavigationViewAdapter(getSupportFragmentManager(), R.id.container, R.id.navitem_1, savedInstanceState);
 adapter.attachTo(navigationView);
 

Also, don't forget to call adapter.onSaveInstanceState() in your Activity onSaveInstanceState().

Now you have your navigation drawer or bottom navigation view up and running, including state saving of the fragments.

Advanced Usage

OnNavigationItemSelectedListener

An additional OnNavigationItemSelectedListener can be provided via setNavigationItemSelectedListener(). This can be used to add behavior after the fragment transaction was commited. If you just want to close the drawer, the lib includes a CloseDrawerNavigationItemSelectedListener.

Back Stack

There are cases when some menu items (e.g. settings) should not simply replace the current fragment, but also be added to the back stack. To do this, override shouldAddToBackStack() in your adapter:

@Override public boolean shouldAddToBackStack(@IdRes int menuItemId) {

  return menuItemId == R.id.navitem_settings; 
}
 

Custom Actions

If you don't want to handle fragments when a menu item is selected (e.g. to start an Activity), you can override shouldHandleMenuItem() in your adapter:

@Override public boolean shouldHandleMenuItem(@IdRes int menuItemId) {

  return menuItemId != R.id.navitem_sample_activity; 
}
 

Don't forget to set an additional OnNavigationItemSelectedListener via setNavigationItemSelectedListener(), where you have to handle these menu items:

adapter.setNavigationItemSelectedListener(new CloseDrawerNavigationItemSelectedListener(drawerLayout) {

  @Override
  public boolean onNavigationItemSelected(MenuItem item) {

if(item.getItemId() == R.id.navitem_sample_activity) {

 startActivity(new Intent(MainActivity.this, SampleActivity.class));

}

 return super.onNavigationItemSelected(item);

  
}
 
}
);
 

Animations

You can provide custom animations for your fragment transactions via setCustomAnimations(). Separate animations can be set for when you add the transaction to the back stack via setBackStackCustomAnimations().

Sample

A basic sample app with example Activities for both adapters is available in the sample project.

Setup

The library is available on jCenter. Add the following to your build.gradle:

dependencies {

  compile 'com.patloew.navigationviewfragmentadapters:adapters:0.3.0' 
}
 

License

Copyright 2016 Patrick Löwenstein  Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0  Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. 

Resources

CurrencyEditText is an extension of Android's EditText view object. It is a module designed to provide ease-of-use when using an EditText field for gathering currency information from a user.

A simple spinner for Android with Material Design.

This library allows you to listen to SwipeRefreshLayout start, cancel and finish events.

A reactive wrapper for Android Google Cloud Messaging (aka gcm) to get rid of Service(s) configuration, handling foreground and background notifications depending on application state.

Easily notify a user with a simple alert, inform them of an optional update, and in dire situations block the user from accessing older versions of the application completely.

A Gradle plugin that helps facilitate Github PR checking and automatic commenting of violations.

Topics


2D Engines   3D Engines   9-Patch   Action Bars   Activities   ADB   Advertisements   Analytics   Animations   ANR   AOP   API   APK   APT   Architecture   Audio   Autocomplete   Background Processing   Backward Compatibility   Badges   Bar Codes   Benchmarking   Bitmaps   Bluetooth   Blur Effects   Bread Crumbs   BRMS   Browser Extensions   Build Systems   Bundles   Buttons   Caching   Camera   Canvas   Cards   Carousels   Changelog   Checkboxes   Cloud Storages   Color Analysis   Color Pickers   Colors   Comet/Push   Compass Sensors   Conferences   Content Providers   Continuous Integration   Crash Reports   Credit Cards   Credits   CSV   Curl/Flip   Data Binding   Data Generators   Data Structures   Database   Database Browsers   Date &   Debugging   Decompilers   Deep Links   Dependency Injections   Design   Design Patterns   Dex   Dialogs   Distributed Computing   Distribution Platforms   Download Managers   Drawables   Emoji   Emulators   EPUB   Equalizers &   Event Buses   Exception Handling   Face Recognition   Feedback &   File System   File/Directory   Fingerprint   Floating Action   Fonts   Forms   Fragments   FRP   FSM   Functional Programming   Gamepads   Games   Geocaching   Gestures   GIF   Glow Pad   Gradle Plugins   Graphics   Grid Views   Highlighting   HTML   HTTP Mocking   Icons   IDE   IDE Plugins   Image Croppers   Image Loaders   Image Pickers   Image Processing   Image Views   Instrumentation   Intents   Job Schedulers   JSON   Keyboard   Kotlin   Layouts   Library Demos   List View   List Views   Localization   Location   Lock Patterns   Logcat   Logging   Mails   Maps   Markdown   Mathematics   Maven Plugins   MBaaS   Media   Menus   Messaging   MIME   Mobile Web   Native Image   Navigation   NDK   Networking   NFC   NoSQL   Number Pickers   OAuth   Object Mocking   OCR Engines   OpenGL   ORM   Other Pickers   Parallax List   Parcelables   Particle Systems   Password Inputs   PDF   Permissions   Physics Engines   Platforms   Plugin Frameworks   Preferences   Progress Indicators   ProGuard   Properties   Protocol Buffer   Pull To   Purchases   Push/Pull   QR Codes   Quick Return   Radio Buttons   Range Bars   Ratings   Recycler Views   Resources   REST   Ripple Effects   RSS   Screenshots   Scripting   Scroll Views   SDK   Search Inputs   Security   Sensors   Services   Showcase Views   Signatures   Sliding Panels   Snackbars   SOAP   Social Networks   Spannable   Spinners   Splash Screens   SSH   Static Analysis   Status Bars   Styling   SVG   System   Tags   Task Managers   TDD &   Template Engines   Testing   Testing Tools   Text Formatting   Text Views   Text Watchers   Text-to   Toasts   Toolkits For   Tools   Tooltips   Trainings   TV   Twitter   Updaters   USB   User Stories   Utils   Validation   Video   View Adapters   View Pagers   Views   Watch Face   Wearable Data   Wearables   Weather   Web Tools   Web Views   WebRTC   WebSockets   Wheel Widgets   Wi-Fi   Widgets   Windows   Wizards   XML   XMPP   YAML   ZIP Codes