FragmentNavigator

Additional

Language
Java
Version
1.0.2 (Apr 27, 2016)
Created
Mar 31, 2016
Updated
Sep 3, 2016 (Retired)
Owner
Running man! (Aspsine)
Contributor
Running man! (Aspsine)
1
Activity
Badge
Generate
Download
Source code
APK file

Announcement

FragmentNavigator

An useful fragment navigator helps you control fragments better and easier. You will not need to worry about the dirty things like switch fragments, fragments overlay, save fragments states and restore fragments states. The lib will do them all for you. Fragments in activity and nest Fragment are all supported.

Demo

Download

How to use

Step 1. Add the JitPack repository to your build file. Add it in your root build.gradle at the end of repositories:

allprojects {
    repositories {
        ...
        maven { url "https://jitpack.io" }
    }
}

Step 2. Add the dependency

dependencies {
    compile 'com.github.Aspsine:FragmentNavigator:1.0.2'
}

Step 3. The lib provide FragmentNavigator class and FragmentNavigatorAdapter interface to help you control fragments. It's very simple to use.

  • MainActivity.java
public class MainActivity extends AppCompatActivity implements BottomNavigatorView.OnBottomNavigatorViewItemClickListener {

    private static final int DEFAULT_POSITION = 0;

    private FragmentNavigator mNavigator;

    // a simple custom bottom navigation view
    private BottomNavigatorView bottomNavigatorView;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        mNavigator = new FragmentNavigator(getSupportFragmentManager(), new FragmentAdapter(), R.id.container);
        // set default tab position
        mNavigator.setDefaultPosition(DEFAULT_POSITION);
        mNavigator.onCreate(savedInstanceState);

        bottomNavigatorView = (BottomNavigatorView) findViewById(R.id.bottomNavigatorView);
        bottomNavigatorView.setOnBottomNavigatorViewItemClickListener(this);

        setCurrentTab(mNavigator.getCurrentPosition());
    }

    @Override
    protected void onSaveInstanceState(Bundle outState) {
        super.onSaveInstanceState(outState);
        mNavigator.onSaveInstanceState(outState);
    }

    @Override
    public void onBottomNavigatorViewItemClick(int position, View view) {
        setCurrentTab(position);
    }

    private void setCurrentTab(int position) {
        mNavigator.showFragment(position);
        bottomNavigatorView.select(position);
    }
}
  • FragmentAdapter.java
public class FragmentAdapter implements FragmentNavigatorAdapter {

    private static final String TABS[] = {"Chats", "Contacts", "Circle", "Me"};

    @Override
    public Fragment onCreateFragment(int position) {
        return MainFragment.newInstance(TABS[position]);
    }

    @Override
    public String getTag(int position) {
        // an simple unique tag
        return MainFragment.TAG + TABS[position];
    }

    @Override
    public int getCount() {
        return TABS.length;
    }
}

Usage of Demo App:

  • Step 1: Install demo app and open it, default tab is 'Chats'.

  • Step 2: Switch bottom tab to 'Contacts', Contacts page contains three child fragments.

  • Step 3: Switch top tab to 'Groups'

  • Step 4: Switch bottom tab to 'Circle'

  • Step 5: Click 'EXCEPTION' menu button on the right of actionbar

  • Step 6: Click 'CLICK ME TO MAKE AN EXCEPTION' button crash the app to demostate a RuntimeException

  • Step 7: We can see a crash dialog showed after app crashed. Then we click 'OK' button.(Some device may not have the crash alert dialog) Wow! App restarted, Fragment and bottom tab is properly restored it's state.

  • Step 8: Let's switch to 'Contacts' to see whether child fragment is properly restored. Good, it's restored and the state is right.

Contact Me

License

Copyright 2016 Aspsine. All rights reserved.

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.