com.telerik.widget.list

Class LoadOnDemandBehavior

java.lang.Object

com.telerik.widget.list.ListViewBehavior

com.telerik.widget.list.LoadOnDemandBehavior

public class LoadOnDemandBehavior
extends ListViewBehavior

Represents a ListViewBehavior that can be used to not load all items at start but wait until the user 'demands' more. This can happen when a special button is clicked (when the mode is MANUAL) or when a certain number of items before the end is reached (when mode is AUTOMATIC).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LoadOnDemandBehavior.LoadOnDemandListener Interface definition for a callback to be invoked when load on demand starts or finishes.
static class	LoadOnDemandBehavior.LoadOnDemandMode An enumeration with the different modes that can be used as a parameter for the setMode(com.telerik.widget.list.LoadOnDemandBehavior.LoadOnDemandMode) method.

Constructor Summary

Constructors

Constructor and Description
LoadOnDemandBehavior() Creates a new instance of the LoadOnDemandBehavior with default settings.
LoadOnDemandBehavior(View manualDemandView, View automaticDemandView) Creates a new instance of the LoadOnDemandBehavior which uses the provided views as presenters of the load button in manual mode and the load indicator in automatic mode.

Method Summary

Modifier and Type	Method and Description
void	addListener(LoadOnDemandBehavior.LoadOnDemandListener listener) Adds a listener to be called when items are demanded.
void	endLoad() A method that is used to notify the behavior that the loading is complete.
int	getMaxRemainingItems() Gets the current value of the items remaining that are necessary to invoke loading in the automatic load on demand mode.
LoadOnDemandBehavior.LoadOnDemandMode	getMode() Gets the current LoadOnDemandBehavior.LoadOnDemandMode.
boolean	isEnabled() Gets a value indicating whether the current behavior is enabled.
boolean	isInProgress() Returns true if the current behavior is in progress.
void	onAttached(RadListView listView) Called when the behavior is attached to RadListView with addBehavior(ListViewBehavior).
void	onDetached(RadListView listView) Called when the behavior is detached to RadListView with removeBehavior(ListViewBehavior).
void	removeListener(LoadOnDemandBehavior.LoadOnDemandListener listener) Removes a listener that is called when items are demanded.
void	setEnabled(boolean enabled) Makes the current behavior enabled.
void	setMaxRemainingItems(int maxRemainingItems) Sets a new value for the remaining items that are necessary to invoke loading in the automatic load on demand mode.
void	setMode(LoadOnDemandBehavior.LoadOnDemandMode mode) Sets a new LoadOnDemandBehavior.LoadOnDemandMode.
void	startLoad() A method that initiates loading.

Methods inherited from class com.telerik.widget.list.ListViewBehavior

bindViewHolder, createViewHolder, getItemViewType, managesViewHolders, onActionUpOrCancel, onDispatchDraw, onFling, onInterceptTouchEvent, onLayout, onLongPress, onLongPressDrag, onLongPressDragEnded, onScrolled, onShortPressDrag, onTapUp

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LoadOnDemandBehavior

public LoadOnDemandBehavior()

Creates a new instance of the LoadOnDemandBehavior with default settings.

LoadOnDemandBehavior

public LoadOnDemandBehavior(View manualDemandView,
                            View automaticDemandView)

Creates a new instance of the LoadOnDemandBehavior which uses the provided views as presenters of the load button in manual mode and the load indicator in automatic mode. Please note that if you use this method will have to manually handle the events and the states of your indicators.

Parameters:

manualDemandView - View that represents the load more button.

automaticDemandView - View that represents the loading indicator.

Method Detail

getMaxRemainingItems

public int getMaxRemainingItems()

Gets the current value of the items remaining that are necessary to invoke loading in the automatic load on demand mode. For example, if you initially have 30 items, and you kept the default value, which is 10, when the user sees the 20th item (30 items total - 10 max items remaining), the loading will be initiated.

Returns:

the current max remaining items

setMaxRemainingItems

public void setMaxRemainingItems(int maxRemainingItems)

Sets a new value for the remaining items that are necessary to invoke loading in the automatic load on demand mode. For example, if you initially have 30 items, and you kept the default value, which is 10, when the user sees the 20th item (30 items total - 10 max items remaining), the loading will be initiated.

Parameters:

maxRemainingItems - max remaining items to be used

setEnabled

public void setEnabled(boolean enabled)

Makes the current behavior enabled. True by default.

Parameters:

enabled - whether this behavior should be enabled

isEnabled

public boolean isEnabled()

Gets a value indicating whether the current behavior is enabled. True by default.

Returns:

whether this behavior is enabled

setMode

public void setMode(LoadOnDemandBehavior.LoadOnDemandMode mode)

Sets a new LoadOnDemandBehavior.LoadOnDemandMode. The default value is MANUAL.

Parameters:

mode - whether the user will demand items manually through button or automatically.

getMode

public LoadOnDemandBehavior.LoadOnDemandMode getMode()

Gets the current LoadOnDemandBehavior.LoadOnDemandMode. The default value is MANUAL.

Returns:

whether the user will demand items manually through button or automatically.

addListener

public void addListener(LoadOnDemandBehavior.LoadOnDemandListener listener)

Adds a listener to be called when items are demanded.

Parameters:

listener - the new listener.

removeListener

public void removeListener(LoadOnDemandBehavior.LoadOnDemandListener listener)

Removes a listener that is called when items are demanded.

Parameters:

listener - the listener to remove.

startLoad

public void startLoad()

A method that initiates loading. The default button that is used in manual mode uses this method to invoke the loading when it is clicked.

endLoad

public void endLoad()

A method that is used to notify the behavior that the loading is complete. In manual mode, when it is called the button returns to its enabled state and in automatic the loading indicator disappears.

isInProgress

public boolean isInProgress()

Description copied from class: ListViewBehavior

Returns true if the current behavior is in progress.

Overrides:

isInProgress in class ListViewBehavior

onAttached

public void onAttached(RadListView listView)

Description copied from class: ListViewBehavior

Called when the behavior is attached to RadListView with addBehavior(ListViewBehavior).

Overrides:

onAttached in class ListViewBehavior

Parameters:

listView - The parent list view

onDetached

public void onDetached(RadListView listView)

Description copied from class: ListViewBehavior

Called when the behavior is detached to RadListView with removeBehavior(ListViewBehavior).

Overrides:

onDetached in class ListViewBehavior

Parameters:

listView - The parent list view