threshold.rxlifecyclewithmvp.lce

Class RxMvpLceFragment<CV extends android.view.View,M,V extends com.hannesdorfmann.mosby.mvp.lce.MvpLceView<M>,P extends com.hannesdorfmann.mosby.mvp.MvpPresenter<V>>

java.lang.Object

android.support.v4.app.Fragment

com.trello.rxlifecycle.components.support.RxFragment

threshold.rxlifecyclewithmvp.RxMvpFragment<V,P>

threshold.rxlifecyclewithmvp.lce.RxMvpLceFragment<CV,M,V,P>

Type Parameters:

CV - The type of the content view with the id = R.id.contentView. Can be any kind of android view widget like ListView, RecyclerView, ScrollView or a simple layout like Framelayout etc. (everything that extends from android.view.View)

M - The underlying data model that will be displayed with this view

V - The View interface that must be implemented by this view. You can use {mylink MvpLceView}, but if you want to add more methods you have to provide your own view interface that extends from {mylink MvpLceView}

P - The type of the Presenter. Must extend from {mylink MvpPresenter}

All Implemented Interfaces:

android.content.ComponentCallbacks, android.view.View.OnCreateContextMenuListener, com.hannesdorfmann.mosby.mvp.delegate.BaseMvpDelegateCallback<V,P>, com.hannesdorfmann.mosby.mvp.lce.MvpLceView<M>, com.hannesdorfmann.mosby.mvp.MvpView, com.trello.rxlifecycle.FragmentLifecycleProvider

public abstract class RxMvpLceFragment<CV extends android.view.View,M,V extends com.hannesdorfmann.mosby.mvp.lce.MvpLceView<M>,P extends com.hannesdorfmann.mosby.mvp.MvpPresenter<V>>
extends RxMvpFragment<V,P>
implements com.hannesdorfmann.mosby.mvp.lce.MvpLceView<M>

A {mylink RxMvpFragment} that implements {mylink MvpLceView} which gives you 3 options:

• Display a loading view: A view with R.id.loadingView must be specified in your inflated xml layout
• Display a error view: A TextView with R.id.errorView must be declared in your inflated xml layout
• Display content view: A view with R.id.contentView must be specified in your inflated xml layout

Since:

1.0.0

Nested Class Summary

Nested classes/interfaces inherited from class android.support.v4.app.Fragment

android.support.v4.app.Fragment.InstantiationException, android.support.v4.app.Fragment.SavedState

Field Summary

Fields

Modifier and Type	Field and Description
protected CV	contentView
protected android.widget.TextView	errorView
protected android.view.View	loadingView

Fields inherited from class threshold.rxlifecyclewithmvp.RxMvpFragment

mvpDelegate, presenter

Constructor Summary

Constructors

Constructor and Description
RxMvpLceFragment()

Method Summary

Modifier and Type	Method and Description
protected void	animateContentViewIn() Called to animate from loading view to content view
protected void	animateErrorViewIn() Animates the error view in (instead of displaying content view / loading view)
protected void	animateLoadingViewIn() Override this method if you want to provide your own animation for showing the loading view
protected abstract java.lang.String	getErrorMessage(java.lang.Throwable e, boolean pullToRefresh) Get the error message for a certain Exception that will be shown on {mylink #showError(Throwable, boolean)}
void	onDestroyView()
protected void	onErrorViewClicked() Called if the error view has been clicked.
void	onViewCreated(android.view.View view, android.os.Bundle savedInstanceState)
void	showContent()
void	showError(java.lang.Throwable e, boolean pullToRefresh)
protected void	showLightError(java.lang.String msg) The default behaviour is to display a toast message as light error (i.e.
void	showLoading(boolean pullToRefresh)

Methods inherited from class threshold.rxlifecyclewithmvp.RxMvpFragment

createPresenter, getMvpDelegate, getMvpView, getPresenter, isRetainInstance, onActivityCreated, onAttach, onCreate, onDestroy, onDetach, onPause, onResume, onSaveInstanceState, onStart, onStop, setPresenter, shouldInstanceBeRetained

Methods inherited from class com.trello.rxlifecycle.components.support.RxFragment

bindToLifecycle, bindUntilEvent, lifecycle

Methods inherited from class android.support.v4.app.Fragment

dump, equals, getActivity, getAllowEnterTransitionOverlap, getAllowReturnTransitionOverlap, getArguments, getChildFragmentManager, getContext, getEnterTransition, getExitTransition, getFragmentManager, getHost, getId, getLayoutInflater, getLoaderManager, getParentFragment, getReenterTransition, getResources, getRetainInstance, getReturnTransition, getSharedElementEnterTransition, getSharedElementReturnTransition, getString, getString, getTag, getTargetFragment, getTargetRequestCode, getText, getUserVisibleHint, getView, hashCode, hasOptionsMenu, instantiate, instantiate, isAdded, isDetached, isHidden, isInLayout, isMenuVisible, isRemoving, isResumed, isVisible, onActivityResult, onAttach, onConfigurationChanged, onContextItemSelected, onCreateAnimation, onCreateContextMenu, onCreateOptionsMenu, onCreateView, onDestroyOptionsMenu, onHiddenChanged, onInflate, onInflate, onLowMemory, onOptionsItemSelected, onOptionsMenuClosed, onPrepareOptionsMenu, onRequestPermissionsResult, onViewStateRestored, registerForContextMenu, requestPermissions, setAllowEnterTransitionOverlap, setAllowReturnTransitionOverlap, setArguments, setEnterSharedElementCallback, setEnterTransition, setExitSharedElementCallback, setExitTransition, setHasOptionsMenu, setInitialSavedState, setMenuVisibility, setReenterTransition, setRetainInstance, setReturnTransition, setSharedElementEnterTransition, setSharedElementReturnTransition, setTargetFragment, setUserVisibleHint, shouldShowRequestPermissionRationale, startActivity, startActivity, startActivityForResult, startActivityForResult, toString, unregisterForContextMenu

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.hannesdorfmann.mosby.mvp.lce.MvpLceView

loadData, setData

Methods inherited from interface com.hannesdorfmann.mosby.mvp.delegate.BaseMvpDelegateCallback

setRetainInstance

Field Detail

loadingView

protected android.view.View loadingView

contentView

protected CV extends android.view.View contentView

errorView

protected android.widget.TextView errorView

Constructor Detail

RxMvpLceFragment

public RxMvpLceFragment()

Method Detail

onViewCreated

@CallSuper
public void onViewCreated(android.view.View view,
                                     @Nullable
                                     android.os.Bundle savedInstanceState)

Overrides:

onViewCreated in class RxMvpFragment<V extends com.hannesdorfmann.mosby.mvp.lce.MvpLceView<M>,P extends com.hannesdorfmann.mosby.mvp.MvpPresenter<V>>

showLoading

public void showLoading(boolean pullToRefresh)

Specified by:

showLoading in interface com.hannesdorfmann.mosby.mvp.lce.MvpLceView<M>

animateLoadingViewIn

protected void animateLoadingViewIn()

Override this method if you want to provide your own animation for showing the loading view

showContent

public void showContent()

Specified by:

showContent in interface com.hannesdorfmann.mosby.mvp.lce.MvpLceView<M>

animateContentViewIn

protected void animateContentViewIn()

Called to animate from loading view to content view

getErrorMessage

protected abstract java.lang.String getErrorMessage(java.lang.Throwable e,
                                                    boolean pullToRefresh)

Get the error message for a certain Exception that will be shown on {mylink #showError(Throwable, boolean)}

Parameters:

e - throwable

pullToRefresh - isPullToRefresh

showLightError

protected void showLightError(java.lang.String msg)

The default behaviour is to display a toast message as light error (i.e. pull-to-refresh error). Override this method if you want to display the light error in another way (like crouton).

Parameters:

msg - Message

onErrorViewClicked

protected void onErrorViewClicked()

Called if the error view has been clicked. To disable clicking on the errorView use errorView.setClickable(false)

showError

public void showError(java.lang.Throwable e,
                      boolean pullToRefresh)

Specified by:

showError in interface com.hannesdorfmann.mosby.mvp.lce.MvpLceView<M>

animateErrorViewIn

protected void animateErrorViewIn()

Animates the error view in (instead of displaying content view / loading view)

onDestroyView

public void onDestroyView()

Overrides:

onDestroyView in class RxMvpFragment<V extends com.hannesdorfmann.mosby.mvp.lce.MvpLceView<M>,P extends com.hannesdorfmann.mosby.mvp.MvpPresenter<V>>