程序包 ohos.agp.window.dialog

类 ListDialog

java.lang.Object

ohos.agp.window.dialog.BaseDialog

ohos.agp.window.dialog.CommonDialog

ohos.agp.window.dialog.ListDialog

所有已实现的接口:

IDialog

public class ListDialog
extends CommonDialog

Creates a ListDialog instance.

A list dialog box includes the radio box list and check box list.

从以下版本开始:

1

嵌套类概要

从类继承的嵌套类/接口 ohos.agp.window.dialog.BaseDialog

BaseDialog.DialogListener, BaseDialog.DisplayCallback, BaseDialog.RemoveCallback

从类继承的嵌套类/接口 ohos.agp.window.dialog.CommonDialog

CommonDialog.DestroyedListener

从接口继承的嵌套类/接口 ohos.agp.window.dialog.IDialog

IDialog.CheckBoxClickedListener, IDialog.ClickedListener, IDialog.ItemClickedListener, IDialog.KeyboardCallback

字段概要

字段

限定符和类型	字段	说明
static int	MULTI	Indicates a check box list.
static int	NORMAL	Indicates a common list.
static int	SINGLE	Indicates a radio box list.

从接口继承的字段 ohos.agp.window.dialog.IDialog

BUTTON_NUM, BUTTON1, BUTTON2, BUTTON3, DEF_RADIUS, ICON_NUM, ICON1, ICON2, ICON3

构造器概要

构造器

构造器	说明
ListDialog(Context context)	A constructor used to create a ListDialog instance of the common type.
ListDialog(Context context, int type)	A constructor used to create a ListDialog instance.

方法概要

限定符和类型	方法	说明
ListDialog	addItem(String item)	Adds an item to a ListDialog instance.
void	destroy()	Called from BaseDialog to destroy the list dialog box.
int	getComponentLocation(Component component)	Obtains the location of a specified component.
Component	getItemComponent(int position)	Obtains the component matching the item at a specified position.
Component	getListContainer()	Obtains the ListContainer used to display content for this list dialog box.
BaseItemProvider	getProvider()	Obtains the provider of this list dialog box.
protected void	onShow()	Called from BaseDialog to initialize the content of the panels.
ListDialog	removeItem(String item)	Removes an item from a ListDialog instance.
void	setBackColor(int color)	Sets the background color of a list.
ListDialog	setItems(String[] items)	Sets the items to be displayed in a list.
void	setListener(ListContainer.ItemClickedListener clickListener, ListContainer.ItemLongClickedListener longClickListener, ListContainer.ItemSelectedListener selectedListener)	Sets a user-defined listener for the events of an item.
ListDialog	setMultiSelectItems(String[] items, boolean[] selectedItems)	Sets the items to be displayed in a check box list.
void	setOnMultiSelectListener(IDialog.CheckBoxClickedListener listener)	Registers a listener for check box lists.
void	setOnSingleSelectListener(IDialog.ClickedListener listener)	Registers a listener for common lists or radio box lists.
void	setProvider(BaseItemProvider provider)	Sets a specified provider for this list dialog box.
ListDialog	setSingleSelectItems(String[] items, int selectedId)	Sets the items to be displayed in a radio box list.
void	show()	Called from BaseDialog to show the list dialog box.

从类继承的方法 ohos.agp.window.dialog.BaseDialog

hide, isShowing, obtainComponentViaId, onHide, onShowing, registerDisplayCallback, registerRemoveCallback, remove, searchComponentViaId, setAlignment, setAutoClosable, setCornerRadius, setDialogListener, setDuration, setOffset, setSize, setTransparent

从类继承的方法 ohos.agp.window.dialog.CommonDialog

clickKeyDown, clickKeyUp, create, dealBackKeyDown, dealTouchEvent, deliverKeyboardCase, deliverTouchCase, getBoundRect, getButtonComponent, getContentCustomComponent, getWindow, isMovable, onCreate, onDestroy, onWindowConfigUpdated, onWindowSelectionUpdated, setBoundRect, setButton, setContentCustomComponent, setContentImage, setContentText, setDestroyedListener, setImageButton, setMovable, setSwipeToDismiss, setTitleCustomComponent, setTitleIcon, setTitleSubText, setTitleText, siteKeyboardCallback, siteRemovable

从类继承的方法 java.lang.Object

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

字段详细资料

MULTI

public static final int MULTI

Indicates a check box list.

This value indicates a list with check boxes.

另请参阅:

常量字段值

NORMAL

public static final int NORMAL

Indicates a common list.

This value distinguishes the list from the list with a radio box.

另请参阅:

常量字段值

SINGLE

public static final int SINGLE

Indicates a radio box list.

This value indicates a list with a radio box.

另请参阅:

常量字段值

构造器详细资料

ListDialog

public ListDialog(Context context)

A constructor used to create a ListDialog instance of the common type.

A common list is used.

参数:

context - Indicates the ohos context.

ListDialog

public ListDialog(Context context,
                  int type)

A constructor used to create a ListDialog instance.

Currently, a ListDialog instance supports three attributes: radio box, check box, and common list.

参数:

context - Indicates the ohos context.

type - Indicates the list type, which can be the radio box, check box, or common.

方法详细资料

setOnSingleSelectListener

public void setOnSingleSelectListener(IDialog.ClickedListener listener)

Registers a listener for common lists or radio box lists.

This method can be used for the common and radio box lists.

参数:

listener - Indicates the listener to register.

setOnMultiSelectListener

public void setOnMultiSelectListener(IDialog.CheckBoxClickedListener listener)

Registers a listener for check box lists.

This method can be used for the check box lists.

参数:

listener - Indicates the listener to register.

addItem

public ListDialog addItem(String item)

Adds an item to a ListDialog instance.

参数:

item - Indicates the item to add.

返回:

Returns the Dialog object for continuous operations, for example, obj.setItems(items).show().

removeItem

public ListDialog removeItem(String item)

Removes an item from a ListDialog instance.

参数:

item - Indicates the item to remove.

返回:

Returns the Dialog object for continuous operations, for example, obj.setItems(items).show().

setItems

public ListDialog setItems(String[] items)

Sets the items to be displayed in a list.

This method applies to common lists.

参数:

items - Indicates the items to be displayed in a list.

返回:

Returns the Dialog object for continuous operations, for example, obj.setItems(items).show().

setSingleSelectItems

public ListDialog setSingleSelectItems(String[] items,
                                       int selectedId)

Sets the items to be displayed in a radio box list.

参数:

items - Indicates the items to be displayed in a radio box list.

selectedId - Indicates the item selected by default.

返回:

Returns the Dialog object for continuous operations, for example, obj.setItems(items).show().

setMultiSelectItems

public ListDialog setMultiSelectItems(String[] items,
                                      boolean[] selectedItems)

Sets the items to be displayed in a check box list.

参数:

items - Indicates the items to be displayed in a check box list.

selectedItems - Indicates the items selected by default.

返回:

Returns the Dialog object for continuous operations, for example, obj.setItems(items).show().

onShow

protected void onShow()

Called from BaseDialog to initialize the content of the panels.

覆盖:

onShow 在类中 CommonDialog

show

public void show()

Called from BaseDialog to show the list dialog box.

指定者:

show 在接口中 IDialog

覆盖:

show 在类中 BaseDialog

destroy

public void destroy()

Called from BaseDialog to destroy the list dialog box.

指定者:

destroy 在接口中 IDialog

覆盖:

destroy 在类中 BaseDialog

setProvider

public void setProvider(BaseItemProvider provider)

Sets a specified provider for this list dialog box.

参数:

provider - Indicates the provider to set. The provider allows access to the list data and creates a component for each piece of data.

从以下版本开始:

4

setListener

public void setListener(ListContainer.ItemClickedListener clickListener,
                        ListContainer.ItemLongClickedListener longClickListener,
                        ListContainer.ItemSelectedListener selectedListener)

Sets a user-defined listener for the events of an item.

参数:

clickListener - Indicates the listener for click events of the item.

longClickListener - Indicates the listener for long click events of the item.

selectedListener - Indicates the listener for selected events of the item.

setBackColor

public void setBackColor(int color)

Sets the background color of a list.

参数:

color - Indicates the user-defined background color.

getProvider

public BaseItemProvider getProvider()

Obtains the provider of this list dialog box.

返回:

Returns the provider.

从以下版本开始:

4

另请参阅:

setProvider(BaseItemProvider provider)

getItemComponent

public Component getItemComponent(int position)

Obtains the component matching the item at a specified position.

参数:

position - Indicates the position specified by the user.

返回:

Returns the Component, or null if the position is out of range.

getComponentLocation

public int getComponentLocation(Component component)

Obtains the location of a specified component.

参数:

component - Indicates the component specified by the user.

返回:

Returns the location.

从以下版本开始:

4

getListContainer

public Component getListContainer()

Obtains the ListContainer used to display content for this list dialog box.

返回:

Returns a Component object representing the ListContainer.

从以下版本开始:

4