Package com.stfalcon.chatkit.messages

Class MessagesListAdapter<MESSAGE extends IMessage>

java.lang.Object

android.support.v7.widget.RecyclerView.Adapter<ViewHolder>

com.stfalcon.chatkit.messages.MessagesListAdapter<MESSAGE>

public class MessagesListAdapter<MESSAGE extends IMessage>
extends android.support.v7.widget.RecyclerView.Adapter<ViewHolder>

Adapter for MessagesList.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MessagesListAdapter.BaseMessageViewHolder<MESSAGE extends IMessage>	Deprecated.
static class	MessagesListAdapter.DefaultDateHeaderViewHolder	Deprecated.
static interface	MessagesListAdapter.Formatter<MESSAGE>	Interface used to format your message model when copying.
static class	MessagesListAdapter.HoldersConfig	Deprecated.
static class	MessagesListAdapter.IncomingMessageViewHolder<MESSAGE extends IMessage>	Deprecated.
static interface	MessagesListAdapter.OnLoadMoreListener	Interface definition for a callback to be invoked when next part of messages need to be loaded.
static interface	MessagesListAdapter.OnMessageClickListener<MESSAGE extends IMessage>	Interface definition for a callback to be invoked when message item is clicked.
static interface	MessagesListAdapter.OnMessageLongClickListener<MESSAGE extends IMessage>	Interface definition for a callback to be invoked when message item is long clicked.
static interface	MessagesListAdapter.OnMessageViewClickListener<MESSAGE extends IMessage>	Interface definition for a callback to be invoked when message view is clicked.
static interface	MessagesListAdapter.OnMessageViewLongClickListener<MESSAGE extends IMessage>	Interface definition for a callback to be invoked when message view is long clicked.
static class	MessagesListAdapter.OutcomingMessageViewHolder<MESSAGE extends IMessage>	Deprecated.
static interface	MessagesListAdapter.SelectionListener	Interface definition for a callback to be invoked when selected messages count is changed.
class	MessagesListAdapter.Wrapper<DATA>

Field Summary

Fields

Modifier and Type	Field	Description
protected static boolean	isSelectionModeEnabled
protected java.util.List<MessagesListAdapter.Wrapper>	items

Constructor Summary

Constructors

Constructor	Description
MessagesListAdapter(java.lang.String senderId, ImageLoader imageLoader)	For default list item layout and view holder.
MessagesListAdapter(java.lang.String senderId, MessageHolders holders, ImageLoader imageLoader)	For default list item layout and view holder.

Method Summary

Modifier and Type	Method	Description
void	addToEnd(java.util.List<MESSAGE> messages, boolean reverse)	Adds messages list in chronological order.
void	addToStart(MESSAGE message, boolean scroll)	Adds message to bottom of list and scroll if needed.
void	clear()	Clears the messages list.
void	clear(boolean notifyDataSetChanged)	Clears the messages list.
java.lang.String	copySelectedMessagesText(android.content.Context context, MessagesListAdapter.Formatter<MESSAGE> formatter, boolean reverse)	Copies text to device clipboard and returns selected messages text.
void	delete(java.util.List<MESSAGE> messages)	Deletes messages list.
void	delete(MESSAGE message)	Deletes message.
void	deleteById(java.lang.String id)	Deletes message by its identifier.
void	deleteByIds(java.lang.String[] ids)	Deletes messages by its identifiers.
void	deleteSelectedMessages()	Deletes all of the selected messages and disables selection mode.
void	disableSelectionMode()	Disables selection mode and removes MessagesListAdapter.SelectionListener.
void	enableSelectionMode(MessagesListAdapter.SelectionListener selectionListener)	Enables selection mode.
protected void	generateDateHeaders(java.util.List<MESSAGE> messages)
int	getItemCount()
int	getItemViewType(int position)
int	getMessagesCount()
java.util.ArrayList<MESSAGE>	getSelectedMessages()	Returns the list of selected messages.
java.lang.String	getSelectedMessagesText(MessagesListAdapter.Formatter<MESSAGE> formatter, boolean reverse)	Returns selected messages text and do unselectAllItems() for you.
boolean	isEmpty()	Returns true if, and only if, messages count in adapter is non-zero.
void	onBindViewHolder(ViewHolder holder, int position)
ViewHolder	onCreateViewHolder(android.view.ViewGroup parent, int viewType)
void	onLoadMore(int page, int total)
void	registerViewClickListener(int viewId, MessagesListAdapter.OnMessageViewClickListener<MESSAGE> onMessageViewClickListener)	Registers click listener for view by id
void	setDateHeadersFormatter(DateFormatter.Formatter dateHeadersFormatter)	Sets custom DateFormatter.Formatter for text representation of date headers.
void	setLoadMoreListener(MessagesListAdapter.OnLoadMoreListener loadMoreListener)	Set callback to be invoked when list scrolled to top.
void	setOnMessageClickListener(MessagesListAdapter.OnMessageClickListener<MESSAGE> onMessageClickListener)	Sets click listener for item.
void	setOnMessageLongClickListener(MessagesListAdapter.OnMessageLongClickListener<MESSAGE> onMessageLongClickListener)	Sets long click listener for item.
void	setOnMessageViewClickListener(MessagesListAdapter.OnMessageViewClickListener<MESSAGE> onMessageViewClickListener)	Sets click listener for message view.
void	setOnMessageViewLongClickListener(MessagesListAdapter.OnMessageViewLongClickListener<MESSAGE> onMessageViewLongClickListener)	Sets long click listener for message view.
void	unselectAllItems()	Unselect all of the selected messages.
boolean	update(java.lang.String oldId, MESSAGE newMessage)	Updates message by old identifier (use this method if id has changed).
boolean	update(MESSAGE message)	Updates message by its id.
void	updateAndMoveToStart(MESSAGE newMessage)	Moves the elements position from current to start
void	upsert(MESSAGE message)	Updates message by its id if it exists, add to start if not
void	upsert(MESSAGE message, boolean moveToStartIfUpdate)	Updates and moves to start if message by its id exists and if specified move to start, if not specified the item stays at current position and updated

Methods inherited from class java.lang.Object

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

Methods inherited from class android.support.v7.widget.RecyclerView.Adapter

bindViewHolder, createViewHolder, getItemId, hasObservers, hasStableIds, notifyDataSetChanged, notifyItemChanged, notifyItemChanged, notifyItemInserted, notifyItemMoved, notifyItemRangeChanged, notifyItemRangeChanged, notifyItemRangeInserted, notifyItemRangeRemoved, notifyItemRemoved, onAttachedToRecyclerView, onBindViewHolder, onDetachedFromRecyclerView, onFailedToRecycleView, onViewAttachedToWindow, onViewDetachedFromWindow, onViewRecycled, registerAdapterDataObserver, setHasStableIds, unregisterAdapterDataObserver

Field Detail

isSelectionModeEnabled

protected static boolean isSelectionModeEnabled

items

protected java.util.List<MessagesListAdapter.Wrapper> items

Constructor Detail

MessagesListAdapter

public MessagesListAdapter(java.lang.String senderId,
                           ImageLoader imageLoader)

For default list item layout and view holder.

Parameters:

senderId - identifier of sender.

imageLoader - image loading method.

MessagesListAdapter

public MessagesListAdapter(java.lang.String senderId,
                           MessageHolders holders,
                           ImageLoader imageLoader)

For default list item layout and view holder.

Parameters:

senderId - identifier of sender.

holders - custom layouts and view holders. See MessageHolders documentation for details

imageLoader - image loading method.

Method Detail

onCreateViewHolder

public ViewHolder onCreateViewHolder(android.view.ViewGroup parent,
                                     int viewType)

Specified by:

onCreateViewHolder in class android.support.v7.widget.RecyclerView.Adapter<ViewHolder>

onBindViewHolder

public void onBindViewHolder(ViewHolder holder,
                             int position)

Specified by:

onBindViewHolder in class android.support.v7.widget.RecyclerView.Adapter<ViewHolder>

getItemCount

public int getItemCount()

Specified by:

getItemCount in class android.support.v7.widget.RecyclerView.Adapter<ViewHolder>

getItemViewType

public int getItemViewType(int position)

Overrides:

getItemViewType in class android.support.v7.widget.RecyclerView.Adapter<ViewHolder>

onLoadMore

public void onLoadMore(int page,
                       int total)

getMessagesCount

public int getMessagesCount()

addToStart

public void addToStart(MESSAGE message,
                       boolean scroll)

Adds message to bottom of list and scroll if needed.

Parameters:

message - message to add.

scroll - true if need to scroll list to bottom when message added.

addToEnd

public void addToEnd(java.util.List<MESSAGE> messages,
                     boolean reverse)

Adds messages list in chronological order. Use this method to add history.

Parameters:

messages - messages from history.

reverse - true if need to reverse messages before adding.

update

public boolean update(MESSAGE message)

Updates message by its id.

Parameters:

message - updated message object.

update

public boolean update(java.lang.String oldId,
                      MESSAGE newMessage)

Updates message by old identifier (use this method if id has changed). Otherwise use update(IMessage)

Parameters:

oldId - an identifier of message to update.

newMessage - new message object.

updateAndMoveToStart

public void updateAndMoveToStart(MESSAGE newMessage)

Moves the elements position from current to start

Parameters:

newMessage - new message object.

upsert

public void upsert(MESSAGE message)

Updates message by its id if it exists, add to start if not

Parameters:

message - message object to insert or update.

upsert

public void upsert(MESSAGE message,
                   boolean moveToStartIfUpdate)

Updates and moves to start if message by its id exists and if specified move to start, if not specified the item stays at current position and updated

Parameters:

message - message object to insert or update.

delete

public void delete(MESSAGE message)

Deletes message.

Parameters:

message - message to delete.

delete

public void delete(java.util.List<MESSAGE> messages)

Deletes messages list.

Parameters:

messages - messages list to delete.

deleteById

public void deleteById(java.lang.String id)

Deletes message by its identifier.

Parameters:

id - identifier of message to delete.

deleteByIds

public void deleteByIds(java.lang.String[] ids)

Deletes messages by its identifiers.

Parameters:

ids - array of identifiers of messages to delete.

isEmpty

public boolean isEmpty()

Returns true if, and only if, messages count in adapter is non-zero.

Returns:

true if size is 0, otherwise false

clear

public void clear()

Clears the messages list. With notifyDataSetChanged

clear

public void clear(boolean notifyDataSetChanged)

Clears the messages list.

enableSelectionMode

public void enableSelectionMode(MessagesListAdapter.SelectionListener selectionListener)

Enables selection mode.

Parameters:

selectionListener - listener for selected items count. To get selected messages use getSelectedMessages().

disableSelectionMode

public void disableSelectionMode()

Disables selection mode and removes MessagesListAdapter.SelectionListener.

getSelectedMessages

public java.util.ArrayList<MESSAGE> getSelectedMessages()

Returns the list of selected messages.

Returns:

list of selected messages. Empty list if nothing was selected or selection mode is disabled.

getSelectedMessagesText

public java.lang.String getSelectedMessagesText(MessagesListAdapter.Formatter<MESSAGE> formatter,
                                                boolean reverse)

Returns selected messages text and do unselectAllItems() for you.

Parameters:

formatter - The formatter that allows you to format your message model when copying.

reverse - Change ordering when copying messages.

Returns:

formatted text by MessagesListAdapter.Formatter. If it's null - MESSAGE#toString() will be used.

copySelectedMessagesText

public java.lang.String copySelectedMessagesText(android.content.Context context,
                                                 MessagesListAdapter.Formatter<MESSAGE> formatter,
                                                 boolean reverse)

Copies text to device clipboard and returns selected messages text. Also it does unselectAllItems() for you.

Parameters:

context - The context.

formatter - The formatter that allows you to format your message model when copying.

reverse - Change ordering when copying messages.

Returns:

formatted text by MessagesListAdapter.Formatter. If it's null - MESSAGE#toString() will be used.

unselectAllItems

public void unselectAllItems()

Unselect all of the selected messages. Notifies MessagesListAdapter.SelectionListener with zero count.

deleteSelectedMessages

public void deleteSelectedMessages()

Deletes all of the selected messages and disables selection mode. Call getSelectedMessages() before calling this method to delete messages from your data source.

setOnMessageClickListener

public void setOnMessageClickListener(MessagesListAdapter.OnMessageClickListener<MESSAGE> onMessageClickListener)

Sets click listener for item. Fires ONLY if list is not in selection mode.

Parameters:

onMessageClickListener - click listener.

setOnMessageViewClickListener

public void setOnMessageViewClickListener(MessagesListAdapter.OnMessageViewClickListener<MESSAGE> onMessageViewClickListener)

Sets click listener for message view. Fires ONLY if list is not in selection mode.

Parameters:

onMessageViewClickListener - click listener.

registerViewClickListener

public void registerViewClickListener(int viewId,
                                      MessagesListAdapter.OnMessageViewClickListener<MESSAGE> onMessageViewClickListener)

Registers click listener for view by id

Parameters:

viewId - view

onMessageViewClickListener - click listener.

setOnMessageLongClickListener

public void setOnMessageLongClickListener(MessagesListAdapter.OnMessageLongClickListener<MESSAGE> onMessageLongClickListener)

Sets long click listener for item. Fires only if selection mode is disabled.

Parameters:

onMessageLongClickListener - long click listener.

setOnMessageViewLongClickListener

public void setOnMessageViewLongClickListener(MessagesListAdapter.OnMessageViewLongClickListener<MESSAGE> onMessageViewLongClickListener)

Sets long click listener for message view. Fires ONLY if selection mode is disabled.

Parameters:

onMessageViewLongClickListener - long click listener.

setLoadMoreListener

public void setLoadMoreListener(MessagesListAdapter.OnLoadMoreListener loadMoreListener)

Set callback to be invoked when list scrolled to top.

Parameters:

loadMoreListener - listener.

setDateHeadersFormatter

public void setDateHeadersFormatter(DateFormatter.Formatter dateHeadersFormatter)

Sets custom DateFormatter.Formatter for text representation of date headers.

generateDateHeaders

protected void generateDateHeaders(java.util.List<MESSAGE> messages)