com.mikepenz.fastadapter_extensions.utilities

Class SubItemUtil

java.lang.Object

com.mikepenz.fastadapter_extensions.utilities.SubItemUtil

public class SubItemUtil
extends java.lang.Object

Created by flisar on 15.09.2016.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SubItemUtil.IPredicate<T>

Constructor Summary

Constructors

Constructor and Description
SubItemUtil()

Method Summary

Modifier and Type	Method and Description
static int	countItems(IItemAdapter adapter, boolean countHeaders) counts the items in the adapter, respecting subitems regardless of there current visibility
static int	countItems(IItemAdapter adapter, SubItemUtil.IPredicate predicate) counts the items in the adapter, respecting subitems regardless of there current visibility
static <T extends IItem & IExpandable> int	countSelectedSubItems(FastAdapter adapter, T header) counts the selected items in the adapter underneath an expandable item, recursively
static <T extends IItem & IExpandable> int	countSelectedSubItems(java.util.Set<IItem> selections, T header)
static java.util.List<IItem>	delete(FastAdapter fastAdapter, ExpandableExtension expandableExtension, java.util.Collection<java.lang.Long> identifiersToDelete, boolean notifyParent, boolean deleteEmptyHeaders) deletes all items in identifiersToDelete collection from the adapter respecting if there are sub items or not subitems are removed from their parents sublists, main items are directly removed
static java.util.List<IItem>	deleteSelected(FastAdapter fastAdapter, ExpandableExtension expandableExtension, boolean notifyParent, boolean deleteEmptyHeaders) deletes all selected items from the adapter respecting if the are sub items or not subitems are removed from their parents sublists, main items are directly removed Alternatively you might consider also looking at: SelectExtension#deleteAllSelectedItems()
static void	deselect(FastAdapter adapter) Deprecated. See SelectExtension#deselect() ()}
static java.util.List<IItem>	getAllItems(IItemAdapter adapter, boolean countHeaders) retrieves a flat list of the items in the adapter, respecting subitems regardless of there current visibility
static java.util.List<IItem>	getAllItems(IItemAdapter adapter, SubItemUtil.IPredicate predicate) retrieves a flat list of the items in the adapter, respecting subitems regardless of there current visibility
static java.util.List<IItem>	getAllItems(java.util.List<IItem> items, boolean countHeaders, SubItemUtil.IPredicate predicate) retrieves a flat list of the items in the provided list, respecting subitems regardless of there current visibility
static java.util.Set<IItem>	getSelectedItems(FastAdapter adapter) Deprecated. See FastAdapter#getSelectedItems() ()} ()}
static <Item extends IItem & IExpandable> void	notifyItemsChanged(FastAdapter adapter, ExpandableExtension expandableExtension, Item header, java.util.Set<java.lang.Long> identifiers, boolean checkSubItems, boolean restoreExpandedState) notifies items (incl.
static <Item extends IItem & IExpandable> void	notifyItemsChanged(FastAdapter adapter, ExpandableExtension expandableExtension, java.util.Set<java.lang.Long> identifiers) notifies items (incl.
static <Item extends IItem & IExpandable> void	notifyItemsChanged(FastAdapter adapter, ExpandableExtension expandableExtension, java.util.Set<java.lang.Long> identifiers, boolean restoreExpandedState) notifies items (incl.
static <T extends IItem & IExpandable> void	selectAllSubItems(FastAdapter adapter, T header, boolean select) select or unselect all sub itmes underneath an expandable item
static <T extends IItem & IExpandable> void	selectAllSubItems(FastAdapter adapter, T header, boolean select, boolean notifyParent, java.lang.Object payload) select or unselect all sub itmes underneath an expandable item
static boolean	selectItem(FastAdapter adapter, long identifier, boolean select) Deprecated. See SelectExtension#selectByIdentifier(long, boolean, boolean) ()} ()}

Methods inherited from class java.lang.Object

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

Constructor Detail

SubItemUtil

public SubItemUtil()

Method Detail

getSelectedItems

@Deprecated
public static java.util.Set<IItem> getSelectedItems(FastAdapter adapter)

Deprecated. See FastAdapter#getSelectedItems() ()} ()}

returns a set of selected items, regardless of their visibility

Parameters:

adapter - the adapter instance

Returns:

a set of all selected items and subitems

countItems

public static int countItems(IItemAdapter adapter,
                             SubItemUtil.IPredicate predicate)

counts the items in the adapter, respecting subitems regardless of there current visibility

Parameters:

adapter - the adapter instance

predicate - predicate against which each item will be checked before counting it

Returns:

number of items in the adapter that apply to the predicate

countItems

public static int countItems(IItemAdapter adapter,
                             boolean countHeaders)

counts the items in the adapter, respecting subitems regardless of there current visibility

Parameters:

adapter - the adapter instance

countHeaders - if true, headers will be counted as well

Returns:

number of items in the adapter

getAllItems

public static java.util.List<IItem> getAllItems(IItemAdapter adapter,
                                                SubItemUtil.IPredicate predicate)

retrieves a flat list of the items in the adapter, respecting subitems regardless of there current visibility

Parameters:

adapter - the adapter instance

predicate - predicate against which each item will be checked before adding it to the result

Returns:

list of items in the adapter that apply to the predicate

getAllItems

public static java.util.List<IItem> getAllItems(IItemAdapter adapter,
                                                boolean countHeaders)

retrieves a flat list of the items in the adapter, respecting subitems regardless of there current visibility

Parameters:

adapter - the adapter instance

countHeaders - if true, headers will be counted as well

Returns:

list of items in the adapter

getAllItems

public static java.util.List<IItem> getAllItems(java.util.List<IItem> items,
                                                boolean countHeaders,
                                                SubItemUtil.IPredicate predicate)

retrieves a flat list of the items in the provided list, respecting subitems regardless of there current visibility

Parameters:

items - the list of items to process

countHeaders - if true, headers will be counted as well

Returns:

list of items in the adapter

countSelectedSubItems

public static <T extends IItem & IExpandable> int countSelectedSubItems(FastAdapter adapter,
                                                                        T header)

counts the selected items in the adapter underneath an expandable item, recursively

Parameters:

adapter - the adapter instance

header - the header who's selected children should be counted

Returns:

number of selected items underneath the header

countSelectedSubItems

public static <T extends IItem & IExpandable> int countSelectedSubItems(java.util.Set<IItem> selections,
                                                                        T header)

selectAllSubItems

public static <T extends IItem & IExpandable> void selectAllSubItems(FastAdapter adapter,
                                                                     T header,
                                                                     boolean select)

select or unselect all sub itmes underneath an expandable item

Parameters:

adapter - the adapter instance

header - the header who's children should be selected or deselected

select - the new selected state of the sub items

selectAllSubItems

public static <T extends IItem & IExpandable> void selectAllSubItems(FastAdapter adapter,
                                                                     T header,
                                                                     boolean select,
                                                                     boolean notifyParent,
                                                                     java.lang.Object payload)

select or unselect all sub itmes underneath an expandable item

Parameters:

adapter - the adapter instance

header - the header who's children should be selected or deselected

select - the new selected state of the sub items

notifyParent - true, if the parent should be notified about the changes of its children selection state

payload - payload for the notifying function

selectItem

@Deprecated
public static boolean selectItem(FastAdapter adapter,
                                             long identifier,
                                             boolean select)

Deprecated. See SelectExtension#selectByIdentifier(long, boolean, boolean) ()} ()}

select or unselect an item with the given identifier This will not handle the `only one selected` case. Please deselect all items first for this requirement.

Parameters:

adapter - the adapter instance

identifier - the identifier of the item to select / deselect

select - the new selected state of the sub items

deselect

@Deprecated
public static void deselect(FastAdapter adapter)

Deprecated. See SelectExtension#deselect() ()}

deselects all items including all subitems

Parameters:

adapter - the adapter instance

deleteSelected

public static java.util.List<IItem> deleteSelected(FastAdapter fastAdapter,
                                                   ExpandableExtension expandableExtension,
                                                   boolean notifyParent,
                                                   boolean deleteEmptyHeaders)

deletes all selected items from the adapter respecting if the are sub items or not subitems are removed from their parents sublists, main items are directly removed Alternatively you might consider also looking at: SelectExtension#deleteAllSelectedItems()

Parameters:

deleteEmptyHeaders - if true, empty headers will be removed from the adapter

Returns:

List of items that have been removed from the adapter

delete

public static java.util.List<IItem> delete(FastAdapter fastAdapter,
                                           ExpandableExtension expandableExtension,
                                           java.util.Collection<java.lang.Long> identifiersToDelete,
                                           boolean notifyParent,
                                           boolean deleteEmptyHeaders)

deletes all items in identifiersToDelete collection from the adapter respecting if there are sub items or not subitems are removed from their parents sublists, main items are directly removed

Parameters:

fastAdapter - the adapter to remove the items from

identifiersToDelete - ids of items to remove

notifyParent - if true, headers of removed items will be notified about the change of their child items

deleteEmptyHeaders - if true, empty headers will be removed from the adapter

Returns:

List of items that have been removed from the adapter

notifyItemsChanged

public static <Item extends IItem & IExpandable> void notifyItemsChanged(FastAdapter adapter,
                                                                         ExpandableExtension expandableExtension,
                                                                         java.util.Set<java.lang.Long> identifiers)

notifies items (incl. sub items if they are currently extended)

Parameters:

adapter - the adapter

identifiers - set of identifiers that should be notified

notifyItemsChanged

public static <Item extends IItem & IExpandable> void notifyItemsChanged(FastAdapter adapter,
                                                                         ExpandableExtension expandableExtension,
                                                                         java.util.Set<java.lang.Long> identifiers,
                                                                         boolean restoreExpandedState)

notifies items (incl. sub items if they are currently extended)

Parameters:

adapter - the adapter

identifiers - set of identifiers that should be notified

restoreExpandedState - true, if expanded headers should stay expanded

notifyItemsChanged

public static <Item extends IItem & IExpandable> void notifyItemsChanged(FastAdapter adapter,
                                                                         ExpandableExtension expandableExtension,
                                                                         Item header,
                                                                         java.util.Set<java.lang.Long> identifiers,
                                                                         boolean checkSubItems,
                                                                         boolean restoreExpandedState)

notifies items (incl. sub items if they are currently extended)

Parameters:

adapter - the adapter

header - the expandable header that should be checked (incl. sub items)

identifiers - set of identifiers that should be notified

checkSubItems - true, if sub items of headers items should be checked recursively

restoreExpandedState - true, if expanded headers should stay expanded