BaseDialog

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

所有已实现的接口:

IDialog

直接已知子类:

CommonDialog, DisplayDialog, PopupDialog
```
public class BaseDialog
extends Object
implements IDialog
```
Implements class of the IDialog
This class implements basic function of the IDialog class. It is inherited by its child classes to implement a specific dialog box.

从以下版本开始:

1

另请参阅:

IDialog

嵌套类概要

嵌套类
限定符和类型	类	说明
`static interface`	`BaseDialog.DialogListener`	Represents the listener for events of a dialog box.
`static interface`	`BaseDialog.DisplayCallback`	Represents the callback that is invoked when a dialog box is displayed.
`static interface`	`BaseDialog.RemoveCallback`	Represents the callback that is invoked when a dialog box is removed.

从接口继承的嵌套类/接口 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

构造器概要

构造器
构造器	说明
`BaseDialog(Context context)`	Base class used to create a `Dialog` instance.
`BaseDialog(Context context, int flag)`	The constructor of BaseDialog for DisplayDialog.

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`protected void`	`create()`	Creates a `Dialog` instance.
`void`	`destroy()`	Destroys an existing dialog box.
`void`	`hide()`	Hides the content of a dialog box.
`boolean`	`isShowing()`	Checks if a `Dialog` instance is showing.
`Component`	`obtainComponentViaId(int id)`	Searches for the component with a specified ID.
`protected void`	`onCreate()`	Callback interfaced used when creating a `Dialog` instance.
`protected void`	`onDestroy()`	Callback interface used when enabling automatic close of a `Dialog` instance.
`protected void`	`onHide()`	Callback interface used when hiding a `Dialog` instance.
`protected void`	`onShow()`	Callback interface used when showing a `Dialog` instance.
`protected void`	`onShowing()`	Called when the pre-layout of a dialog box is complete and the content is being shown in the dialog box.
`void`	`registerDisplayCallback(BaseDialog.DisplayCallback callback)`	Registers a callback that is invoked when a dialog box is displayed.
`void`	`registerRemoveCallback(BaseDialog.RemoveCallback callback)`	Registers a callback that is invoked when a dialog box is removed.
`void`	`remove()`	Removes a dialog box.
`Component`	`searchComponentViaId(int id)`	Searches for the component with a specified ID.
`BaseDialog`	`setAlignment(int alignment)`	Sets the alignment attribute of a `Dialog` instance.
`BaseDialog`	`setAutoClosable(boolean closable)`	Sets whether to enable automatic close a dialog box.
`BaseDialog`	`setCornerRadius(float radius)`	Sets the radius of the round corners of a dialog box.
`void`	`setDialogListener(BaseDialog.DialogListener listener)`	Sets the listener for events of a dialog box.
`BaseDialog`	`setDuration(int ms)`	Sets the duration for automatic close of a dialog box.
`BaseDialog`	`setOffset(int offsetX, int offsetY)`	Sets the offset for a dialog box.
`BaseDialog`	`setSize(int width, int height)`	Sets the size of a dialog box.
`BaseDialog`	`setTransparent(boolean isEnable)`	Sets whether to enable transparent background for a dialog box.
`void`	`show()`	Shows the content of a dialog box.

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

- 构造器详细资料
  - BaseDialog
```
public BaseDialog(Context context)
```
    Base class used to create a Dialog instance.
    When calling this method, you must obtain a valid Context object.
    
    参数:
    
    context - Indicates the context.
  - BaseDialog
```
public BaseDialog(Context context,
                  int flag)
```
    The constructor of BaseDialog for DisplayDialog.
    When calling this method, you must obtain a valid Context object.
    
    参数:
    
    context - Indicates the context.
    
    flag - Indicates the flag.
    
    抛出:
    
    WindowManager.PermissionException - Throws this exception if dialog context is invalid.
- 方法详细资料
  - show
```
public void show()
```
    Shows the content of a dialog box.
    
    指定者:
    
    show 在接口中 IDialog
    
    抛出:
    
    WindowManager.PermissionException - Throws this exception if no dialog box is found.
  - hide
```
public void hide()
```
    Hides the content of a dialog box.
    A hidden dialog box is not destroyed.
    
    指定者:
    
    hide 在接口中 IDialog
  - destroy
```
public void destroy()
```
    Destroys an existing dialog box.
    
    指定者:
    
    destroy 在接口中 IDialog
  - isShowing
```
public boolean isShowing()
```
    Checks if a Dialog instance is showing.
    The showing state of a dialog box remains unchanged even it is overlapped.
    
    返回:
    
    Returns True if the Dialog instance is showing; returns False otherwise.
  - setTransparent
```
public BaseDialog setTransparent(boolean isEnable)
```
    Sets whether to enable transparent background for a dialog box.
    
    参数:
    
    isEnable - Indicates whether transparent background will be enabled. True indicates is enabled; False indicates disabled.
    
    返回:
    
    Returns the BaseDialog object for continuous operations, for example, obj.setAutoClosable(false).show().
  - setCornerRadius
```
public BaseDialog setCornerRadius(float radius)
```
    Sets the radius of the round corners of a dialog box.
    
    参数:
    
    radius - Indicates the radius of the round corners of the dialog box.
    
    返回:
    
    Returns the BaseDialog object for continuous operations, for example, obj.setAutoClosable(false).show().
  - setAutoClosable
```
public BaseDialog setAutoClosable(boolean closable)
```
    Sets whether to enable automatic close a dialog box.
    If automatic close is enabled, a dialog box automatically closes when touching or clicking a position outside the dialog box.
    
    参数:
    
    closable - Indicates whether to enable automatic close of the dialog box.
    
    返回:
    
    Returns the BaseDialog object for continuous operations, for example, obj.setAutoClosable(false).show().
  - setDuration
```
public BaseDialog setDuration(int ms)
```
    Sets the duration for automatic close of a dialog box.
    
    参数:
    
    ms - Indicates the duration for automatic close of the Dialog instance.
    
    返回:
    
    Returns the BaseDialog object for continuous operations, for example, obj.setAutoClosable(false).show().
  - setSize
```
public BaseDialog setSize(int width,
                          int height)
```
    Sets the size of a dialog box.
    The default size is used If the user leaves the size unspecified.
    
    参数:
    
    width - Indicates the expected width of the dialog box.
    
    height - Indicates the expected height of the dialog box.
    
    返回:
    
    Returns the BaseDialog object for continuous operations, for example, obj.setAutoClosable(false).show().
  - setAlignment
```
public BaseDialog setAlignment(int alignment)
```
    Sets the alignment attribute of a Dialog instance.
    By default, a dialog box is displayed at the center.
    
    参数:
    
    alignment - Indicates the expected position to display the dialog box.
    
    返回:
    
    Returns the BaseDialog object for continuous operations, for example, obj.setAutoClosable(false).show().
    
    从以下版本开始:
    
    4
  - setOffset
```
public BaseDialog setOffset(int offsetX,
                            int offsetY)
```
    Sets the offset for a dialog box.
    The offset can be set after the alignment attribute is set.
    
    参数:
    
    offsetX - Indicates the X-axis offset of the dialog box.
    
    offsetY - Indicates the Y-axis offset of the dialog box.
    
    返回:
    
    Returns the BaseDialog object for continuous operations, for example, obj.setAutoClosable(false).show().
  - setDialogListener
```
public void setDialogListener(BaseDialog.DialogListener listener)
```
    Sets the listener for events of a dialog box.
    
    参数:
    
    listener - Indicates the listener for events of the dialog box.
  - create
```
protected void create()
```
    Creates a Dialog instance.
    This method takes priority over the onShow() method.
  - onCreate
```
protected void onCreate()
```
    Callback interfaced used when creating a Dialog instance.
    This method takes priority over the onShow() method.
  - onShow
```
protected void onShow()
```
    Callback interface used when showing a Dialog instance.
    This method takes priority over the onShowing() method.
  - onHide
```
protected void onHide()
```
    Callback interface used when hiding a Dialog instance.
    This callback is triggered only when the hide() method is invoked
  - onDestroy
```
protected void onDestroy()
```
    Callback interface used when enabling automatic close of a Dialog instance.
    This callback is triggered only when the destroy() method is invoked.
  - onShowing
```
protected void onShowing()
```
    Called when the pre-layout of a dialog box is complete and the content is being shown in the dialog box.
  - registerRemoveCallback
```
public void registerRemoveCallback(BaseDialog.RemoveCallback callback)
```
    Registers a callback that is invoked when a dialog box is removed.
    
    参数:
    
    callback - Indicates the callback to register.
    
    从以下版本开始:
    
    4
  - remove
```
public void remove()
```
    Removes a dialog box.
    When a dialog box is removed via this method, RemoveCallback is invoked. This is how this method differs from destroy().
    
    指定者:
    
    remove 在接口中 IDialog
    
    从以下版本开始:
    
    3
  - registerDisplayCallback
```
public void registerDisplayCallback(BaseDialog.DisplayCallback callback)
```
    Registers a callback that is invoked when a dialog box is displayed.
    
    参数:
    
    callback - Indicates the callback to register.
    
    从以下版本开始:
    
    4
  - searchComponentViaId
```
public Component searchComponentViaId(int id)
```
    Searches for the component with a specified ID.
    
    参数:
    
    id - Indicates the ID of the component to search for.
    
    返回:
    
    Returns the component if found; returns null if id is invalid, indicating that the component does not exist or no dialog box is available.
    
    从以下版本开始:
    
    4
  - obtainComponentViaId
```
public final Component obtainComponentViaId(int id)
```
    Searches for the component with a specified ID.
    This method is the same as searchComponentViaId(int Id), except that an exception is thrown if the specified ID is invalid.
    
    参数:
    
    id - Indicates the ID of the component to search for.
    
    返回:
    
    Returns the component with the specified ID.
    
    抛出:
    
    IllegalStateException - Throws this exception if id is invalid.
    
    从以下版本开始:
    
    4

类 BaseDialog

嵌套类概要

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

字段概要

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

构造器概要

方法概要

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

构造器详细资料

BaseDialog

BaseDialog

方法详细资料

show

hide

destroy

isShowing

setTransparent

setCornerRadius

setAutoClosable

setDuration

setSize

setAlignment

setOffset

setDialogListener

create

onCreate

onShow

onHide

onDestroy

onShowing

registerRemoveCallback

remove

registerDisplayCallback

searchComponentViaId

obtainComponentViaId