Constructor Detail

Method Detail

• setFooterHeight

   abstract RefreshLayout setFooterHeight(float dp)

  Set the Footer's height.

  Parameters:

  dp - Density-independent Pixels Density-independent pixels (use px2dp for pixel conversion)

  Returns:

  RefreshLayout

• setFooterHeightPx

   abstract RefreshLayout setFooterHeightPx(int px)

  Set the Footer height.

  Parameters:

  px - Pixels

  Returns:

  RefreshLayout

• setHeaderHeight

   abstract RefreshLayout setHeaderHeight(float dp)

  Set the Header's height.

  Parameters:

  dp - Density-independent Pixels Density-independent pixels (use px2dp for pixel conversion)

  Returns:

  RefreshLayout

• setHeaderHeightPx

   abstract RefreshLayout setHeaderHeightPx(int px)

  Set the Header height.

  Parameters:

  px - Pixels

  Returns:

  RefreshLayout

• setHeaderInsetStart

   abstract RefreshLayout setHeaderInsetStart(float dp)

  Set the Header's start offset（see srlHeaderInsetStart in the RepastPracticeActivity XML in demo-app for the practical application).

  Parameters:

  dp - Density-independent Pixels Density-independent pixels (use px2dp for pixel conversion)

  Returns:

  RefreshLayout

• setHeaderInsetStartPx

   abstract RefreshLayout setHeaderInsetStartPx(int px)

  Set the Header's start offset（see srlHeaderInsetStart in the RepastPracticeActivity XML in demo-app for the practical application).

  Parameters:

  px - Pixels

  Returns:

  RefreshLayout

• setFooterInsetStart

   abstract RefreshLayout setFooterInsetStart(float dp)

  Set the Footer's start offset.

  Parameters:

  dp - Density-independent Pixels Density-independent pixels (use px2dp for pixel conversion)

  Returns:

  RefreshLayout

• setFooterInsetStartPx

   abstract RefreshLayout setFooterInsetStartPx(int px)

  Set the Footer's start offset.

  Parameters:

  px - Pixels

  Returns:

  RefreshLayout

• setDragRate

   abstract RefreshLayout setDragRate(float rate)

  Set the damping effect. Ratio of displayed drag height to actual drag height (default 0.5).

  Parameters:

  rate - ratio = (The drag height of the view)/(The actual drag height of the finger) Ratio = view drag height / finger drag height

  Returns:

  RefreshLayout

• setHeaderMaxDragRate

   abstract RefreshLayout setHeaderMaxDragRate(float rate)

  Set the ratio of the maximum height to drag header.

  Parameters:

  rate - ratio = (the maximum height to drag header)/(the height of header) Ratio = max pull-down height / Header height

  Returns:

  RefreshLayout

• setFooterMaxDragRate

   abstract RefreshLayout setFooterMaxDragRate(float rate)

  Set the ratio of the maximum height to drag footer.

  Parameters:

  rate - ratio = (the maximum height to drag footer)/(the height of footer) Ratio = max pull-up height / Footer height

  Returns:

  RefreshLayout

• setHeaderTriggerRate

   abstract RefreshLayout setHeaderTriggerRate(float rate)

  Set the ratio at which the refresh is triggered.

  Parameters:

  rate - Ratio of trigger refresh distance to HeaderHeight

  Returns:

  RefreshLayout

• setFooterTriggerRate

   abstract RefreshLayout setFooterTriggerRate(float rate)

  Set the ratio at which the load more is triggered.

  Parameters:

  rate - Ratio of trigger load distance to FooterHeight

  Returns:

  RefreshLayout

• setReboundInterpolator

   abstract RefreshLayout setReboundInterpolator(Interpolator interpolator)

  Set the rebound interpolator.

  Parameters:

  interpolator - Animation interpolator

  Returns:

  RefreshLayout

• setReboundDuration

   abstract RefreshLayout setReboundDuration(int duration)

  Set the duration of the rebound animation.

  Parameters:

  duration - Duration

  Returns:

  RefreshLayout

• setRefreshFooter

   abstract RefreshLayout setRefreshFooter(RefreshFooter footer)

  Set the footer of RefreshLayout.

  Parameters:

  footer - RefreshFooter refresh footer

  Returns:

  RefreshLayout

• setRefreshFooter

   abstract RefreshLayout setRefreshFooter(RefreshFooter footer, int width, int height)

  Set the footer of RefreshLayout.

  Parameters:

  footer - RefreshFooter refresh footer

  width - the width in px, can use MATCH_PARENT and WRAP_CONTENT.

  height - the height in px, can use MATCH_PARENT and WRAP_CONTENT.

  Returns:

  RefreshLayout

• setRefreshHeader

   abstract RefreshLayout setRefreshHeader(RefreshHeader header)

  Set the header of RefreshLayout.

  Parameters:

  header - RefreshHeader refresh header

  Returns:

  RefreshLayout

• setRefreshHeader

   abstract RefreshLayout setRefreshHeader(RefreshHeader header, int width, int height)

  Set the header of RefreshLayout.

  Parameters:

  header - RefreshHeader refresh header

  width - the width in px, can use MATCH_PARENT and WRAP_CONTENT.

  height - the height in px, can use MATCH_PARENT and WRAP_CONTENT.

  Returns:

  RefreshLayout

• setRefreshContent

   abstract RefreshLayout setRefreshContent(View content)

  Set the content of RefreshLayout（Suitable for non-XML pages, not suitable for replacing empty layouts).

  Parameters:

  content - View content view

  Returns:

  RefreshLayout

• setRefreshContent

   abstract RefreshLayout setRefreshContent(View content, int width, int height)

  Set the content of RefreshLayout（Suitable for non-XML pages, not suitable for replacing empty layouts).

  Parameters:

  content - View content view

  width - the width in px, can use MATCH_PARENT and WRAP_CONTENT.

  height - the height in px, can use MATCH_PARENT and WRAP_CONTENT.

  Returns:

  RefreshLayout

• setEnableRefresh

   abstract RefreshLayout setEnableRefresh(boolean enabled)

  Whether to enable pull-down refresh (enabled by default).

  Parameters:

  enabled - Whether to enable

  Returns:

  RefreshLayout

• setEnableLoadMore

   abstract RefreshLayout setEnableLoadMore(boolean enabled)

  Set whether to enable pull-up loading more (enabled by default).

  Parameters:

  enabled - Whether to enable

  Returns:

  RefreshLayout

• setEnableAutoLoadMore

   abstract RefreshLayout setEnableAutoLoadMore(boolean enabled)

  Sets whether to listen for the list to trigger a load event when scrolling to the bottom (default true).

  Parameters:

  enabled - Whether to enable

  Returns:

  RefreshLayout

• setEnableHeaderTranslationContent

   abstract RefreshLayout setEnableHeaderTranslationContent(boolean enabled)

  Set whether to pull down the content while pulling down the header.

  Parameters:

  enabled - Whether to enable

  Returns:

  RefreshLayout

• setEnableFooterTranslationContent

   abstract RefreshLayout setEnableFooterTranslationContent(boolean enabled)

  Set whether to pull up the content while pulling up the footer.

  Parameters:

  enabled - Whether to enable

  Returns:

  RefreshLayout

• setEnableOverScrollBounce

   abstract RefreshLayout setEnableOverScrollBounce(boolean enabled)

  Set whether to enable the over-scroll bounce function.

  Parameters:

  enabled - Whether to enable

  Returns:

  RefreshLayout

• setEnablePureScrollMode

   abstract RefreshLayout setEnablePureScrollMode(boolean enabled)

  Set whether to enable pure scroll mode.

  Parameters:

  enabled - Whether to enable

  Returns:

  RefreshLayout

• setEnableScrollContentWhenLoaded

   abstract RefreshLayout setEnableScrollContentWhenLoaded(boolean enabled)

  Set whether to scroll the content to display new data after loading more complete. Whether to scroll content to show new data after load more.

  Parameters:

  enabled - Whether to enable

  Returns:

  RefreshLayout

• setEnableScrollContentWhenRefreshed

   abstract RefreshLayout setEnableScrollContentWhenRefreshed(boolean enabled)

  Set whether to scroll the content to display new data after the refresh is complete. Whether to scroll content to show new data after refresh

  Parameters:

  enabled - Whether to enable

  Returns:

  RefreshLayout

• setEnableLoadMoreWhenContentNotFull

   abstract RefreshLayout setEnableLoadMoreWhenContentNotFull(boolean enabled)

  Set whether to pull up and load more when the content is not full of one page. Whether to allow pull-up load more when content is less than one page.

  Parameters:

  enabled - Whether to enable

  Returns:

  RefreshLayout

• setEnableOverScrollDrag

   abstract RefreshLayout setEnableOverScrollDrag(boolean enabled)

  Set whether to enable over-scroll drag (imitation iPhone effect).

  Parameters:

  enabled - Whether to enable

  Returns:

  RefreshLayout

• setEnableFooterFollowWhenNoMoreData

   abstract RefreshLayout setEnableFooterFollowWhenNoMoreData(boolean enabled)

  Set whether Footer follows the content after there is no more data.

  Parameters:

  enabled - Whether to enable

  Returns:

  RefreshLayout

• setEnableClipHeaderWhenFixedBehind

   abstract RefreshLayout setEnableClipHeaderWhenFixedBehind(boolean enabled)

  Set whether to clip header when the Header is in the FixedBehind state.

  Parameters:

  enabled - Whether to enable

  Returns:

  RefreshLayout

• setEnableClipFooterWhenFixedBehind

   abstract RefreshLayout setEnableClipFooterWhenFixedBehind(boolean enabled)

  Set whether to clip footer when the Footer is in the FixedBehind state.

  Parameters:

  enabled - Whether to enable

  Returns:

  RefreshLayout

• setEnableNestedScroll

   abstract RefreshLayout setEnableNestedScroll(boolean enabled)

  Setting whether nesting scrolling is enabled (default off + smart on). Set whether to enable nested scrolling (default off, smart auto-enable).

  Parameters:

  enabled - Whether to enable

  Returns:

  RefreshLayout

• setFixedHeaderViewId

   abstract RefreshLayout setFixedHeaderViewId(int id)

  Set the View ID fixed below the Header, which stays stationary when Footer scrolls.

  Parameters:

  id - View ID fixed at header

  Returns:

  RefreshLayout

• setFixedFooterViewId

   abstract RefreshLayout setFixedFooterViewId(int id)

  Set the View ID fixed above the Footer, which stays stationary when Header scrolls.

  Parameters:

  id - View ID fixed at footer

  Returns:

  RefreshLayout

• setHeaderTranslationViewId

   abstract RefreshLayout setHeaderTranslationViewId(int id)

  Set the View ID that should scroll along with the Header. Defaults to the entire Content view.

  Parameters:

  id - View ID fixed at header

  Returns:

  RefreshLayout

• setFooterTranslationViewId

   abstract RefreshLayout setFooterTranslationViewId(int id)

  Set the View ID that should scroll along with the Footer. Defaults to the entire Content view.

  Parameters:

  id - View ID fixed at header

  Returns:

  RefreshLayout

• setDisableContentWhenRefresh

   abstract RefreshLayout setDisableContentWhenRefresh(boolean disable)

  Set whether to disable content interaction during refresh.

  Parameters:

  disable - Whether to disable

  Returns:

  RefreshLayout

• setDisableContentWhenLoading

   abstract RefreshLayout setDisableContentWhenLoading(boolean disable)

  Set whether to disable content interaction during loading.

  Parameters:

  disable - Whether to disable

  Returns:

  RefreshLayout

• setOnRefreshListener

   abstract RefreshLayout setOnRefreshListener(OnRefreshListener listener)

  Set refresh listener separately.

  Parameters:

  listener - OnRefreshListener refresh listener

  Returns:

  RefreshLayout

• setOnLoadMoreListener

   abstract RefreshLayout setOnLoadMoreListener(OnLoadMoreListener listener)

  Set load more listener separately.

  Parameters:

  listener - OnLoadMoreListener load more listener

  Returns:

  RefreshLayout

• setOnRefreshLoadMoreListener

   abstract RefreshLayout setOnRefreshLoadMoreListener(OnRefreshLoadMoreListener listener)

  Set refresh and load listeners at the same time.

  Parameters:

  listener - OnRefreshLoadMoreListener refresh and load more listener

  Returns:

  RefreshLayout

• setOnMultiListener

   abstract RefreshLayout setOnMultiListener(OnMultiListener listener)

  Set up a multi-function listener. Recommended: SimpleMultiListener.

  Parameters:

  listener - OnMultiPurposeListener multi-purpose listener

  Returns:

  RefreshLayout

• setScrollBoundaryDecider

   abstract RefreshLayout setScrollBoundaryDecider(ScrollBoundaryDecider boundary)

  Set the scroll boundary Decider, Can customize when you can refresh. Recommended .

  Parameters:

  boundary - ScrollBoundaryDecider scroll boundary decider

  Returns:

  RefreshLayout

• setPrimaryColors

   abstract RefreshLayout setPrimaryColors(Array<int> primaryColors)

  Set theme color int (primaryColor and accentColor).

  Parameters:

  primaryColors - ColorInt theme colors

  Returns:

  RefreshLayout

• setPrimaryColorsId

   abstract RefreshLayout setPrimaryColorsId(Array<int> primaryColorId)

  Set theme color id (primaryColor and accentColor).

  Parameters:

  primaryColorId - ColorRes theme color resource IDs

  Returns:

  RefreshLayout

• finishRefresh

   abstract RefreshLayout finishRefresh()

  Finish refresh.

  Returns:

  RefreshLayout

• finishRefresh

   abstract RefreshLayout finishRefresh(int delayed)

  Finish refresh.

  Parameters:

  delayed - Start delay

  Returns:

  RefreshLayout

• finishRefresh

   abstract RefreshLayout finishRefresh(boolean success)

  Finish refresh.

  Parameters:

  success - Whether data was refreshed successfully (affects last update time)

  Returns:

  RefreshLayout

• finishRefresh

   abstract RefreshLayout finishRefresh(int delayed, boolean success, Boolean noMoreData)

  Finish refresh.

  Parameters:

  delayed - Start delay

  success - Whether data was refreshed successfully (affects last update time)

  noMoreData - Whether there is more data

  Returns:

  RefreshLayout

• finishRefreshWithNoMoreData

   abstract RefreshLayout finishRefreshWithNoMoreData()

  Finish refresh and mark no more data.

  Returns:

  RefreshLayout

• finishLoadMore

   abstract RefreshLayout finishLoadMore()

  Finish load more.

  Returns:

  RefreshLayout

• finishLoadMore

   abstract RefreshLayout finishLoadMore(int delayed)

  Finish load more.

  Parameters:

  delayed - Start delay

  Returns:

  RefreshLayout

• finishLoadMore

   abstract RefreshLayout finishLoadMore(boolean success)

  Finish load more.

  Parameters:

  success - Whether data was successful

  Returns:

  RefreshLayout

• finishLoadMore

   abstract RefreshLayout finishLoadMore(int delayed, boolean success, boolean noMoreData)

  Finish load more.

  Parameters:

  delayed - Start delay

  success - Whether data was successful

  noMoreData - Whether there is more data

  Returns:

  RefreshLayout

• finishLoadMoreWithNoMoreData

   abstract RefreshLayout finishLoadMoreWithNoMoreData()

  Finish load more and mark no more data.

  Returns:

  RefreshLayout

• closeHeaderOrFooter

   abstract RefreshLayout closeHeaderOrFooter()

  Close the Header or Footer. Note: this cannot replace finishRefresh and finishLoadMore. 1. closeHeaderOrFooter can close header/footer at any time in any state. 2. finishRefresh and finishLoadMore can only close during refresh or load respectively.

  Returns:

  RefreshLayout

• setNoMoreData

   abstract RefreshLayout setNoMoreData(boolean noMoreData)

  Set the no-more-data state.

  Parameters:

  noMoreData - Whether there is more data

  Returns:

  RefreshLayout Prefer using the following three methods instead, as they synchronize state change with animation end. Use resetNoMoreData use finishRefreshWithNoMoreData use finishLoadMoreWithNoMoreData

• resetNoMoreData

   abstract RefreshLayout resetNoMoreData()

  Restore the original state after finishLoadMoreWithNoMoreData.

  Returns:

  RefreshLayout

• getRefreshHeader

   abstract RefreshHeader getRefreshHeader()

  Get the current Header of RefreshLayout.

  Returns:

  RefreshLayout

• getRefreshFooter

   abstract RefreshFooter getRefreshFooter()

  Get the current Footer of RefreshLayout.

  Returns:

  RefreshLayout

• getState

   abstract RefreshState getState()

  Get the current state of RefreshLayout.

  Returns:

  RefreshLayout

• getLayout

   abstract ViewGroup getLayout()

  Get the ViewGroup of RefreshLayout.

  Returns:

  ViewGroup

• autoRefresh

   abstract boolean autoRefresh()

  Display refresh animation and trigger refresh event.

  Returns:

  true or false, Status non-compliance will fail. true if successful (fails if state is non-compliant)

• autoRefresh

   abstract boolean autoRefresh(int delayed)

  Display refresh animation and trigger refresh event with delayed start.

  Parameters:

  delayed - Start delay

  Returns:

  true or false, Status non-compliance will fail. true if successful (fails if state is non-compliant)

• autoRefreshAnimationOnly

   abstract boolean autoRefreshAnimationOnly()

  Display refresh animation without triggering events.

  Returns:

  true or false, Status non-compliance will fail. true if successful (fails if state is non-compliant)

• autoRefresh

   abstract boolean autoRefresh(int delayed, int duration, float dragRate, boolean animationOnly)

  Display refresh animation with multifunction options.

  Parameters:

  delayed - Start delay

  duration - Drag animation duration

  dragRate - Drag height ratio

  animationOnly - Animation only

  Returns:

  true or false, Status non-compliance will fail. true if successful (fails if state is non-compliant)

• autoLoadMore

   abstract boolean autoLoadMore()

  Display load more animation and trigger load more event.

  Returns:

  true or false, Status non-compliance will fail. true if successful (fails if state is non-compliant)

• autoLoadMore

   abstract boolean autoLoadMore(int delayed)

  Display load more animation and trigger load more event with delayed start.

  Parameters:

  delayed - Start delay

  Returns:

  true or false, Status non-compliance will fail. true if successful (fails if state is non-compliant)

• autoLoadMoreAnimationOnly

   abstract boolean autoLoadMoreAnimationOnly()

  Display load more animation without triggering events.

  Returns:

  true or false, Status non-compliance will fail. true if successful (fails if state is non-compliant)

• autoLoadMore

   abstract boolean autoLoadMore(int delayed, int duration, float dragRate, boolean animationOnly)

  Display load more animation with multifunction options.

  Parameters:

  delayed - Start delay

  duration - Drag animation duration

  dragRate - Drag height ratio

  animationOnly - Whether to only show animation without callbacks

  Returns:

  true or false, Status non-compliance will fail. true if successful (fails if state is non-compliant)

• isRefreshing

   abstract boolean isRefreshing()

  Whether currently refreshing

  Returns:

  RefreshLayout

• isLoading

   abstract boolean isLoading()

  Whether currently loading

  Returns:

  RefreshLayout