DonkyMessagingBaseListFragment (messagingui API)

java.lang.Object
- Fragment
- - net.donky.core.messaging.ui.components.DonkyFragment
  - - net.donky.core.messaging.ui.components.generic.DonkyMessagingBaseListFragment<T,GFT,CAT>

All Implemented Interfaces:

DeletionListener, DetailViewDisplayedListener, DualPaneLeftFragment, DualPaneModeListener, GenericBuilder<GFT>, MultipleSelectionListener, Selectable<T>
```
public abstract class DonkyMessagingBaseListFragment<T,GFT,CAT extends CursorAdapterWithImageCache>
extends DonkyFragment
implements MultipleSelectionListener, DualPaneLeftFragment, Selectable<T>, GenericBuilder<GFT>, DetailViewDisplayedListener, DeletionListener
```
Fragment providing setup for list fragments in Donky Messaging. Created by Marcin Swierczek 27/06/15 Copyright (C) Donky Networks Ltd. All rights reserved.

Field Summary

Fields
Modifier and Type	Field and Description
`protected android.content.Context`	`appContext`
`static java.lang.String`	`KEY_MULTIPLE_IDS_SELECTED_TO_DELETE`
`static java.lang.String`	`KEY_SINGLE_ID_SELECTED`
`static java.lang.String`	`KEY_SINGLE_ID_SELECTED_TO_DELETE`
`static java.lang.String`	`KEY_SINGLE_POSITION_SELECTED`

Constructor Summary

Constructors
Constructor and Description

DonkyMessagingBaseListFragment()

Constructors
Constructor and Description
`DonkyMessagingBaseListFragment()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract void`	`checkListItem(java.lang.String contentId)`
`protected void`	`clearListViewMultipleSelectionState(int checkboxResourceId)` Clear the state of list view when exiting Action Mode.
`protected void`	`clearListViewSingleSelection()` Clears dual pane list row selection.
`android.view.ActionMode`	`getActionMode()` Get the ActionMode object.
`protected abstract CAT`	`getAdapter()` Get `CursorAdapterWithImageCache` set for parent class.
`android.widget.ListView`	`getListView()` Gets the list view.
`protected android.util.Pair<java.lang.String,java.lang.Integer>`	`getSelection()` Gets the dual pane selection.
`SelectionListener<T>`	`getSelectionListener()` Gets the listener for list row selections.
`java.lang.String`	`getSingleSelectedIdToDelete()` Gets the id of item marked as to be deleted.
`protected void`	`hideMultiChoiceModeAnimation(int checkboxResourceId)` Animate transition to list view standard mode.
`boolean`	`isDualPane()` Mode split view fragment.
`void`	`onActivityCreated(android.os.Bundle savedInstanceState)`
`void`	`onDestroy()`
`void`	`onMessageDisplayed(java.lang.String contentId)`
`void`	`onMultipleSelectionChanged()` The selected rows in multi-selection mode changed.
`void`	`onPause()`
`void`	`onResume()`
`void`	`onSaveInstanceState(android.os.Bundle outState)`
`void`	`onStart()`
`protected abstract void`	`refreshListView()` refresh list view content.
`protected abstract void`	`searchViewActionClosed()` Search view has been closed callback.
`protected abstract void`	`searchViewActionOpened()` Search view has been opened callback.
`void`	`setActionMode(android.view.ActionMode actionMode)` Sets the Action mode.
`void`	`setIsInDualPaneDisplayMode(boolean dualPane)` Sets the display mode
`void`	`setListView(android.widget.ListView listView)` Stets the list view.
`protected void`	`setOverlayVisibility(int visibility)` Change detail view overlay visibility.
`void`	`setOverlayVisibilityController(OverlayVisibilityController overlayVisibilityController)` Set the interface to change overlay visibility
`protected void`	`setSelection(java.lang.String selectedInternalDataBaseID, java.lang.Integer listViewPosition)` Sets selection for dual pane mode.
`void`	`setSelectionListener(SelectionListener<T> selectionListener)` Sets the listener for generic class object selection.
`void`	`setSingleSelectedIdToDelete(java.lang.String singleSelectedIdToDelete)` Sets the id of item marked as to be deleted.
`protected void`	`setSwipeToRefreshLayouts(SwipeRefreshLayout swipeRefreshLayout, SwipeRefreshLayout swipeRefreshLayoutEmptyList)` Pass swipe to refresh layouts in onCreateView method.
`protected void`	`setupOptionsPopup(ListPopupWindow popup, android.view.View richMsgListElementAnchorView, android.widget.ArrayAdapter arrayAdapter, android.widget.AdapterView.OnItemClickListener onItemClickListener)` Setup the window list option menu.
`protected void`	`setupSearchMenuItem(android.view.MenuItem searchMenuItem, android.widget.CursorAdapter adapter)` Setup search view.
`protected void`	`setupSwipeToRefreshLayouts()` Set listeners for swipe to refresh widgets.
`protected void`	`showMultiChoiceModeAnimation(int checkboxResourceId)` Animate transition to list view multi-choice mode.
`protected void`	`startUpdateTimestampsTimer()` Start the timer periodically calling `updateTimestamps()`.
`protected void`	`stopUpdateTimestampsTimer()` Stops the timer periodically calling `updateTimestamps()`.
`protected abstract void`	`updateTimestamps()` Update visible timestamps in list elements.

Methods inherited from class net.donky.core.messaging.ui.components.DonkyFragment
hideSoftKeyboard, onDetach

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.donky.core.messaging.ui.components.generic.GenericBuilder
build

Methods inherited from interface net.donky.core.messaging.ui.components.generic.DeletionListener
onContentDeleted

- Field Detail
  - KEY_SINGLE_POSITION_SELECTED
```
public static java.lang.String KEY_SINGLE_POSITION_SELECTED
```
  - KEY_SINGLE_ID_SELECTED
```
public static java.lang.String KEY_SINGLE_ID_SELECTED
```
  - KEY_SINGLE_ID_SELECTED_TO_DELETE
```
public static java.lang.String KEY_SINGLE_ID_SELECTED_TO_DELETE
```
  - KEY_MULTIPLE_IDS_SELECTED_TO_DELETE
```
public static java.lang.String KEY_MULTIPLE_IDS_SELECTED_TO_DELETE
```
  - appContext
```
protected android.content.Context appContext
```
- Constructor Detail
  - DonkyMessagingBaseListFragment
```
public DonkyMessagingBaseListFragment()
```
- Method Detail
  - onActivityCreated
```
public void onActivityCreated(android.os.Bundle savedInstanceState)
```
  - onStart
```
public void onStart()
```
  - onResume
```
public void onResume()
```
  - onPause
```
public void onPause()
```
  - onDestroy
```
public void onDestroy()
```
  - onSaveInstanceState
```
public void onSaveInstanceState(android.os.Bundle outState)
```
  - setupSearchMenuItem
```
protected void setupSearchMenuItem(android.view.MenuItem searchMenuItem,
                                   android.widget.CursorAdapter adapter)
```
    Setup search view. Apply listeners and icons.
    
    Parameters:
    
    searchMenuItem - Menu Item with the search widget.
    
    adapter - Cursor adapter providing data to filtered list view.
  - setSwipeToRefreshLayouts
```
protected void setSwipeToRefreshLayouts(SwipeRefreshLayout swipeRefreshLayout,
                                        SwipeRefreshLayout swipeRefreshLayoutEmptyList)
```
    Pass swipe to refresh layouts in onCreateView method.
    
    Parameters:
    
    swipeRefreshLayout - Layout embedding list view with swipe to refresh widget.
    
    swipeRefreshLayoutEmptyList - Layout embedding empty list view TextView with swipe to refresh widget.
  - setupSwipeToRefreshLayouts
```
protected void setupSwipeToRefreshLayouts()
```
    Set listeners for swipe to refresh widgets.
  - clearListViewSingleSelection
```
protected void clearListViewSingleSelection()
```
    Clears dual pane list row selection.
  - setSelection
```
protected void setSelection(java.lang.String selectedInternalDataBaseID,
                            java.lang.Integer listViewPosition)
```
    Sets selection for dual pane mode.
    
    Parameters:
    
    selectedInternalDataBaseID - The row content id.
    
    listViewPosition - The position of selected row in list view.
  - getSelection
```
protected android.util.Pair<java.lang.String,java.lang.Integer> getSelection()
```
    Gets the dual pane selection.
    
    Returns:
    
    Pair of row content id and position in list view.
  - getSingleSelectedIdToDelete
```
public java.lang.String getSingleSelectedIdToDelete()
```
    Gets the id of item marked as to be deleted.
    
    Returns:
    
    Id of item top delete
  - setSingleSelectedIdToDelete
```
public void setSingleSelectedIdToDelete(java.lang.String singleSelectedIdToDelete)
```
    Sets the id of item marked as to be deleted.
    
    Parameters:
    
    singleSelectedIdToDelete - Id of item top delete
  - isDualPane
```
public boolean isDualPane()
```
    Mode split view fragment.
    
    Returns:
    
    True if there are two fragments visible, list and detail.
  - getSelectionListener
```
public SelectionListener<T> getSelectionListener()
```
    Gets the listener for list row selections. Usually detail fragment.
    
    Returns:
    
    Listener for list row selections.
  - getListView
```
public android.widget.ListView getListView()
```
    Gets the list view.
    
    Returns:
    
    List View
  - setListView
```
public void setListView(android.widget.ListView listView)
```
    Stets the list view. Usually the parent class.
    
    Parameters:
    
    listView - ListView to be set.
  - getActionMode
```
public android.view.ActionMode getActionMode()
```
    Get the ActionMode object. Not null only when action mode is active.
    
    Returns:
    
    Toolbar ActionMode object or null if action mode is not active.
  - setActionMode
```
public void setActionMode(android.view.ActionMode actionMode)
```
    Sets the Action mode. Usually by parent class.
    
    Parameters:
    
    actionMode - Toolbar ActionMode object or null if action mode is not active.
  - startUpdateTimestampsTimer
```
protected void startUpdateTimestampsTimer()
```
    Start the timer periodically calling updateTimestamps(). Should be called in Fragment onResume.
  - stopUpdateTimestampsTimer
```
protected void stopUpdateTimestampsTimer()
```
    Stops the timer periodically calling updateTimestamps(). Should be called in Fragment onPause.
  - setupOptionsPopup
```
protected void setupOptionsPopup(ListPopupWindow popup,
                                 android.view.View richMsgListElementAnchorView,
                                 android.widget.ArrayAdapter arrayAdapter,
                                 android.widget.AdapterView.OnItemClickListener onItemClickListener)
```
    Setup the window list option menu. Offset, position etc.
    
    Parameters:
    
    popup - List popup window instance
    
    richMsgListElementAnchorView - The selected list row view
    
    arrayAdapter - Adapter with array of options
    
    onItemClickListener - List item click listener.
  - showMultiChoiceModeAnimation
```
protected void showMultiChoiceModeAnimation(int checkboxResourceId)
```
    Animate transition to list view multi-choice mode.
    
    Parameters:
    
    checkboxResourceId - Resource id of list element checkbox.
  - hideMultiChoiceModeAnimation
```
protected void hideMultiChoiceModeAnimation(int checkboxResourceId)
```
    Animate transition to list view standard mode.
    
    Parameters:
    
    checkboxResourceId - Resource id of list element checkbox.
  - clearListViewMultipleSelectionState
```
protected void clearListViewMultipleSelectionState(int checkboxResourceId)
```
    Clear the state of list view when exiting Action Mode.
  - setOverlayVisibility
```
protected void setOverlayVisibility(int visibility)
```
    Change detail view overlay visibility.
    
    Parameters:
    
    visibility - View.VISIBLE, View.GONE or View.INVISIBLE
  - refreshListView
```
protected abstract void refreshListView()
```
    refresh list view content.
  - updateTimestamps
```
protected abstract void updateTimestamps()
```
    Update visible timestamps in list elements.
  - getAdapter
```
protected abstract CAT getAdapter()
```
    Get CursorAdapterWithImageCache set for parent class.
    
    Returns:
  - searchViewActionClosed
```
protected abstract void searchViewActionClosed()
```
    Search view has been closed callback.
  - searchViewActionOpened
```
protected abstract void searchViewActionOpened()
```
    Search view has been opened callback.
  - checkListItem
```
protected abstract void checkListItem(java.lang.String contentId)
```
  - onMultipleSelectionChanged
```
public void onMultipleSelectionChanged()
```
    Description copied from interface: MultipleSelectionListener
    
    The selected rows in multi-selection mode changed.
    
    Specified by:
    
    onMultipleSelectionChanged in interface MultipleSelectionListener
  - setIsInDualPaneDisplayMode
```
public void setIsInDualPaneDisplayMode(boolean dualPane)
```
    Description copied from interface: DualPaneModeListener
    
    Sets the display mode
    
    Specified by:
    
    setIsInDualPaneDisplayMode in interface DualPaneModeListener
    
    Parameters:
    
    dualPane - True if two fragments are visible.
  - setSelectionListener
```
public void setSelectionListener(SelectionListener<T> selectionListener)
```
    Description copied from interface: Selectable
    
    Sets the listener for generic class object selection.
    
    Specified by:
    
    setSelectionListener in interface Selectable<T>
    
    Parameters:
    
    selectionListener - Listener to set.
  - onMessageDisplayed
```
public void onMessageDisplayed(java.lang.String contentId)
```
    Specified by:
    
    onMessageDisplayed in interface DetailViewDisplayedListener
  - setOverlayVisibilityController
```
public void setOverlayVisibilityController(OverlayVisibilityController overlayVisibilityController)
```
    Description copied from interface: DualPaneLeftFragment
    
    Set the interface to change overlay visibility
    
    Specified by:
    
    setOverlayVisibilityController in interface DualPaneLeftFragment
    
    Parameters:
    
    overlayVisibilityController - Interface to change overlay visibility

Class DonkyMessagingBaseListFragment<T,GFT,CAT extends CursorAdapterWithImageCache>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class net.donky.core.messaging.ui.components.DonkyFragment

Methods inherited from class java.lang.Object

Methods inherited from interface net.donky.core.messaging.ui.components.generic.GenericBuilder

Methods inherited from interface net.donky.core.messaging.ui.components.generic.DeletionListener

Field Detail

KEY_SINGLE_POSITION_SELECTED

KEY_SINGLE_ID_SELECTED

KEY_SINGLE_ID_SELECTED_TO_DELETE

KEY_MULTIPLE_IDS_SELECTED_TO_DELETE

appContext

Constructor Detail

DonkyMessagingBaseListFragment

Method Detail

onActivityCreated

onStart

onResume

onPause

onDestroy

onSaveInstanceState

setupSearchMenuItem

setSwipeToRefreshLayouts

setupSwipeToRefreshLayouts

clearListViewSingleSelection

setSelection

getSelection

getSingleSelectedIdToDelete

setSingleSelectedIdToDelete

isDualPane

getSelectionListener

getListView

setListView

getActionMode

setActionMode

startUpdateTimestampsTimer

stopUpdateTimestampsTimer

setupOptionsPopup

showMultiChoiceModeAnimation

hideMultiChoiceModeAnimation

clearListViewMultipleSelectionState

setOverlayVisibility

refreshListView

updateTimestamps

getAdapter

searchViewActionClosed

searchViewActionOpened

checkListItem

onMultipleSelectionChanged

setIsInDualPaneDisplayMode

setSelectionListener

onMessageDisplayed

setOverlayVisibilityController