CommonDialog

java.lang.Object
- ohos.agp.window.dialog.BaseDialog
- - ohos.agp.window.dialog.CommonDialog

所有已实现的接口:

IDialog

直接已知子类:

ListDialog, ToastDialog
```
public class CommonDialog
extends BaseDialog
```
Creates a common dialog box.
You can customize dialogs by means of inheritance and encapsulation. When creating or inheriting dialogs in applications, you need to initialize the dialogs and manage their lifecycle.

从以下版本开始:

1

另请参阅:

BaseDialog

嵌套类概要

嵌套类
限定符和类型类说明

static interface CommonDialog.DestroyedListener
Interface that listens for dialog destruction events.
- 从类继承的嵌套类/接口 ohos.agp.window.dialog.BaseDialog
  BaseDialog.DialogListener, BaseDialog.DisplayCallback, BaseDialog.RemoveCallback
- 从接口继承的嵌套类/接口 ohos.agp.window.dialog.IDialog
  IDialog.CheckBoxClickedListener, IDialog.ClickedListener, IDialog.ItemClickedListener, IDialog.KeyboardCallback

嵌套类
限定符和类型	类	说明
`static interface`	`CommonDialog.DestroyedListener`	Interface that listens for dialog destruction events.

字段概要
- 从接口继承的字段 ohos.agp.window.dialog.IDialog
  BUTTON_NUM, BUTTON1, BUTTON2, BUTTON3, DEF_RADIUS, ICON_NUM, ICON1, ICON2, ICON3

构造器概要

构造器
构造器说明

CommonDialog(Context context)
A constructor used to create a CommonDialog instance.

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`boolean`	`clickKeyDown(KeyEvent event)`	Called when a key on the keyboard is pressed.
`boolean`	`clickKeyUp(KeyEvent event)`	Called when a key on the keyboard is released.
`protected void`	`create()`	Creates a `Dialog` instance.
`void`	`dealBackKeyDown()`	Called when the Back key is pressed and released.
`boolean`	`dealTouchEvent(TouchEvent event)`	Called when a touch was pressed event.
`boolean`	`deliverKeyboardCase(KeyEvent event)`	Delivers a specified keyboard event.
`boolean`	`deliverTouchCase(TouchEvent event)`	Delivers a specified touch event.
`Rect`	`getBoundRect()`	Obtains the bounds of a moving window.
`Component`	`getButtonComponent()`	Obtains the content of button area.
`Component`	`getContentCustomComponent()`	Obtains the content displayed in the content area.
`Window`	`getWindow()`	Obtains the window corresponding to a dialog box.
`boolean`	`isMovable()`	Checks whether a window is movable.
`protected void`	`onCreate()`	Called from `BaseDialog` to set the default layout for the current dialog box.
`protected void`	`onDestroy()`	Callback interface used when enabling automatic close of a `Dialog` instance.
`protected void`	`onShow()`	Called from `BaseDialog` to initialize the content of the panels.
`protected void`	`onWindowConfigUpdated(WindowManager.LayoutConfig configParam)`	Called when the window layout parameters change.
`protected void`	`onWindowSelectionUpdated(boolean isSelectionUpdated)`	Called when the window selection state changes.
`void`	`setBoundRect(Rect boundRect)`	Sets the bounds of a moving window.
`CommonDialog`	`setButton(int buttonNum, String text, IDialog.ClickedListener listener)`	Sets the buttons in the button area.
`CommonDialog`	`setContentCustomComponent(Component component)`	Customizes the content area.
`CommonDialog`	`setContentImage(int resId)`	Sets the icon to be displayed in the content area.
`CommonDialog`	`setContentText(String text)`	Sets the text to be displayed in the content area.
`void`	`setDestroyedListener(CommonDialog.DestroyedListener destroyedListener)`	Sets the dialog destruction listener.
`CommonDialog`	`setImageButton(int buttonNum, int resId, IDialog.ClickedListener listener)`	Sets the image button for a `CommonDialog` object.
`void`	`setMovable(boolean movable)`	Sets whether a window is movable.
`boolean`	`setSwipeToDismiss(boolean isEnabled)`	Sets whether to enable the feature of exiting a dialog by swiping right on the screen.Use this method after `BaseDialog.show()` is called.
`CommonDialog`	`setTitleCustomComponent(DirectionalLayout component)`	Customizes the title area.
`CommonDialog`	`setTitleIcon(int resId, int iconId)`	Sets the icon in the title area.
`CommonDialog`	`setTitleSubText(String text)`	Sets the supplementary text information in the title area.
`CommonDialog`	`setTitleText(String text)`	Sets the title text in the title area.
`void`	`siteKeyboardCallback(IDialog.KeyboardCallback keyboardCallback)`	Sets a callback for keyboard events.
`void`	`siteRemovable(boolean removable)`	Sets whether to remove the dialog box when the user taps the Back key.

从类继承的方法 ohos.agp.window.dialog.BaseDialog
destroy, hide, isShowing, obtainComponentViaId, onHide, onShowing, registerDisplayCallback, registerRemoveCallback, remove, searchComponentViaId, setAlignment, setAutoClosable, setCornerRadius, setDialogListener, setDuration, setOffset, setSize, setTransparent, show

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - CommonDialog
```
public CommonDialog(Context context)
```
    A constructor used to create a CommonDialog instance.
    The caller needs to pass in a valid context in order to construct a dialog.
    
    参数:
    
    context - Indicates the ohos context.
- 方法详细资料
  - create
```
protected void create()
```
    从类复制的说明: BaseDialog
    
    Creates a Dialog instance.
    This method takes priority over the BaseDialog.onShow() method.
    
    覆盖:
    
    create 在类中 BaseDialog
  - onWindowConfigUpdated
```
protected void onWindowConfigUpdated(WindowManager.LayoutConfig configParam)
```
    Called when the window layout parameters change.
    
    参数:
    
    configParam - Indicates the window layout parameters.
    
    从以下版本开始:
    
    4
  - onWindowSelectionUpdated
```
protected void onWindowSelectionUpdated(boolean isSelectionUpdated)
```
    Called when the window selection state changes.
    
    参数:
    
    isSelectionUpdated - Specifies whether the window is selected. The value true indicates that the window is selected, and false indicates the opposite.
    
    从以下版本开始:
    
    4
  - isMovable
```
public boolean isMovable()
```
    Checks whether a window is movable.
    
    返回:
    
    Returns true if the window is movable; returns false otherwise.
  - setMovable
```
public void setMovable(boolean movable)
```
    Sets whether a window is movable.
    
    参数:
    
    movable - Indicates whether the window is movable. true indicates the window is movable; false indicates the window is not movable.
  - getBoundRect
```
public Rect getBoundRect()
```
    Obtains the bounds of a moving window.
    
    返回:
    
    Returns the bounds of the moving window, in shape of rectangle.
  - setBoundRect
```
public void setBoundRect(Rect boundRect)
```
    Sets the bounds of a moving window.
    
    参数:
    
    boundRect - Indicates the bounds of the window, in shape of rectangle.
  - setTitleIcon
```
public CommonDialog setTitleIcon(int resId,
                                 int iconId)
```
    Sets the icon in the title area.
    Three locations have been reserved for icons in the title area. You can specify where you want the icon to locate by specifying the location ID.
    
    参数:
    
    resId - Indicates the resource id of the icon to be displayed in the title area.
    
    iconId - Indicates the location in the title area where you want the icon to be. There are three options: (0) in front of the text; (1) in the middle; and (2) after the text.
    
    返回:
    
    Returns the CommonDialog object for continuous operations, for example, obj.setTitleText(text).show().
    
    从以下版本开始:
    
    4
    
    另请参阅:
    
    IDialog
  - setTitleText
```
public CommonDialog setTitleText(String text)
```
    Sets the title text in the title area.
    The title area has reserved space for both the title and subtitle. The subtitle can be set only after the title has been set.
    
    参数:
    
    text - Indicates the text content of the title to display.
    
    返回:
    
    Returns the CommonDialog object for continuous operations, for example, obj.setTitleText(text).show().
  - setTitleSubText
```
public CommonDialog setTitleSubText(String text)
```
    Sets the supplementary text information in the title area.
    The supplementary information complements the title to make the information clearer. It can be left blank.
    
    参数:
    
    text - Indicates the supplementary text information to display.
    
    返回:
    
    Returns the CommonDialog object for continuous operations, for example, obj.setTitleText(text).show().
  - setTitleCustomComponent
```
public CommonDialog setTitleCustomComponent(DirectionalLayout component)
```
    Customizes the title area.
    
    参数:
    
    component - Indicates the customized DirectionalLayout object that encapsulates the component to be displayed.
    
    返回:
    
    Returns the CommonDialog object for continuous operations, for example, obj.setTitleText(text).show().
    
    从以下版本开始:
    
    4
  - setContentImage
```
public CommonDialog setContentImage(int resId)
```
    Sets the icon to be displayed in the content area.
    The content area cannot be empty. It must contain either an icon or text, or both; or use a customized content area.
    
    参数:
    
    resId - Indicates the resource id of the content to be displayed.
    
    返回:
    
    Returns the CommonDialog object for continuous operations, for example, obj.setTitleText(text).show().
    
    从以下版本开始:
    
    4
  - setContentText
```
public CommonDialog setContentText(String text)
```
    Sets the text to be displayed in the content area.
    The content area cannot be empty. It must contain either an icon or text, or both; or use a customized content area.
    
    参数:
    
    text - Indicates the text information to display in the content area.
    
    返回:
    
    Returns the CommonDialog object for continuous operations, for example, obj.setTitleText(text).show().
  - setContentCustomComponent
```
public CommonDialog setContentCustomComponent(Component component)
```
    Customizes the content area.
    The content area cannot be empty. It must contain at least an icon or a text, or use a customized content area.
    
    参数:
    
    component - Indicates the customized component.
    
    返回:
    
    Returns the CommonDialog object for continuous operations, for example, obj.setTitleText(text).show().
  - getContentCustomComponent
```
public Component getContentCustomComponent()
```
    Obtains the content displayed in the content area.
    This method obtains the outermost ComponentContainer, which contains all the displayed content.
    
    返回:
    
    Returns the Component object.
  - getButtonComponent
```
public Component getButtonComponent()
```
    Obtains the content of button area.
    This method obtains the outermost ComponentContainer, which contains all the displayed button.
    
    返回:
    
    Returns the Component object.
  - getWindow
```
public Window getWindow()
```
    Obtains the window corresponding to a dialog box.
    
    返回:
    
    Returns the window corresponding to the dialog box.
  - setButton
```
public CommonDialog setButton(int buttonNum,
                              String text,
                              IDialog.ClickedListener listener)
```
    Sets the buttons in the button area.
    The button area can have a maximum of three buttons by default.
    
    参数:
    
    buttonNum - Indicates the button location. There are three options: (0) the first button; (1) the button in the middle; and (2) the last button.
    
    text - Indicates the text displayed on the button.
    
    listener - Indicates the listener for detecting button pressing and releasing events.
    
    返回:
    
    Returns the CommonDialog object for continuous operations, for example, obj.setTitleText(text).show().
    
    另请参阅:
    
    IDialog
  - setImageButton
```
public CommonDialog setImageButton(int buttonNum,
                                   int resId,
                                   IDialog.ClickedListener listener)
```
    Sets the image button for a CommonDialog object.
    
    参数:
    
    buttonNum - Indicates the position of the image button. The numbers 0, 1, and 2 specify that the image button is located at the start, in the middle, and at the end respectively.
    
    resId - Indicates the resource id of the image button resource.
    
    listener - Indicates the listener for image button pressing and releasing events.
    
    返回:
    
    Returns the CommonDialog object for continuous operations, for example, obj.setTitleText(text).show().
    
    从以下版本开始:
    
    4
    
    另请参阅:
    
    IDialog
  - onCreate
```
protected void onCreate()
```
    Called from BaseDialog to set the default layout for the current dialog box.
    
    覆盖:
    
    onCreate 在类中 BaseDialog
  - onShow
```
protected void onShow()
```
    Called from BaseDialog to initialize the content of the panels.
    
    覆盖:
    
    onShow 在类中 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 在类中 BaseDialog
  - setDestroyedListener
```
public void setDestroyedListener(CommonDialog.DestroyedListener destroyedListener)
```
    Sets the dialog destruction listener.
    This listener is responsible for necessary handling before dialog destruction.
    
    参数:
    
    destroyedListener - Indicates the dialog destruction listener.
  - setSwipeToDismiss
```
public boolean setSwipeToDismiss(boolean isEnabled)
```
    Sets whether to enable the feature of exiting a dialog by swiping right on the screen.Use this method after BaseDialog.show() is called.
    
    参数:
    
    isEnabled - Specifies whether to enable the feature of exiting the dialog by swiping on the screen. {code true} indicates enabled; false indicates disabled.
    
    返回:
    
    Returns true if this feature is enabled; returns false otherwise.
    
    从以下版本开始:
    
    4
  - deliverKeyboardCase
```
public boolean deliverKeyboardCase(KeyEvent event)
```
    Delivers a specified keyboard event.
    
    参数:
    
    event - Indicates the keyboard event to deliver.
    
    返回:
    
    Returns true if the keyboard event is successfully delivered; returns false if the keyboard event fails to be delivered and if both clickKeyDown(ohos.multimodalinput.event.KeyEvent) and clickKeyUp(ohos.multimodalinput.event.KeyEvent) have returned false.
    
    从以下版本开始:
    
    3
  - clickKeyDown
```
public boolean clickKeyDown(KeyEvent event)
```
    Called when a key on the keyboard is pressed.
    
    参数:
    
    event - Indicates the key press event.
    
    返回:
    
    Returns true if the key press event is handled; returns false (default) otherwise.
    
    从以下版本开始:
    
    3
  - clickKeyUp
```
public boolean clickKeyUp(KeyEvent event)
```
    Called when a key on the keyboard is released.
    
    参数:
    
    event - Indicates the key release event.
    
    返回:
    
    Returns true if the key release event is handled; returns false (default) otherwise.
    
    从以下版本开始:
    
    3
  - deliverTouchCase
```
public boolean deliverTouchCase(TouchEvent event)
```
    Delivers a specified touch event.
    
    参数:
    
    event - Indicates the touch event to deliver.
    
    返回:
    
    Returns true if the touch event is successfully delivered or has been handled via dealTouchEvent(ohos.multimodalinput.event.TouchEvent); returns false otherwise.
    
    从以下版本开始:
    
    3
  - dealTouchEvent
```
public boolean dealTouchEvent(TouchEvent event)
```
    Called when a touch was pressed event.
    
    参数:
    
    event - Indicates the touch event to deal.
    
    返回:
    
    Returns false for default.
    
    从以下版本开始:
    
    3
  - siteKeyboardCallback
```
public void siteKeyboardCallback(IDialog.KeyboardCallback keyboardCallback)
```
    Sets a callback for keyboard events.
    
    参数:
    
    keyboardCallback - Indicates the callback to set. The callback can handle keyboard events before the dialog box does. Keyboard events that have been handled by the callback will be ignored by the dialog box.
    
    从以下版本开始:
    
    3
  - siteRemovable
```
public void siteRemovable(boolean removable)
```
    Sets whether to remove the dialog box when the user taps the Back key.
    
    参数:
    
    removable - Specifies whether to remove the dialog box. The value true means to remove the dialog box, and false means the opposite.
    
    从以下版本开始:
    
    3
  - dealBackKeyDown
```
public void dealBackKeyDown()
```
    Called when the Back key is pressed and released.
    
    从以下版本开始:
    
    3

类 CommonDialog

嵌套类概要

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

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

字段概要

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

构造器概要

方法概要

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

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

构造器详细资料

CommonDialog

方法详细资料

create

onWindowConfigUpdated

onWindowSelectionUpdated

isMovable

setMovable

getBoundRect

setBoundRect

setTitleIcon

setTitleText

setTitleSubText

setTitleCustomComponent

setContentImage

setContentText

setContentCustomComponent

getContentCustomComponent

getButtonComponent

getWindow

setButton

setImageButton

onCreate

onShow

onDestroy

setDestroyedListener

setSwipeToDismiss

deliverKeyboardCase

clickKeyDown

clickKeyUp

deliverTouchCase

dealTouchEvent

siteKeyboardCallback

siteRemovable

dealBackKeyDown