A small, yet full-featured framework that allows building View-based Android applications. Conductor provides a light-weight wrapper around standard Android Views that does just about everything you'd want:
| Conductor
------|------------------------------ :tada: | Easy integration :point_up: | Single Activity apps without using Fragments :recycle: | Simple but powerful lifecycle management :train: | Navigation and backstack handling :twisted_rightwards_arrows: | Beautiful transitions between views :floppy_disk: | State persistence :phone: | Callbacks for onActivityResult, onRequestPermissionsResult, etc :european_post_office: | MVP / MVVM / VIPER / MVC ready
Conductor is architecture-agnostic and does not try to force any design decisions on the developer. We here at BlueLine Labs tend to use either MVP or MVVM, but it would work equally well with standard MVC or whatever else you want to throw at it.
compile 'com.bluelinelabs:conductor:1.0.2'
// If you want the components that go along with
// Android's support libraries (currently just a PagerAdapter):
compile 'com.bluelinelabs:conductor-support:1.0.2'
// If you want RxJava/RxAndroid lifecycle support:
compile 'com.bluelinelabs:conductor-rxlifecycle:1.0.2'
The Controller is the View wrapper that will give you all of your lifecycle management features. Think of it as a lighter-weight and more predictable Fragment alternative with an easier to manage lifecycle.
The Router is responsible for handling navigation and the backstack. Controllers are pushed and popped in order to display and remove them.
ControllerChangeHandlers are responsible for performing the logic associated with pushing or popping Controllers. The most common implementation of these will be to animate between Controllers.
Transactions are used to define data about adding Controllers. RouterControllerTransactions are used to push a Controller to a Router with specified ControllerChangeHandlers, while ChildControllerTransactions are used to add child Controllers.
public class MainActivity extends Activity {
private Router mRouter;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
ViewGroup container = (ViewGroup)findViewById(R.id.controller_container)
mRouter = Conductor.attachRouter(this, container, savedInstanceState);
if (!mRouter.hasRootController()) {
mRouter.setRoot(new HomeController());
}
}
@Override
public void onBackPressed() {
if (!mRouter.handleBack()) {
super.onBackPressed();
}
}
}
public class HomeController extends Controller {
@Override
protected int layoutId() {
return R.layout.controller_overlay;
}
@Override
public void onBindView(@NonNull View view) {
super.onBindView(view);
((TextView)view.findViewById(R.id.tv_title)).setText("Hello World");
}
}
Demo app - Shows how to use all basic and most advanced functions of Conductor.
The lifecycle of a Controller is significantly simpler to understand than that of a Fragment. A lifecycle diagram is shown below:
![Controller Lifecycle](docs/Controller Lifecycle.jpg)
setRetainViewMode
can be called on a Controller
with one of two values: RELEASE_DETACH
, which will release the Controller
's view as soon as it is detached from the screen (saves memory), or RETAIN_DETACH
, which will ensure that a Controller
holds on to its view, even if it's not currently shown on the screen (good for views that are expensive to re-create).
ControllerChangeHandler
can be subclassed in order to perform different functions when changing between two Controllers
. Two convenience ControllerChangeHandler
subclasses are included to cover most basic needs: AnimatorChangeHandler
, which will use an Animator
object to transition between two views, and TransitionChangeHandler
, which will use Lollipop's Transition
framework for transitioning between views.
addChildController
can be called on a Controller
in order to add nested Controller
s. Child Controller
s will receive all lifecycle callbacks that parents get.
If the RxLifecycle dependency has been added, there is an RxController
available that can be used along with the standard RxLifecycle library. There is also a ControllerLifecycleProvider
available if you do not wish to use this subclass.
Copyright 2016 BlueLine Labs, Inc.
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.