程序包 ohos.agp.window.dialog

类 ToastDialog

java.lang.Object

ohos.agp.window.dialog.BaseDialog

ohos.agp.window.dialog.CommonDialog

ohos.agp.window.dialog.ToastDialog

所有已实现的接口:

IDialog

public class ToastDialog
extends CommonDialog

Provides a toast dialog box above a window to notify simple feedback for an operation.

The toast dialog box is not clickable and it disappears automatically.

从以下版本开始:

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

字段概要

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

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

构造器概要

构造器

构造器	说明
ToastDialog(Context context)	A constructor used to create a ToastDialog instance.

方法概要

限定符和类型	方法	说明
void	cancel()	Cancels the current ToastDialog.
void	destroy()	Destroys an existing dialog box.
Component	getComponent()	Obtains the content of the dialog.
void	hide()	Hides the content of a dialog box.
protected void	onCreate()	Called from BaseDialog to set the default layout.
protected void	onDestroy()	Callback interface used when enabling automatic close of a Dialog instance.
protected void	onShow()	Enables a derived class to execute an operation when a toast dialog box is shown.
ToastDialog	setAlignment(int gravity)	Sets the dialog alignment mode.
ToastDialog	setAutoClosable(boolean closable)	Sets whether to enable automatic close of a ToastDialog object.
ToastDialog	setComponent(Component component)	Sets the customized component to use in the dialog.
ToastDialog	setComponent(DirectionalLayout component)	已过时。 This change is effective since API version 5. Replaced by setComponent(Component)
ToastDialog	setDuration(int ms)	Sets the duration for automatic close of a ToastDialog object.
ToastDialog	setOffset(int offsetX, int offsetY)	Sets the display position offset for the dialog.
ToastDialog	setSize(int width, int height)	Sets the size of a toast dialog.
ToastDialog	setText(String textContent)	Sets the text content in the dialog.
void	show()	Shows the ToastDialog object.

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

isShowing, obtainComponentViaId, onHide, onShowing, registerDisplayCallback, registerRemoveCallback, remove, searchComponentViaId, setCornerRadius, setDialogListener, setTransparent

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

clickKeyDown, clickKeyUp, create, dealBackKeyDown, dealTouchEvent, deliverKeyboardCase, deliverTouchCase, getBoundRect, getButtonComponent, getContentCustomComponent, getWindow, isMovable, 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

构造器详细资料

ToastDialog

public ToastDialog(Context context)

A constructor used to create a ToastDialog instance.

参数:

context - Indicates the ohos context obtained.

方法详细资料

setText

public ToastDialog setText(String textContent)

Sets the text content in the dialog.

It cannot be empty except in custom scenarios.

参数:

textContent - Indicates the text content in the dialog.

返回:

Returns the ToastDialog object for further use. For example, obj.setText(text).show().

setComponent

@Deprecated
public ToastDialog setComponent(DirectionalLayout component)

已过时。 This change is effective since API version 5. Replaced by setComponent(Component)

Sets the customized component to use in the dialog.

This is a ComponentContainer that encapsulates the customized component to be displayed.

参数:

component - Indicates the customized ComponentContainer.

返回:

Returns the ToastDialog object for further use. For example, obj.setText(text).show().

setComponent

public ToastDialog setComponent(Component component)

Sets the customized component to use in the dialog.

This is a ComponentContainer that encapsulates the customized component to be displayed.

参数:

component - Indicates the customized ComponentContainer.

返回:

Returns the ToastDialog object for further use. For example, obj.setText(text).show().

getComponent

public Component getComponent()

Obtains the content of the dialog.

The obtained object is a ComponentContainer, which encapsulates the component to display.

返回:

Returns the content displayed in the dialog.

cancel

public void cancel()

Cancels the current ToastDialog.

This dialog will not be destroyed but will not be displayed after execution.

setAlignment

public ToastDialog setAlignment(int gravity)

Sets the dialog alignment mode.

A toast dialog has many alignment modes, for example, bottom alignment.

覆盖:

setAlignment 在类中 BaseDialog

参数:

gravity - Indicates the alignment mode to use.

返回:

Returns the ToastDialog object for further use. For example, obj.setText(text).show().

setOffset

public ToastDialog setOffset(int offsetX,
                             int offsetY)

Sets the display position offset for the dialog.

This is the offset compared with the default alignment mode.

覆盖:

setOffset 在类中 BaseDialog

参数:

offsetX - Indicates the offset of the X axis.

offsetY - Indicates the offset of the Y axis.

返回:

Returns the ToastDialog object for further use. For example, obj.setText(text).show().

setSize

public ToastDialog setSize(int width,
                           int height)

Sets the size of a toast dialog.

覆盖:

setSize 在类中 BaseDialog

参数:

width - Indicates the width to set.

height - Indicates the height to set.

返回:

Returns the ToastDialog instance for further use.

setAutoClosable

public ToastDialog setAutoClosable(boolean closable)

Sets whether to enable automatic close of a ToastDialog object. This method is not supported for the ToastDialog object.

If automatic close is enabled, a dialog automatically closes when touching or clicking a position outside the ToastDialog object.

覆盖:

setAutoClosable 在类中 BaseDialog

参数:

closable - Indicates whether to enable automatic close of the ToastDialog object.

返回:

Returns the ToastDialog object for continuous operations, for example, obj.setAutoClosable(false).show().

setDuration

public ToastDialog setDuration(int ms)

Sets the duration for automatic close of a ToastDialog object. This method is not supported for the ToastDialog object.

覆盖:

setDuration 在类中 BaseDialog

参数:

ms - Indicates the duration for automatic close of the ToastDialog instance.

返回:

Returns the ToastDialog object for continuous operations, for example, obj.setAutoClosable(false).show().

show

public void show()

Shows the ToastDialog object.

指定者:

show 在接口中 IDialog

覆盖:

show 在类中 BaseDialog

onCreate

protected void onCreate()

Called from BaseDialog to set the default layout.

覆盖:

onCreate 在类中 CommonDialog

onShow

protected void onShow()

Enables a derived class to execute an operation when a toast dialog box is shown.

覆盖:

onShow 在类中 CommonDialog

destroy

public void destroy()

从类复制的说明: BaseDialog

Destroys an existing dialog box.

指定者:

destroy 在接口中 IDialog

覆盖:

destroy 在类中 BaseDialog

hide

public void hide()

从类复制的说明: BaseDialog

Hides the content of a dialog box.

A hidden dialog box is not destroyed.

指定者:

hide 在接口中 IDialog

覆盖:

hide 在类中 BaseDialog

onDestroy

protected void onDestroy()

从类复制的说明: BaseDialog

Callback interface used when enabling automatic close of a Dialog instance.

This callback is triggered only when the BaseDialog.destroy() method is invoked.

覆盖:

onDestroy 在类中 CommonDialog