picker-app/androidx.picker.widget/SeslAppPickerSelectLayout

SeslAppPickerSelectLayout

open class SeslAppPickerSelectLayout @JvmOverloads constructor(context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = 0, defStyleRes: Int = 0) : FrameLayout, AppPickerState, AppPickerEvent, LogTag(source)

A custom layout class for displaying a list of apps and that also supports showing a secondary list for displaying list of selected items either at the top or at the side which is enabled usingenableSelectedAppPickerView.

Key Features:

Dynamic Layout: Automatically adjusts layout between portrait and landscape, and based on whether the selected apps view is visible.
Selected Apps View: Can display a separate list of currently selected apps, either horizontally at the top (portrait) or vertically on the side (landscape).
Header Support: Allows for a custom header view to be displayed above the selected apps view.
Search Filtering: Supports filtering the main app list via setSearchFilter.
State Management: Manages the selection state of apps through its internal CheckStateManager and interfaces with the underlying appPickerStateView.
Customization:

Main view title can be customized using setMainViewTitle.
Selected view title can be set using setSelectedViewTitle.
Layout orientation can be forced using the app:layoutType XML attribute or programmatically via selectLayoutType.

Custom XML Attributes:

app:layoutType (enum): Defines the layout orientation behavior for the selected app list. Can be auto, port, or land. Defaults to auto. See SelectLayoutType for more details.

Parameters

context

The Context the view is running in, through which it can access the current theme, resources, etc.

attrs

The attributes of the XML tag that is inflating the view.

defStyleAttr

An attribute in the current theme that contains a reference to a style resource that supplies default values for the view. Can be 0 to not look for defaults.

Constructors

SeslAppPickerSelectLayout

constructor(context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = 0, defStyleRes: Int = 0)

Types

CheckStateManager

class CheckStateManager : LogTag

Manages the state of checked (selected) apps.

enum LayoutType : Enum<SeslAppPickerSelectLayout.LayoutType>

Enum representing the different layout configurations for the SeslAppPickerSelectLayout.

SelectedHorizontalItemDecoration

class SelectedHorizontalItemDecoration : RecyclerView.ItemDecoration

SelectedVerticalItemDecoration

class SelectedVerticalItemDecoration(spacing: Int) : RecyclerView.ItemDecoration

SelectLayoutType

enum SelectLayoutType : Enum<SeslAppPickerSelectLayout.SelectLayoutType>

Defines the layout orientation behavior of the selected app list.

Properties

appPickerStateView

var appPickerStateView: SeslAppPickerView

The primary SeslAppPickerView instance used by this layout.

open override val logTag: String

Functions

fun addCheckedItem(appInfoData: AppInfoData)

Adds an item to the checked list.

fun addCheckedItem(groupAppData: GroupAppData)

Adds items from a GroupAppData to the checked items list.

addSelectedItem

fun addSelectedItem(appInfo: AppInfo)

Adds an app to the selected items list.

fun addSelectItem(categoryAppData: CategoryAppData)

Adds a category app data item to the selected list.

clearCheckedItemList

fun clearCheckedItemList()

Clears the list of checked items.

convertCategory2Remove

fun convertCategory2Remove(categoryAppData: CategoryAppData): AppInfoData

convertCheckBox2Remove

fun convertCheckBox2Remove(appInfoData: AppInfoData): AppInfoData

Converts an AppInfoData object representing a checkbox item to an AppInfoData object suitable for a "remove" action.

enableSelectedAppPickerView

fun enableSelectedAppPickerView(enabled: Boolean)

Enables or disables showing the secondary app picker view for selected items.

fun getAppData(appInfo: AppInfo): AppData?

Retrieves the AppData associated with the given AppInfo.

fun getAppDataList(): List<AppData>

Retrieves the list of AppData currently managed by the the appPickerStateView's ViewDataController.

fun getAppInfoData(list: List<AppInfoData>, appInfo: AppInfo): AppInfoData?

Retrieves an AppInfoData object from a list based on its AppInfo.

getCategoryAppDataContainsAppInfo

fun getCategoryAppDataContainsAppInfo(list: List<CategoryAppData>, appInfo: AppInfo): CategoryAppData?

Finds a CategoryAppData in a list that contains a specific AppInfo.

getCategoryAppDataList

fun getCategoryAppDataList(list: List<AppData>): List<CategoryAppData>

Extracts a list of CategoryAppData from a given list of AppData.

open override fun getState(appInfo: AppInfo): Boolean

Retrieves the current selection state of the specified application.

refreshSelectedAppPickerView

fun refreshSelectedAppPickerView(withTransition: Boolean)

Refreshes the selected appPickerStateView.

removeSelectedItem

fun removeSelectedItem(appInfo: AppInfo)

Removes an item from the selected list.

removeSelectItem

fun removeSelectItem(appInfoData: AppInfoData?)

Removes an item from the selected list.

fun setHeader(view: View?)

Sets a custom header view for the selected app picker.

setMainViewTitle

fun setMainViewTitle(title: String?)

Sets the title of the main app list view.

setOnItemActionClickEventListener

open override fun setOnItemActionClickEventListener(listener: AppPickerEvent.OnItemClickEventListener?)

Sets the listener to be called when an action button in an item is clicked.

setOnItemClickEventListener

open override fun setOnItemClickEventListener(listener: AppPickerEvent.OnItemClickEventListener?)

Sets the listener to be called when an item in the list is clicked.

setOnStateChangeListener

open override fun setOnStateChangeListener(listener: AppPickerState.OnStateChangeListener?)

Sets the listener to be notified when the state of an app or all apps changes.

setSearchFilter

fun setSearchFilter(filter: String, onSearchFilterListener: SeslAppPickerView.OnSearchFilterListener? = null)

Sets a search filter for the app list.

setSelectedViewTitle

fun setSelectedViewTitle(title: String)

Sets the title text for the selected view.

open override fun setState(appInfo: AppInfo, isSelected: Boolean)

Sets the selection state of a specific application.

open override fun setStateAll(isAllSelected: Boolean)

Sets the selection state of all applications in the app picker.

smoothScrollToAppInfo

fun smoothScrollToAppInfo(appInfo: AppInfo, induceAnimation: Boolean = false)

Smoothly scrolls the selected app list to the specified app.

fun submitList(list: List<AppData>? = null)

Submits a new list of AppData to be displayed.

updateCheckedAppList

fun updateCheckedAppList(list: List<AppData>)

Updates the checked app list based on the provided list of AppData.

fun updateItem(appInfoData: AppInfoData)

Updates an item in the app list with new data.