com.mikepenz.fastadapter_extensions

Class RangeSelectorHelper

java.lang.Object

com.mikepenz.fastadapter_extensions.RangeSelectorHelper

public class RangeSelectorHelper
extends java.lang.Object

Created by Michael on 15.09.2016.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	BUNDLE_LAST_LONG_PRESS

Constructor Summary

Constructors

Constructor and Description
RangeSelectorHelper(FastItemAdapter adapter)

Method Summary

Modifier and Type	Method and Description
void	onClick() resets the last long pressed index, we only want to respect two consecutive long clicks for selecting a range of items
boolean	onLongClick(int index) will take care to save the long pressed index or to select all items in the range between the current long pressed item and the last long pressed item
boolean	onLongClick(int index, boolean selectItem) will take care to save the long pressed index or to select all items in the range between the current long pressed item and the last long pressed item
void	reset() resets the last long pressed index, we only want to respect two consecutive long presses for selecting a range of items
android.os.Bundle	saveInstanceState(android.os.Bundle savedInstanceState) add the values to the bundle for saveInstanceState
android.os.Bundle	saveInstanceState(android.os.Bundle savedInstanceState, java.lang.String prefix) add the values to the bundle for saveInstanceState
<T extends IItem & IExpandable> void	selectRange(int from, int to, boolean select) selects all items in a range, from and to indizes are inclusive
<T extends IItem & IExpandable> void	selectRange(int from, int to, boolean select, boolean skipHeaders) selects all items in a range, from and to indizes are inclusive
RangeSelectorHelper	withActionModeHelper(ActionModeHelper actionModeHelper) set the ActionModeHelper, if you want to notify it after a range was selected so that it can update the ActionMode title
RangeSelectorHelper	withPayload(java.lang.Object payload) the provided payload will be passed to the adapters notify function, if one is provided
RangeSelectorHelper	withSavedInstanceState(android.os.Bundle savedInstanceState) restore the index of the last long pressed index
RangeSelectorHelper	withSavedInstanceState(android.os.Bundle savedInstanceState, java.lang.String prefix) restore the index of the last long pressed index IMPORTANT! Call this method only after all items where added to the adapters again.
RangeSelectorHelper	withSupportSubItems(boolean supportSubItems) enable this, if you want the range selector to correclty handle sub items as well

Methods inherited from class java.lang.Object

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

Field Detail

BUNDLE_LAST_LONG_PRESS

protected static final java.lang.String BUNDLE_LAST_LONG_PRESS

See Also:

Constant Field Values

Constructor Detail

RangeSelectorHelper

public RangeSelectorHelper(FastItemAdapter adapter)

Method Detail

withActionModeHelper

public RangeSelectorHelper withActionModeHelper(ActionModeHelper actionModeHelper)

set the ActionModeHelper, if you want to notify it after a range was selected so that it can update the ActionMode title

Parameters:

actionModeHelper - the action mode helper that should be used

Returns:

this, for supporting function call chaining

withSupportSubItems

public RangeSelectorHelper withSupportSubItems(boolean supportSubItems)

enable this, if you want the range selector to correclty handle sub items as well

Parameters:

supportSubItems - true, if sub items are supported, false otherwise

Returns:

this, for supporting function call chaining

withPayload

public RangeSelectorHelper withPayload(java.lang.Object payload)

the provided payload will be passed to the adapters notify function, if one is provided

Parameters:

payload - the paylaod that should be passed to the adapter on selection state change

Returns:

this, for supporting function call chaining

onClick

public void onClick()

resets the last long pressed index, we only want to respect two consecutive long clicks for selecting a range of items

reset

public void reset()

resets the last long pressed index, we only want to respect two consecutive long presses for selecting a range of items

onLongClick

public boolean onLongClick(int index)

will take care to save the long pressed index or to select all items in the range between the current long pressed item and the last long pressed item

Parameters:

index - the index of the long pressed item

Returns:

true, if the long press was handled

onLongClick

public boolean onLongClick(int index,
                           boolean selectItem)

will take care to save the long pressed index or to select all items in the range between the current long pressed item and the last long pressed item

Parameters:

index - the index of the long pressed item

selectItem - true, if the item at the index should be selected, false if this was already done outside of this helper or is not desired

Returns:

true, if the long press was handled

selectRange

public <T extends IItem & IExpandable> void selectRange(int from,
                                                        int to,
                                                        boolean select)

selects all items in a range, from and to indizes are inclusive

Parameters:

from - the from index

to - the to index

select - true, if the provided range should be selected, false otherwise

selectRange

public <T extends IItem & IExpandable> void selectRange(int from,
                                                        int to,
                                                        boolean select,
                                                        boolean skipHeaders)

selects all items in a range, from and to indizes are inclusive

Parameters:

from - the from index

to - the to index

select - true, if the provided range should be selected, false otherwise

skipHeaders - true, if you do not want to process headers, false otherwise

saveInstanceState

public android.os.Bundle saveInstanceState(android.os.Bundle savedInstanceState)

add the values to the bundle for saveInstanceState

Parameters:

savedInstanceState - If the activity is being re-initialized after previously being shut down then this Bundle contains the data it most recently supplied in Note: Otherwise it is null.

Returns:

the passed bundle with the newly added data

saveInstanceState

public android.os.Bundle saveInstanceState(android.os.Bundle savedInstanceState,
                                           java.lang.String prefix)

add the values to the bundle for saveInstanceState

Parameters:

savedInstanceState - If the activity is being re-initialized after previously being shut down then this Bundle contains the data it most recently supplied in Note: Otherwise it is null.

prefix - a prefix added to the savedInstance key so we can store multiple states

Returns:

the passed bundle with the newly added data

withSavedInstanceState

public RangeSelectorHelper withSavedInstanceState(android.os.Bundle savedInstanceState)

restore the index of the last long pressed index

Parameters:

savedInstanceState - If the activity is being re-initialized after previously being shut down then this Bundle contains the data it most recently supplied in Note: Otherwise it is null.

Returns:

this

withSavedInstanceState

public RangeSelectorHelper withSavedInstanceState(android.os.Bundle savedInstanceState,
                                                  java.lang.String prefix)

restore the index of the last long pressed index IMPORTANT! Call this method only after all items where added to the adapters again. Otherwise it may select wrong items!

Parameters:

savedInstanceState - If the activity is being re-initialized after previously being shut down then this Bundle contains the data it most recently supplied in Note: Otherwise it is null.

prefix - a prefix added to the savedInstance key so we can store multiple states

Returns:

this