Skip to content

Latest commit

 

History

History
106 lines (76 loc) · 3.68 KB

README.md

File metadata and controls

106 lines (76 loc) · 3.68 KB
Raw

FragmentMaster

FragmentMaster is a library allows you easily develop an Android application which only navigated by Fragments.

Features

  • Pass data and receive result between two fragments.
  • Swipe right to navigate back.
  • Custom transform animation.

Usage

  1. MasterFragment

    In FragmentMaster, every "page" is subclass of MasterFragment (Or other IMasterFragment, like MasterListFragment) not Activity.

    1. You can start a MasterFragment as start a Activity:
    // start YourMasterFragment
Request request = new Request(YourMasterFragment.class);
startFragment(request);

    The Request class is similar to the Android's Intent which is an abstract description of your operation. The difference is that Request is used to start a MasterFragment.

    1. You can pass data within two MasterFragments. Put extra data into your request and start YourMasterFragment:
    // pass data.
Request request = new Request(YourMasterFragment.class);
request.putExtra(YourMasterFragment.EXTRA_KEY, "Extra data");
startFragment(request);
    1. And get extra data in YourMasterFragment:
    Request request = getRequest();
String extraData = request.getStringExtra(YourMasterFragment.EXTRA_KEY);

  2. Install FragmentMaster

    Subclass MasterActivity, it is the host of all MasterFragments. And in its onCreate() add the codes below after setContentView() method:

    setContentView(R.layout.master_activity);
FragmentMaster fragmentMaster = getFragmentMaster();
fragmentMaster.install(R.id.container, new Request(Home.class), true);

    The first parameter of install() is the id of your MasterFragment's container. All started MasterFragment will be added to this container. The second parameter is a Request object which describes your home MasterFragment. The home MasterFragment will be started once the host MasterActivity is started. If the third parameter is true, the host MasterActivity will be finished when the home MasterFragment is finished.

  3. PageAnimator

    FragmentMaster provides an API for you to add custom animation for each MasterFragment. The animation will be performed when starting, finishing and dragging by user.

    1. Subclass PageAnimator and implement two methods:
    // Transform the background page.
protected abstract void transformBackgroundPage(View page, float position,

boolean enter);


```Java
// Transform the foreground page.
protected abstract void transformForegroundPage(View page, float position,
boolean enter);
  1. Override onCreatePageAnimator method of MasterFragment to provide your custom PagerAnimator:
@Override
public PageAnimator onCreatePageAnimator() {
    // return your own PageAnimator.
    return YOUR_CUSTOM_ANIMATOR;
}

There are some custom PageAnimators in the Sample project.

License

Copyright 2014 Feng Dai

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.