hss01248/pagestatemanager

manage the loading,emtpy,error state of page, use in xml or just in code

PageStateManager/StatefulFrameLayout

页面状态管理

在张鸿洋的LoadingAndRetryManager的基础上改写,修正一些bug,优化api,并提供使用时封装的例子

特性

• api超级简单
• 可以在xml中使用StatefulFrameLayout
• 也可以不改动xml,直接在代码里使用PageStateManager
• 错误页面和空白页面均提供了点击事件的回调,直接实现即可
• 不改动framlayout本身任何属性,依然可以添加多个子view

更新:fragment的操作改变了

由于fragment的生命周期引起的bug,已取消原先直接传入fragment对象的方式.

请改成传入组成fragment的view,注意该view对象传入时,其parent不能为空,也就是,该view不能是xml的根view,可以自己随便包一层.

ps.

其实fragment本质也是基于view包裹了一层api,搞点生命周期之类的,api难用得要死,还一大堆坑,还不如自己包装一个view,自己加点生命周期,高度可控,减少bug.我的项目中从来都不用fragment,都是自己把view包装成各种page.

API

参考demo里的,自己封装一层(拷过去改一改)

接口

public interface IViewState {

     void showLoading();
     void showError(CharSequence msg);
     void showContent();
     void showEmpty();
}

四个级别的配置

库内默认

自带Loading,Empty,Error的xml:

public static int BASE_LOADING_LAYOUT_ID = R.layout.pager_loading;
public static int BASE_RETRY_LAYOUT_ID = R.layout.pager_error;
public static int BASE_EMPTY_LAYOUT_ID = R.layout.pager_empty;

使用时可全局配置

在application的oncreate里调用:

也就是修改上述的三个静态变量:

PageStateManager.initInAppOnCreate():

public static void initInApp(int layoutIdOfEmpty, int layoutIdOfLoading, int layoutIdOfError) {
    if (layoutIdOfEmpty != 0) {
        BASE_EMPTY_LAYOUT_ID = layoutIdOfEmpty;
    }
    if (layoutIdOfLoading != 0) {
        BASE_LOADING_LAYOUT_ID = layoutIdOfLoading;
    }
    if (layoutIdOfError != 0) {
        BASE_RETRY_LAYOUT_ID = layoutIdOfError;
    }
}

单个页面的配置:

可配置的项目:

// PageConfig为抽象类:

仅一个必须实现的方法:

public abstract class PageConfig {

public abstract void onRetry(View retryView);//必须实现

public void onEmtptyViewClicked(View emptyView) {
    onRetry(emptyView);
}

public boolean isFirstStateLoading(){
    return true;
}

public String emptyMsg(){
    return "";
}

public int customLoadingLayoutId() {
    return PageStateManager.BASE_LOADING_LAYOUT_ID;
}

public int customErrorLayoutId() {
    return PageStateManager.BASE_RETRY_LAYOUT_ID;
}

public int customEmptyLayoutId() {
    return PageStateManager.BASE_EMPTY_LAYOUT_ID;
}

xml里使用statefulFrameLayout时:

<com.hss01248.pagestate.StatefulFrameLayout
    android:id="@+id/pager"
    android:layout_width="match_parent"
    android:layout_height="match_parent">
    <TextView
        android:id="@+id/context"
        android:background="#ffff00"
        android:text="i am the content!!!!!!!!!!!!!!!!!!!!!!!!!!!"
        android:layout_width="match_parent"
        android:layout_height="match_parent"/>
    <Button
        android:layout_width="match_parent"
        android:id="@+id/btn"
        android:layout_marginTop="40dp"
        android:text="view2"
        android:layout_height="wrap_content"/>
</com.hss01248.pagestate.StatefulFrameLayout>

statefulFrameLayout.init(new PageConfig() {
            @Override
            public void onRetry(View retryView) {
                doNet();
            }
        });
        

或者使用PageStateManager:

 /**
     *
     * @param container  必须为activity或者view.如果是view,则该view对象必须有parent
     */
pageStateManager =   PageStateManager.initWhenUse(container,new MyPageConfig() {
    @Override
    protected void onReallyRetry() {
        doNet();
    }

    @Override
    public int customEmptyLayoutId() {
        return R.layout.pager_empty_2;
    }

    @Override
    public int customLoadingLayoutId() {
        return R.layout.pager_loading_2;
    }

    @Override
    public int customErrorLayoutId() {
        return R.layout.pager_error_2;
    }
});

控制页面状态的api:

public void showLoading()
public void showContent()
public void showEmpty()
public void showError(CharSequence errorMsg)

demo中的默认的几个页面状态UI图

其中无网络时弹出dialog:

无网络的对话框可以全局复写:

NoNetworkHelper.setShowDialogImpl(IShowDialog showDialog)

public interface IShowDialog{
        void showNoNetWorkDlg(final Context context);
    }
    

使用

gradle

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.hss01248:PageStateManager:3.0.1'
    }

示例代码(详见demo)

xml里不写StatefulFramelayout时:

private void initView() {
        setContentView(R.layout.activity_main);
        pageStateManager =   PageStateManager.initWhenUse(this,new PageConfig() {

            @Override
            public int customEmptyLayoutId() {
                return R.layout.pager_empty_2;
            }

            @Override
            public void onRetry(View retryView) {
                doNet();
            }

            @Override
            public int customLoadingLayoutId() {
                return R.layout.pager_loading_2;
            }

            @Override
            public int customErrorLayoutId() {
                return R.layout.pager_error_2;
            }
        });

    }

    private void doNet() {
        pageStateManager.showLoading();

        new Handler().postDelayed(new Runnable() {
            @Override
            public void run() {
                int  state = new Random().nextInt(3);
                switch (state){
                    case 0:
                        pageStateManager.showError("稍候重试");
                        break;
                    case 1:
                        pageStateManager.showEmpty();
                        break;
                    case 2:
                        pageStateManager.showContent();
                }

            }
        },2000);
    }

在xml里直接写时:

......
statefulFrameLayout = (StatefulFrameLayout)findViewById(R.id.pager);
    statefulFrameLayout.init(new PageConfig() {
        @Override
        public void onRetry(View retryView) {
            doNet();
        }
    });
    doNet();
}



private void doNet() {
    statefulFrameLayout.showLoading();

    new Handler().postDelayed(new Runnable() {
        @Override
        public void run() {
            int  state = new Random().nextInt(3);
            switch (state){
                case 0:
                    statefulFrameLayout.showError("稍候重试222222");
                    break;
                case 1:
                    statefulFrameLayout.showEmpty();
                    break;
                case 2:
                    statefulFrameLayout.showContent();
            }

        }
    },2000);
}

注意事项

1.给view对象设置状态时,该对象必须有parent

blog

介绍一下页面状态管理类PageStateManager,我实在看不下去你们直接用Layout

pagestatemanager's Issues

加载中转圈的ProgressBar会卡顿，怎么才能防止卡顿

Android x 版本使用情况

你好，Android x 版本能使用么？

状态页面自定义加入titlebar如何自定义事件

比如这种，我需要定义返回键的点击事件和页面标题的文字。

关于自定义三个页面

作者你好，我想问一下如果我要自定义三个状态页面，各个页面里的各个view的监听事件怎么实现？

比如现在想自定义一个errorStatePage，里面有个button的监听事件要怎么去实现？

viewPager的Fragment不能用，请修复

ConstraintLayout作为底层布局初始化时会报错

有一处错误，看是不是我误会了。

在PageManager类中
private void setupRetryLayout(PageListener listener, PageLayout loadingAndRetryLayout) { if (listener.isSetRetryLayout()) { int layoutId = listener.generateRetryLayoutId(); if (layoutId != NO_LAYOUT_ID) { loadingAndRetryLayout.setLoadingView(layoutId); } else { loadingAndRetryLayout.setLoadingView(listener.generateRetryLayout()); } } else { if (BASE_RETRY_LAYOUT_ID != NO_LAYOUT_ID) loadingAndRetryLayout.setRetryView(BASE_RETRY_LAYOUT_ID); } }

在setupRetryLayout中是不是应该是setRetryView，你现在全部用的是setLoadingView，请问是不是错位了。

viewpager页面空白

第一个Fragment的页面管理用view的那个方法,
第二个Fragment的页面管理用Fragment的对象,
现象第一个Fragment空白.
第二个Fragment的页面改用view则无此现象

自定义了三个状态页，报空指针异常。

具体错误日志：
java.lang.RuntimeException: Unable to start activity ComponentInfo{com.srwl.www/com.srwl.www.activity.TicketInfoActivity}: java.lang.NullPointerException

Caused by: java.lang.NullPointerException

caused by指向的代码是这句：pageStateManager = PageManager.init(this, "找不到相关航班信息，请返回重新查询", true, new Runnable() {....

我是直接把你的三个状态页的xml文件拿来修改的，里面并没有增加控件，只是改了文字内容和图片内容而已。然后在application中初始化： PageManager.initInApp(getApplicationContext(), R.layout.page_empty,R.layout.pager_loading,R.layout.pager_error);

这样子做应该没错把？