-
Notifications
You must be signed in to change notification settings - Fork 964
Customisation
There are many ways you can customise the pull-to-refresh experience to your needs. See the GridView sample for more info on all of these.
ViewDelegates provide support for handling scrollable Views. The main use of a ViewDelegate is to being able to tell when a scrollable view is scrolled to the top. There is currently inbuilt support for:
- AbsListView classes (through AbsListViewDelegate)
- ScrollView (through ScrollYDelegate)
- WebView (through WebViewDelegate)
What if you want the view you want to use a view which isn't in the list above? Well you can provide your own ViewDelegate.
ActionBarPullToRefresh.from(this)
// Here we'll set a custom ViewDelegate
.useViewDelegate(XYZView.class, new AbsListViewDelegate())
.setup(mPullToRefreshLayout);When instatiating a PullToRefreshAttacher you can provide an Options instance which contains a number of configuration elements:
-
headerLayout: Layout resource to be inflated as the header view (see below). -
headerTransformer: The HeaderTransformer for the heard view (see below). -
headerInAnimation: The animation resource which is used when the header view is shown. -
headerOutAnimation: The animation resource which is used when the header view is hidden. -
refreshScrollDistance: The vertical distance (percentage of the scrollable view height) that the user needs to scroll for a refresh to start. -
refreshOnUp: Whether to wait to start the refresh until when the user has lifted their finger. -
refreshMinimize: Whether to minimize the header so that the Action Bar isn't hidden for a long refresh. -
refreshMinimizeDelay: The delay after a refresh starts after which the header should be minimized.
HeaderTransformers are responsible for updating the header view to match the current state. If you do not provide a HeaderTransformer, there is a default implementation created for you called DefaultHeaderTransformer. This default implementation is what provides the default behaviour (growing progress bar, etc).
DefaultHeaderTransformer is the default HeaderTransformer bundled with the library and produces the standard pull-to-refresh UI (displaying over the Action Bar). There are a number of ways you can customize this default UI. The easiest is with an XML style:
<!--
Your Activity's style, this can be called anything you want. Or if you
already have a custom theme, just add the ptrHeaderStyle item to it.
Make sure you use an appropriate parent theme.
-->
<style name="Theme.YourActivity" parent="android:Theme.Holo">
<item name="ptrHeaderStyle">@style/Widget.Custom.PtrHeader</item>
</style>
<!--
ptrHeaderStyle above refers to this style which contains all of the
DefaultHeaderTransformer customization values. The name and parent
can be anything, but only the attributes defined in
library/res/attrs.xml are actually read in.
-->
<style name="Widget.Custom.PtrHeader" parent="android:Widget">
<!-- The background of the header view -->
<item name="ptrHeaderBackground">...</item>
<!-- The height of the header view. Please note, only set if in you really need to -->
<item name="ptrHeaderHeight">...</item>
<!-- TextAppearance of the header view's title text -->
<item name="ptrHeaderTitleTextAppearance">...</item>
<!-- Color to tint the progress bar -->
<item name="ptrProgressBarColor">...</item>
<!-- Radius of the progress bar corners -->
<item name="ptrProgressBarCornerRadius">4dp</item>
<!-- Style of the Progress Bar. Values are either: inside or outside -->
<item name="ptrProgressBarStyle">...</item>
<!-- The strings to be displayed at the various states -->
<item name="ptrPullText">...</item>
<item name="ptrRefreshingText">...</item>
<item name="ptrReleaseText">...</item>
</style>See the sample styles.xml for a more detailed example.
If you feel that the default header view layout does not provide what you require, you can provide your own which is inflated for you. For the majority of cases, you will probably want to provide your own HeaderTransformer as well, to update your custom layout.