树叶云鸿蒙OS教程：鸿蒙OS SlideDrawer

SlideDrawer

java.lang.Object

|—ohos.agp.components.Component

|—|—ohos.agp.components.ComponentContainer

|—|—|—ohos.agp.components.SlideDrawer

public class SlideDrawer
extends ComponentContainer

提供 SlideDrawer 项。

此类允许显示主要组件，同时隐藏与不同方向（开始、顶部、结束和底部）相关的四个可选组件的集合。 要显示可选组件，最终用户需要从相应的方向滑动。

Since:

5

嵌套类摘要

字段摘要

构造函数摘要

方法总结

字段详细信息

DEFAULT_DISPLAY_MODE

public static final SlideDrawer.DisplayMode DEFAULT_DISPLAY_MODE

指示 DisplayMode 的默认值。

Since:

5

DEFAULT_OPEN_THRESHOLD

public static final float DEFAULT_OPEN_THRESHOLD

指示可滑动打开可选组件的默认百分比值。

Since:

5

构造函数详细信息

SlideDrawer

public SlideDrawer(Context context)

用于使用默认属性集和默认样式创建 SlideDrawer 实例的默认构造函数。

参数：

Since:

5

SlideDrawer

public SlideDrawer(Context context, AttrSet attrSet)

用于在 XML 文件解析后使用指定的属性集和默认样式创建 SlideDrawer 实例的构造函数。

参数：

Since:

5

SlideDrawer

public SlideDrawer(Context context, AttrSet attrSet, String styleName)

用于在解析 XML 文件后使用指定的属性集和指定样式创建 SlideDrawer 实例的构造函数。

参数：

Since:

5

方法详情

addSlideListener

public void addSlideListener(SlideDrawer.SlideListener listener)

添加幻灯片侦听器。

参数：

Throws:

Since:

5

removeSlideListener

public void removeSlideListener(SlideDrawer.SlideListener listener)

删除幻灯片侦听器。

您可以使用 removeAllSlideListeners() 删除所有侦听器。

参数：

Throws:

Since:

5

removeAllSlideListeners

public void removeAllSlideListeners()

删除所有幻灯片侦听器。

Since:

5

hasSlideListeners

public boolean hasSlideListeners()

检查是否有任何侦听器存储在 SlideDrawer 中。

返回:

如果 SlideDrawer 包含任何侦听器，则返回 true； 否则返回 false。

Since:

5

addSlideDisable

public void addSlideDisable(SlideDrawer.SlideDisable callback)

添加允许实时禁用幻灯片事件的回调。

参数：

Throws:

Since:

5

removeSlideDisable

public void removeSlideDisable(SlideDrawer.SlideDisable callback)

删除允许实时禁用幻灯片事件的回调。

您可以使用 removeAllSlideDisables() 删除所有此类回调。

参数：

Throws:

Since:

5

removeAllSlideDisables

public void removeAllSlideDisables()

删除所有允许实时禁用幻灯片事件的回调。

Since:

5

hasSlideDisables

public boolean hasSlideDisables()

检查是否有任何禁用回调存储在 SlideDrawer 中。

返回:

如果 SlideDrawer 包含任何禁用回调，则返回 true； 否则返回 false。

Since:

5

setTouchForClose

public void setTouchForClose(boolean isEnabled)

设置 SlideDrawer 是否可以通过触摸关闭。

参数：

Since:

5

isTouchForClose

public boolean isTouchForClose()

检查 SlideDrawer 是否可以通过触摸关闭。

返回:

如果 SlideDrawer 可以通过触摸关闭，则返回 true； 否则返回 false。

Since:

5

setSlideEnabled

public void setSlideEnabled(boolean isEnabled)

设置 SlideDrawer 是否可以被用户滑动。

参数：

Since:

5

isSlideEnabled

public boolean isSlideEnabled()

检查是否启用了滑动手势。

返回:

如果启用了滑动手势，则返回 true； 否则返回 false。

Since:

5

setOpenThreshold

public void setOpenThreshold(float percent)

设置可以滑动打开可选组件的百分比值。

默认百分比值为 DEFAULT_OPEN_THRESHOLD。

参数：

Throws:

Since:

5

getOpenThreshold

public float getOpenThreshold()

获取可以滑动打开可选组件的百分比值。

默认百分比值为 DEFAULT_OPEN_THRESHOLD。

返回:

返回百分比值。

Since:

5

getSlideDistanceRatio

public float getSlideDistanceRatio()

获取当前从起始位置的滑动百分比。

返回:

返回滑动百分比。

Since:

5

setMaximumSlideDistance

public void setMaximumSlideDistance(int max)

设置最大滑动距离。

参数：

Throws:

Since:

5

getSlideDistance

public int getSlideDistance(SlideDrawer.SlideDirection direction)

获取某个方向的最大滑动距离。

参数：

返回:

返回最大滑动距离。

Throws:

Since:

5

getSlideState

public SlideDrawer.DrawerState getSlideState()

获取当前 SlideDrawer 状态。 状态值可以是 DrawerState#OPEN、DrawerState#MIDDLE 或 DrawerState#CLOSE。

返回:

返回当前状态。

Since:

5

getSlideDirection

public SlideDrawer.SlideDirection getSlideDirection()

获取当前 SlideDrawer 方向。 该值可以是 SlideDirection#START、SlideDirection#TOP、SlideDirection#END 或 SlideDirection#BOTTOM。 如果当前 SlideDrawer 状态不是 DrawerState#OPEN，则返回值为 null。

返回:

返回当前的 SlideDirection 或 null。

Since:

5

setDisplayMode

public void setDisplayMode(SlideDrawer.DisplayMode mode)

设置所有可选组件的显示模式。 模式可以是 DisplayMode#NO_ANIMATION 或 DisplayMode#WITH_ANIMATION。

默认模式为 DEFAULT_DISPLAY_MODE。

如果您希望仅为指定方向设置显示模式，可以使用 setDisplayMode(ohos.agp.components.SlideDrawer.DisplayMode,ohos.agp.components.SlideDrawer.SlideDirection) 方法。

您可以使用 setDisplayMode(ohos.agp.components.SlideDrawer.DisplayMode,ohos.agp.components.SlideDrawer.DisplayMode,ohos.agp.components.SlideDrawer.DisplayMode,ohos.agp.components.SlideDrawer.DisplayMode) 方法设置不同的 一次调用中所有四个方向的值。

不建议同时使用 DisplayMode#NO_ANIMATION 和 padding。

参数：

Throws:

Since:

5

setDisplayMode

public void setDisplayMode(SlideDrawer.DisplayMode mode, SlideDrawer.SlideDirection direction)

设置可选组件从某个方向的显示模式。 模式可以是 DisplayMode#NO_ANIMATION 或 DisplayMode#WITH_ANIMATION。

默认模式为 DEFAULT_DISPLAY_MODE。

您可以使用 setDisplayMode(ohos.agp.components.SlideDrawer.DisplayMode,ohos.agp.components.SlideDrawer.DisplayMode,ohos.agp.components.SlideDrawer.DisplayMode,ohos.agp.components.SlideDrawer.DisplayMode) 方法设置不同的 一次调用中所有四个方向的值。

您可以使用 setDisplayMode(ohos.agp.components.SlideDrawer.DisplayMode) 方法为所有方向设置指定的显示模式。

不建议同时使用 DisplayMode#NO_ANIMATION 和 padding。

参数：

Throws:

Since:

5

setDisplayMode

public void setDisplayMode(SlideDrawer.DisplayMode startMode, SlideDrawer.DisplayMode topMode, SlideDrawer.DisplayMode endMode, SlideDrawer.DisplayMode bottomMode)

为所有方向设置不同的显示模式。 模式可以是 DisplayMode#NO_ANIMATION 或 DisplayMode#WITH_ANIMATION。

默认模式为 DEFAULT_DISPLAY_MODE。

如果您希望仅为指定方向设置显示模式，可以使用 setDisplayMode(ohos.agp.components.SlideDrawer.DisplayMode,ohos.agp.components.SlideDrawer.SlideDirection) 方法。

您可以使用 setDisplayMode(ohos.agp.components.SlideDrawer.DisplayMode) 方法为所有方向设置指定的显示模式。

不建议同时使用 DisplayMode#NO_ANIMATION 和 padding。

参数：

Throws:

Since:

5

getDisplayMode

public SlideDrawer.DisplayMode getDisplayMode(SlideDrawer.SlideDirection direction)

获取可选组件在某个方向上的显示方式。

默认模式为 DEFAULT_DISPLAY_MODE。

您可以使用 getDisplayMode() 方法一次调用获取所有方向的显示模式。

参数：

返回:

返回显示模式。

Throws:

Since:

5

getDisplayMode

public SlideDrawer.DisplayMode[] getDisplayMode()

获取所有方向的可选组件的显示模式。

默认模式为 DEFAULT_DISPLAY_MODE。

您可以使用getDisplayMode(ohos.agp.components.SlideDrawer.SlideDirection) 方法获取某个方向的显示模式。

返回:

返回模式数组，其中： 第一个元素（索引 0）- SlideDirection#START 方向的模式； 第二个元素（索引 1） – SlideDirection#TOP 方向的模式； 第三个元素（索引 2）- SlideDirection#BOTTOM 方向的模式； 第四个元素（索引 3）- SlideDirection#END 方向的模式。

Since:

5

open

public boolean open()

如果 SlideDrawer 包含仅用于单向的可选组件，则打开 SlideDrawer）。

返回:

如果操作成功，则返回 true； 否则返回 false。

Since:

5

open

public boolean open(SlideDrawer.SlideDirection direction)

如果 SlideDrawer 当前状态为 DrawerState#CLOSE，则朝某个方向打开 SlideDrawer。 如果 SlideDrawer 包含仅可以从一个方向与幻灯片一起显示的可选组件，则可以传递 null 作为方向以打开 SlideDrawer。

参数：

返回:

如果操作成功，则返回 true； 否则返回 false。

Since:

5

openSmoothly

public boolean openSmoothly()

如果 SlideDrawer 包含仅用于单向的可选组件，则平滑打开 SlideDrawer）。

返回:

如果操作成功，则返回 true； 否则返回 false。

Since:

5

openSmoothly

public boolean openSmoothly(SlideDrawer.SlideDirection direction)

如果 SlideDrawer 当前状态为 DrawerState#CLOSE，则在某个方向平滑打开 SlideDrawer。 如果 SlideDrawer 包含仅可以从一个方向与幻灯片一起显示的可选组件，则可以传递 null 作为方向以打开 SlideDrawer。

参数：

返回:

如果操作成功，则返回 true； 否则返回 false。

Since:

5

openSmoothly

public boolean openSmoothly(int interval)

如果 SlideDrawer 包含仅用于单向的可选组件，则平滑打开 SlideDrawer）。

参数：

返回:

如果操作成功，则返回 true； 否则返回 false。

Throws:

Since:

5

openSmoothly

public boolean openSmoothly(SlideDrawer.SlideDirection direction, int interval)

如果 SlideDrawer 当前状态为 DrawerState#CLOSE，则在某个方向平滑打开 SlideDrawer。 如果 SlideDrawer 包含仅可以从一个方向与幻灯片一起显示的可选组件，则可以传递 null 作为方向以打开 SlideDrawer。

参数：

返回:

如果操作成功，则返回 true； 否则返回 false。

Throws:

Since:

5

close

public boolean close()

如果当前状态为 DrawerState#OPEN，则关闭 SlideDrawer。

返回:

如果操作成功，则返回 true； 否则返回 false。

Since:

5

close

public boolean close(SlideDrawer.SlideDirection direction)

如果当前状态为 DrawerState#OPEN 且方向参数等于 getSlideDirection() 返回的值，则在某个方向关闭 SlideDrawer。 无论如何，您都可以传递 null 作为关闭 SlideDrawer 的方向。

参数：

返回:

如果操作成功，则返回 true； 否则返回 false。

Since:

5

closeSmoothly

public boolean closeSmoothly()

如果 SlideDrawer 当前状态为 DrawerState#OPEN，则平滑关闭 SlideDrawer。

返回:

如果操作成功，则返回 true； 否则返回 false。

Since:

5

closeSmoothly

public boolean closeSmoothly(SlideDrawer.SlideDirection direction)

如果当前状态为 DrawerState#OPEN 且方向参数等于 getSlideDirection() 返回的值，则在某个方向平滑关闭 SlideDrawer。 无论如何，您都可以传递 null 作为关闭 SlideDrawer 的方向。

参数：

返回:

如果操作成功，则返回 true； 否则返回 false。

Since:

5

closeSmoothly

public boolean closeSmoothly(int interval)

如果 SlideDrawer 当前状态为 DrawerState#OPEN，则平滑关闭 SlideDrawer。

参数：

返回:

如果操作成功，则返回 true； 否则返回 false。

Throws:

Since:

5

closeSmoothly

public boolean closeSmoothly(SlideDrawer.SlideDirection direction, int interval)

如果当前状态为 DrawerState#OPEN 且方向参数等于 getSlideDirection() 返回的值，则在某个方向平滑关闭 SlideDrawer。 无论如何，您都可以传递 null 作为关闭 SlideDrawer 的方向。

参数：

返回:

如果操作成功，则返回 true； 否则返回 false。

Throws:

Since:

5

toggle

public boolean toggle()

在 DrawerState#OPEN 和 DrawerState#CLOSE 之间切换 SlideDrawer 状态。

返回:

如果操作成功，则返回 true； 否则返回 false。

Since:

5

toggle

public boolean toggle(SlideDrawer.SlideDirection direction)

在特定方向上切换 DrawerState#OPEN 和 DrawerState#CLOSE 之间的 SlideDrawer 状态。 如果 SlideDrawer 包含仅可以从一个方向与幻灯片一起显示的可选组件，则可以传递 null 作为方向以切换 SlideDrawer 状态。

参数：

返回:

如果操作成功，则返回 true； 否则返回 false。

Since:

5

toggleSmoothly

public boolean toggleSmoothly()

在 DrawerState#OPEN 和 DrawerState#CLOSE 之间平滑切换 SlideDrawer 状态。

返回:

如果操作成功，则返回 true； 否则返回 false。

Since:

5

toggleSmoothly

public boolean toggleSmoothly(SlideDrawer.SlideDirection direction)

DrawerState#OPEN 和 DrawerState#CLOSE 之间的 SlideDrawer 状态在某个方向上平滑切换。 如果 SlideDrawer 包含仅可以从一个方向与幻灯片一起显示的可选组件，则可以传递 null 作为方向以切换 SlideDrawer 状态。

参数：

返回:

如果操作成功，则返回 true； 否则返回 false。

Since:

5

toggleSmoothly

public boolean toggleSmoothly(int interval)

在 DrawerState#OPEN 和 DrawerState#CLOSE 之间平滑切换 SlideDrawer 状态。

参数：

返回:

如果操作成功，则返回 true； 否则返回 false。

Throws:

Since:

5

toggleSmoothly

public boolean toggleSmoothly(SlideDrawer.SlideDirection direction, int interval)

DrawerState#OPEN 和 DrawerState#CLOSE 之间的 SlideDrawer 状态在某个方向上平滑切换。 如果 SlideDrawer 包含仅可以从一个方向与幻灯片一起显示的可选组件，则可以传递 null 作为方向以切换 SlideDrawer 状态。

参数：

返回:

如果操作成功，则返回 true； 否则返回 false。

Throws:

Since:

5

verifyLayoutConfig

public ComponentContainer.LayoutConfig verifyLayoutConfig(ComponentContainer.LayoutConfig config)

根据当前布局类型验证布局参数。

指定者：

接口 ComponentParent 中的 verifyLayoutConfig

覆盖：

ComponentContainer 类中的 verifyLayoutConfig

参数：

返回:

返回 LayoutConfig 实例，它表示布局参数。

createLayoutConfig

public ComponentContainer.LayoutConfig createLayoutConfig(Context context, AttrSet attrSet)

使用子组件的属性集创建布局参数。

覆盖：

ComponentContainer 类中的 createLayoutConfig

参数：

返回:

返回创建的布局参数。

removeComponents

public void removeComponents(int start, int count)

从组件列表中的指定位置移除所有组件。

指定者：

接口 ComponentParent 中的 removeComponents

覆盖：

ComponentContainer 类中的 removeComponents

参数：