1. A biblioteca SelectionTracker fornece uma maneira fácil de implementar funcionalidade de seleção de itens no RecyclerView. 2. São necessárias as implementações das classes ItemKeyProvider, ItemDetailsLookup e ItemDetails para permitir que a SelectionTracker acesse os itens e suas informações. 3. Após adicionar a biblioteca e implementar essas classes, é possível inicializar um objeto SelectionTracker, vinculá-lo ao RecyclerView e gerenciar a seleção de itens.

1. SelectionTracker Para Seleção de
Itens no RecyclerView Android
thiengo.com.br

2. Qual o objetivo da biblioteca SelectionTracker?
Primeiro é importante lembrar que o RecyclerView, ao menos quando nos primeiros contatos, não é nada
trivial como um ListView ou um GridView.
Partindo desse ponto já temos que colocar um algoritmo de marcação de itens, único ou múltiplos, se torna
algo ainda menos simples.
O time do Google Android liberou a biblioteca SelectionTracker com o objetivo de facilitar a inclusão da
funcionalidade de seleção de itens no RecyclerView. A biblioteca foi liberada em 2018 junto ao sucessor
da Support Library, o AndroidX.
Com a SelectionTracker é também possível:
• Escolher como os itens podem ser selecionados:
• Toque / clique;
• Gesto específico;
• Drag.
• Definir quais e quantos itens podem ser selecionados;
• Ter fácil acesso aos itens selecionados.
Mas, como desenvolvedor Android que somos, sabemos que nem tudo "são flores”.
Caso você precise de algo muito simples, a marcação de um único item em lista, por exemplo, você
provavelmente achará o número de classes necessárias, para a configuração de um objeto
SelectionTracker, uma escolha em demasiado.

3. Conhecer o RecyclerView é necessário
Antes de continuar, caso você ainda não conheça o RecyclerView, a seguir deixo
dois links do Blog onde somente falo sobre este framework de lista, que por sinal é
o melhor framework de lista disponível no Android:
• RecyclerView, Material Design Android - Parte 2;
• Animação, onLongPress e GridLayoutManager em RecyclerView, Material
Design Android - Parte 3.
Apesar de os conteúdos indicados serem parte de uma Play List, eles são
passíveis de serem compreendidos sem que o vídeo 1 da Play List, sobre o
Toolbar, seja assistido.

4. O vinculo da SelectionTracker
A biblioteca SelectionTracker vem em um diferente pacote do que contém o RecyclerView. Há
também um "melhor roteiro" para adicionarmos a biblioteca a algum projeto.
O roteiro de vinculação da SelectionTracker, indicado pela documentação oficial, é como a seguir:
• Primeiro desenvolva a configuração de lista do projeto, utilizando RecyclerView, lista de dados
e adapter;
• Logo após adicione a referência da SelectionTracker no Gradle Nível de Aplicativo;
• Então implemente uma versão da classe abstrata ItemKeyProvider;
• Depois implemente uma versão da classe abstrata ItemDetailsLookup;
• Assim implemente uma versão da ItemDetails, outra classe abstrata;
• Implemente também uma SelectionPredicate;
• Atualize o código do adapter do RecyclerView para conter um objeto SelectionTracker e
também o algoritmo de mudança de UI dos itens selecionados / não selecionados;
• Inicialize um objeto SelectionTracker e vincule ele ao RecyclerView alvo.
Para lhe animar: apesar da extensa lista acima para uma única funcionalidade, a maioria dos códigos
são boilerplate, somente têm de estar no projeto, não exigindo esforço de lógica.
O primeiro tópico da lista acima é implementado no projeto de exemplo na segunda parte do artigo no
Blog. Aqui nos slides vamos direto ao estudo da biblioteca SelectionTracker.

5. Classe de exemplo
Antes de partirmos para os códigos oficiais da SelectionTracker, vamos a uma
simples classe de domínio que utilizaremos como referência.
Segue classe Car:

6. Instalação da biblioteca
A SelectionTracker foi adicionada ao Android junto ao pacote AndroidX, mas nós
também temos uma versão dela na Support Library, que é exatamente a que
utilizaremos aqui enquanto ainda não temos um conteúdo no Blog sobre a
AndroidX.
No Gradle Nível de Aplicativo, build.gradle (Module: app), adicione:
Na época da construção deste conteúdo a versão estável mais atual era a 28.0.0.

7. Implementando a ItemKeyProvider
A classe abstrata ItemKeyProvider é a entidade que fornece acesso as chaves estáveis
dos itens, acesso interno à biblioteca SelectionTracker.
Resumidamente: uma "chave estável" é um identificador que se mantém o mesmo
independente da mudança de posição ou mudança de propriedade de um objeto.
Um exemplo simples de chave estável é o ID de um usuário em banco de dados. Podemos
mudar alguns atributos do usuário, como a idade dele, mas o ID se manterá o mesmo.
Essas chaves de acesso, que são possíveis via implementação de uma ItemKeyProvider,
são o primeiro ponto que permite que internamente a biblioteca SelectionTracker tenha
acesso a todos os itens do RecyclerView.
Antes de partirmos direto para o código de uma implementação de ItemKeyProvider é
importante saber que nossas chaves de seleção podem ser de algum dos três tipos a
seguir: Parcelable (ou subclasses); String; e Long.
Long e String certamente serão os tipos mais utilizados por serem mais comuns como
identificadores únicos de objetos. Mas caso o seu identificador único seja uma Uri, por
exemplo, que é uma subclasse de Parcelable, então utilize o tipo Parcelable.

8. Segue implementação de ItemKeyProvider:
Note que como "chave estável de seleção" foi utilizado o id do objeto Car, isso,
pois sabemos que ele se manterá o mesmo independente da mudança ou
reconstrução de objeto.

9. Há muitos exemplos da SelectionTracker onde a posição do item em lista é utilizada como
chave estável de acesso. Não recomendo isso, pois em caso de remoção de item, por
exemplo, as chaves de seleção de alguns itens são passíveis de serem alteradas, mesmo
com o objeto sendo o mesmo.
A implementação de ItemKeyProvider exige a codificação dos métodos getKey() e
getPosition() além da definição do escopo de acesso às chaves de seleção logo no
construtor de ItemKeyProvider. O parâmetro cars é somente parte da lógica de negócio
do exemplo.
São possíveis dois tipos de escopos:
• ItemKeyProvider.SCOPE_CACHED: fornece acesso a dados armazenados em
cache com base em itens que foram vinculados recentemente na exibição em tela.
Esse escopo permiti ao provedor um acesso mais eficiente aos dados, mas somente
àqueles em cache, tendo ainda mais limitações ante ao outro escopo;
• ItemKeyProvider.SCOPE_MAPPED: comumente utilizado, fornece acesso a todos os
dados, independentemente de estarem vinculados a uma exibição ou não. Permite
seleção de intervalo, quando utilizando o mouse, algo não suportado por
SCOPE_CACHED.
Em getKey() e em getPosition() é possível utilizar qualquer lógica de negócio, mas que
retorne, respectivamente: a chave estável de seleção do item e a posição do item de
acordo com a chave de seleção. Não há problemas se a posição mudar de acordo com a
saída ou entrada de novos itens, o importante é que a chave estável de um item (objeto) se
mantenha.

10. Implementando a ItemDetailsLookup
A classe abstrata ItemDetailsLookup permite que internamente a biblioteca
SelectionTracker acesse informações dos itens do RecyclerView alvo, itens que
receberam algum evento (toque, clique) que gera um objeto MotionEvent.
O parágrafo acima deve ter lhe deixado confuso, pois ele indica a função de
ItemDetailsLookup como sendo muito similar a função de ItemKeyProvider,
tirando somente a responsabilidade de gerencia das chaves estáveis de acesso.
Como acontece com ItemKeyProvider, ItemDetailsLookup é uma das classes
obrigatórias que permitem, aos códigos internos da biblioteca SelectionTracker,
acesso a informações dos itens do RecyclerView alvo.
A outra classe obrigatória que fecha a trinca, e que discutiremos na próxima seção,
é a ItemDetails.

11. Segue implementação de ItemDetailsLookup:

12. Note que a parametrização em ItemDetailsLookup tem de ser do mesmo tipo da
chave de seleção escolhida e já definida em ItemKeyProvider. Em nosso caso:
Long.
O algoritmo em getItemDetails() é o comumente utilizado para o fácil acesso ao
objeto ItemDetails vinculado ao item acionado pelo usuário.
Ainda chegaremos ao código do adapter CarsAdapter para mostrar como ficará a
propriedade itemDetails.

13. Implementando a ItemDetails
A classe abstrata ItemDetails fornece acesso às informações de um item
específico do RecyclerView, acesso interno a biblioteca SelectionTracker.
Em resumo: a implementação de ItemDetails é o último ponto que permite a
biblioteca SelectionTracker acesso aos itens do RecyclerView.

14. Segue implementação de ItemDetails:

15. Como obrigatório, somente as implementações de getPosition() e
getSelectionKey(). Mas se não for fornecida a implementação de
inSelectionHotspot(), os itens não serão passíveis de seleção, pois por padrão o
retorno é false.
Dentro dos métodos sobrescritos anteriormente, pode vir qualquer lógica de
negócio, aqui colocamos a lógica que atende ao exemplo.
O construtor está com propriedades mutáveis que aceitam valores null e -1, pois
objetos ItemDetails são reaproveitados dentro de instâncias ViewHolder do
adapter do RecyclerView alvo. Essa é uma decisão de projeto, para não inflar a
memória com inúmeros novos objetos ItemDetails.

16. Atualização da classe adaptadora
A classe adaptadora precisa ter:
• Uma propriedade do tipo SelectionTracker para poder ser trabalhado os itens
selecionados ou não selecionados;
• Uma propriedade do tipo ItemDetails no ViewHolder, isso para ser possível
passar informações de item aos códigos da biblioteca de seleção.
Primeiro a adição da propriedade selectionTracker:

17. Agora a adição de Details, que implementa ItemDetails:

18. Assim o algoritmo de atualização de item, incluindo a UI, que é invocado a partir do
método onBindViewHolder():

19. Note que não há algoritmo pronto para a atualização da UI de qualquer item, isso é
feito na "unha" no método invocado pelo onBindViewHolder().
O método onBindViewHolder() é invocado para todos os itens em tela e também
quando algum deles é selecionado (ou deixa de ser selecionado) pelo usuário.
Importante: Devido ao vinculo de um objeto SelectionTracker ao RecyclerView, o
ouvidor de clique adicionado (OnClickListener) somente funcionará se houver dois
toques (cliques) rápidos no item, mas mesmo assim a biblioteca de seleção
também será ativada. De qualquer forma, não é comum um contexto onde é
possível trabalhar a seleção de itens e também alguma ação extra quando houver
o toque / clique em algum dos itens.

20. Iniciando o objeto de seleção
O que ainda falta é a inicialização do objeto SelectionTracker e o vinculo dele ao adapter
do RecyclerView alvo.
Aqui a inicialização ocorrerá em uma atividade, mas no projeto de exemplo no Blog será
utilizado um fragmento. Em ambos os casos, a inicialização do objeto de seleção deve
ocorrer depois que o RecyclerView já foi configurado junto ao adapter e ao
LayoutManager escolhido.
Segue:

21. A parametrização de SelectionTracker.Builder tem que ser do tipo da chave
estável definida em ItemKeyProvider.
Há três possíveis chamadas de estratégia de armazenamento de chave estável:
• StorageStrategy.createLongStorage() para chaves do tipo Long;
• StorageStrategy.createStringStorage() para chaves do tipo String;
• StorageStrategy.createParcelableStorage( Class::class.java ) para chaves
do tipo Parcelable.

22. Assim já podemos realizar a execução do projeto:
Clique aqui para abrir a animação

23. Retendo os itens selecionados com o mesmo estado
Para que os itens se mantenham com o mesmo estado, selecionados ou não, em
caso de reconstrução de atividade ou fragmento, basta vincular o objeto
SelectionTracker ao onSaveInstanceState como a seguir:

24. Executando o projeto e rotacionando a tela, temos:
Clique aqui para abrir a animação

25. No caso do fragmento seriam necessárias as seguintes configurações:
No projeto de exemplo na segunda parte do artigo em Blog um objeto
SelectionTracker será utilizado junto a um fragmento, incluindo as configurações
necessárias para que o fragmento não seja sobrescrito por um novo na atividade host.

26. Definindo quais e quantos itens podem ser selecionados
Para a definição de quais e quantos itens podem ser selecionados, podemos utilizar uma
implementação de SelectionTracker.SelectionPredicate. A seguir a classe Predicate:

27. Quando realizando testes, o método canSetStateAtPosition() não é invocado em
nenhum momento.
Agora a inserção de uma instância de Predicate na configuração de
selectionTracker:

28. Executando o projeto e tentando mais de uma seleção ou então tentando a seleção
no item de ID 54 (Cargo, FIAT), temos:
Clique aqui para abrir a animação

29. Ouvidor de mudança de estado de item
É possível colocar um Observer junto a instância de SelectionTracker para ouvir
às mudanças de estado dos itens:
A parametrização de SelectionObserver deve ser do tipo da chave estável
definido em ItemKeyProvider.

30. Obtendo itens selecionados, selecionando e
removendo seleção
Em código dinâmico é possível obter os itens selecionados:
Na verdade as chaves estáveis dos itens selecionados é que serão retornadas.
É possível selecionar e remover seleção de itens pelas chaves estáveis deles:

31. Uma outra maneira de remover todas as seleções é com o método:
Os métodos select() e deselect() de SelectionTracker também permitem a
seleção e remoção de seleção.

32. Pontos negativos
• Realmente toda a exigência de classes em heranças poderia ser reduzida em
métodos de um único SelectionTracker.Builder;
• O método canSetStateAtPosition() de SelectionPredicate, até momento da
construção deste artigo, não estava funcional;
• Não há um método de remoção do objeto SelectionTracker junto ao
RecyclerView alvo, algo que complica o trabalho com o SelectionTracker em
delay, quando ele não é vinculado ao RecyclerView logo na configuração
deste framework de lista;
• A adição ou remoção de itens ao RecyclerView pode causar uma Exception
caso o notifyDataSetChanged() não seja invocado logo depois da adição ou
remoção e do clearSelection(). Isso, pois internamente na SelectionTracker
a atualização de chaves e posições está ocorrendo somente depois do
notifyDataSetChanged() ser invocado, algo não informado em
documentação.

33. Pontos positivos
• A configuração para manter o estado dos itens, selecionados ou não, é muito
simples;
• A biblioteca permite que sejam definidas "n" maneiras de seleção de item e
não somente por meio do toque ou clique;
• É simples limitar quais itens podem ou não ser selecionados, incluindo a
limitação da quantidade de itens.

34. Considerações finais
Obviamente que existem inúmeros algoritmos e APIs de terceiros que permitem a
fácil seleção de itens em RecyclerView, mas com a biblioteca SelectionTracker,
mesmo que não de maneira simples, temos muitas opções somente para a seleção
de itens em RecyclerView, algo que a deixa como uma API completa.
Este é o primeiro ano da biblioteca, ainda há muitos problemas, principalmente de
interface pública.
Algumas classes podem ser removidas no cenário de "necessidade de
implementação", a ItemDetails é uma delas, pode se tornar mais um método em
SelectionTracker.Builder.
A API já é passível de ser utilizada em produção, segundo os testes que realizei. E
agora é aguardar a evolução dela.
Há outras possibilidades com a SelectionTracker, possibilidades que serão
abordadas em futuros artigos do Blog.

35. Fontes
Conteúdo completo, em texto e em vídeo, no link a seguir:
• SelectionTracker Para Seleção de Itens no RecyclerView Android.
Fontes:
• Create a List with RecyclerView;
• Documentação oficial ItemDetailsLookup;
• Documentação oficial ItemDetailsLookup.ItemDetails;
• Documentação oficial ItemKeyProvider;
• Documentação oficial SelectionTracker.Builder;
• Documentação oficial StableIdKeyProvider;
• Documentação oficial SelectionPredicate;
• Android recycler view with multiple item selections;
• Kotlin - Classes and Inheritance;
• Add selection support to RecyclerView Selection;
• Android - what is the meaning of StableIDs? - Resposta de Delyan.

36. Para estudo
• Treinamento oficial:
• Prototipagem Profissional de Aplicativos Android.
• Meus livros:
• Desenvolvedor Kotlin Android - Bibliotecas para o dia a dia;
• Receitas Para Desenvolvedores Android;
• Refatorando Para Programas Limpos.
• Redes:
• Udemy;
• YouTube;
• Facebook;
• LinkedIn;
• GitHub;
• Twitter;
• Google Plus.
• Blog App.

37. SelectionTracker Para Seleção de
Itens no RecyclerView Android
thiengo.com.br
Vinícius Thiengo
thiengocalopsita@gmail.com