鸿蒙OS MagicLayout

MagicLayout

java.lang.Object

|—ohos.agp.components.Component

|—|—ohos.agp.components.ComponentContainer

|—|—|—ohos.agp.components.MagicLayout

public class MagicLayout
extends ComponentContainer

表示可以自适应调整组件位置和大小的布局。

MagicLayout 中的组件有七种自适应特性，包括环绕、拉伸、缩放、扩展、比例、均衡和隐藏。

• 包装功能：当当前行空间不足时，MagicLayout 中的组件将被放到下一行。如果组件在布局中垂直排列，则环绕功能将不起作用。
• 拉伸功能：MagicLayout 中的组件可以水平或垂直拉伸以适应布局。
• 缩放功能：MagicLayout 中的组件可以缩放以适应布局。
• 扩展功能：MagicLayout中可以显示的组件数量因容器而异。
• 比例特性：MagicLayout 中的指定组件始终按比例排列。
• 均衡特性：MagicLayout 中的组件可以适应布局的大小变化，相邻组件之间的间距相同。
• 隐藏功能：MagicLayout 中的组件以定义的优先级在水平或垂直方向显示。如果当前布局没有足够的可用空间，则可能会隐藏优先级较低的组件。

Since:

5

嵌套类摘要

字段摘要

构造函数摘要

方法总结

字段详细信息

EQUALIZE_DEFAULT

public static final int EQUALIZE_DEFAULT

表示 MagicLayout 的边缘参与均衡操作。

Since:

7

EQUALIZE_NEAR_EDGE

public static final int EQUALIZE_NEAR_EDGE

表示 MagicLayout 的边缘不参与均衡操作。

Since:

7

FOLD_OBVERSE

public static final int FOLD_OBVERSE

表示两个相邻的组件被包裹起来，左边的留在当前行，右边的放在下一行。

Since:

5

FOLD_REVERSE

public static final int FOLD_REVERSE

表示两个相邻的组件被包裹起来，右边的一个留在当前行，左边的放在下一行。

Since:

5

构造函数详细信息

MagicLayout

public MagicLayout(Context context)

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

参数：

Since:

5

MagicLayout

public MagicLayout(Context context, AttrSet attrSet)

用于在解析 XML 文件后创建具有默认属性集的 MagicLayout 的构造函数。

参数：

Since:

5

MagicLayout

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

用于在 XML 文件解析后创建具有默认属性集和样式的 MagicLayout 的构造函数。

参数：

Since:

5

方法详情

setAlignment

public void setAlignment(int alignment)

设置组件如何在 MagicLayout 的剩余空间（如果有）中对齐。 水平方向默认值为 LayoutAlignment.START，垂直方向默认值为 LayoutAlignment.TOP。

参数：

Since:

5

setOrientation

public void setOrientation(int orientation)

设置组件在布局中的排列方向。

参数：

Since:

5

setFoldEnabled

public void setFoldEnabled(boolean isFoldEnabled)

设置是否允许换行，如果当前行没有足够的空间，则将组件放置到下一行。

如果布局的宽度为 MATCH_CONTENT 或方向为 Component.VERTICAL，则换行无论如何都不会生效。 当组件的宽度为 MATCH_CONTENT 时，换行可能会导致它的一部分不可见。

参数：

Since:

5

setFoldDirection

public void setFoldDirection(int foldDirection)

设置换行的方向，默认为 MagicLayout.FOLD_OBVERSE。

参数：

Since:

5

setFoldAlignment

public void setFoldAlignment(int foldAlignment)

设置换行后每行中的组件如何对齐。

垂直对齐方式对同一行的组件生效，水平对齐方式对不同行的组件生效。

参数：

Since:

5

getAlignment

public int getAlignment()

获取布局中组件的对齐方式。

返回:

返回组件对齐模式。

Since:

5

getOrientation

public int getOrientation()

获取组件在布局中的排列方向。

返回:

返回 Component.HORIZONTAL 或 Component.VERTICAL。

Since:

5

isFoldEnabled

public boolean isFoldEnabled()

检查是否启用了换行。

返回:

如果启用换行，则返回 {code true}； 否则返回 false。

Since:

5

getFoldDirection

public int getFoldDirection()

获取换行的方向。

返回:

根据如何通过 setFoldDirection(int) 设置环绕方向，返回 FOLD_OBVERSE 或 FOLD_REVERSE。

Since:

5

getFoldAlignment

public int getFoldAlignment()

执行换行后，获取每行中组件的对齐方式。

返回:

返回每行中组件的对齐方式。

Since:

5

setHorizontalStretchEnabled

public void setHorizontalStretchEnabled(boolean isEnabled)

设置是否启用水平拉伸功能。

参数：

Since:

7

isHorizontalStretchEnabled

public boolean isHorizontalStretchEnabled()

检查是否启用了水平拉伸功能。

返回:

如果启用了水平拉伸功能，则返回 true； 否则返回 false。

Since:

7

setVerticalStretchEnabled

public void setVerticalStretchEnabled(boolean isEnabled)

设置是否启用垂直拉伸功能。

参数：

Since:

7

isVerticalStretchEnabled

public boolean isVerticalStretchEnabled()

检查是否启用了垂直拉伸功能。

返回:

如果启用了垂直拉伸功能，则返回 true； 否则返回 false。

Since:

7

setWeightEnabled

public void setWeightEnabled(boolean isEnabled)

设置是否启用比例功能。

参数：

Since:

7

isWeightEnabled

public boolean isWeightEnabled()

检查是否启用了比例功能。

返回:

如果启用了比例功能，则返回 true； 否则返回 false。

Since:

7

isScaleEnabled

public boolean isScaleEnabled()

检查是否启用了缩放功能。

返回:

如果启用了缩放功能，则返回 true； 否则返回 false。

Since:

7

setScaleEnabled

public void setScaleEnabled(boolean isEnabled)

设置是否开启缩放功能。

参数：

Since:

7

getMaxWidth

public int getMaxWidth()

获取 MagicLayout 的最大宽度。

返回:

返回最大宽度，默认为 Integer.MAX_VALUE。

Since:

7

setMaxWidth

public void setMaxWidth(int maxWidth)

设置 MagicLayout 的最大宽度。

参数：

Since:

7

getMaxHeight

public int getMaxHeight()

获取 MagicLayout 的最大高度。

返回:

返回最大高度，默认为 Integer.MAX_VALUE。

Since:

7

setMaxHeight

public void setMaxHeight(int maxHeight)

设置 MagicLayout 的最大高度。

参数：

Since:

7

setExtendEnabled

public void setExtendEnabled(boolean isEnabled)

设置是否启用扩展功能。

参数：

Since:

7

isExtendEnabled

public boolean isExtendEnabled()

检查是否启用了扩展功能。

返回:

如果启用了扩展功能，则返回 true； 否则返回 false。

Since:

7

setExtendRevealEnabled

public void setExtendRevealEnabled(boolean isEnabled)

设置是否可以显示在 MagicLayout 中启用扩展功能的组件。

参数：

Since:

7

isExtendRevealEnabled

public boolean isExtendRevealEnabled()

检查是否可以显示在 MagicLayout 中启用扩展功能的组件。

返回:

如果组件可以显示，则返回 true； 否则返回 false。

Since:

7

setExtendRevealLength

public void setExtendRevealLength(int revealLength)

在 MagicLayout 中设置具有扩展功能的组件的显示长度。

参数：

Since:

7

getExtendRevealLength

public int getExtendRevealLength()

获取MagicLayout中具有扩展功能的组件的显示长度。

返回:

返回组件的显示长度，默认为 16（在 vp 中）。

Since:

7

setDefaultExtendMargin

public void setDefaultExtendMargin(int defaultMargin)

设置 MagicLayout 布局中组件之间的默认边距。

参数：

Since:

7

getDefaultExtendMargin

public int getDefaultExtendMargin()

获取 MagicLayout 中组件之间的默认边距。

返回:

返回通过 MagicLayout#setDefaultExtendMargin(int defaultMargin) 设置的默认边距。 如果不调用MagicLayout#setDefaultExtendMargin(int defaultMargin)，则在可以显示具有扩展功能的组件的情况下返回16（在vp中），否则返回0（在vp中）。

Since:

7

setMinExtendMargin

public void setMinExtendMargin(int minMargin)

为扩展操作设置 MagicLayout 中组件之间的最小边距。

参数：

Since:

7

getMinExtendMargin

public int getMinExtendMargin()

获取 MagicLayout 中组件之间的最小边距以进行扩展操作。

返回:

返回最小边距。

Since:

7

setMinWidth

public void setMinWidth(int minWidth)

设置 MagicLayout 的最小宽度。

覆盖：

类 Component 中的 setMinWidth

参数：

Since:

7

setMinHeight

public void setMinHeight(int minHeight)

设置 MagicLayout 的最小高度。

覆盖：

类 Component 中的 setMinHeight

参数：

Since:

7

setHideEnabled

public void setHideEnabled(boolean isEnabled)

设置是否启用隐藏功能。

参数：

Since:

7

isHideEnabled

public boolean isHideEnabled()

检查是否启用了隐藏功能。

返回:

如果启用了隐藏功能，则返回 true； 否则返回 false。

Since:

7

setEqualizeEnabled

public void setEqualizeEnabled(boolean isEnabled)

设置是否启用均衡功能。 均衡功能生效后生成的组件之间的边距可能与您通过 ComponentContainer.LayoutConfig#getLayoutConfig() 获得的边距不同。

参数：

Since:

7

isEqualizeEnabled

public boolean isEqualizeEnabled()

检查是否启用了均衡功能。

返回:

如果启用均衡功能，则返回 true； 否则返回 false。

Since:

7

setEqualizeType

public void setEqualizeType(int equalizeType)

设置均衡类型。

参数：

Since:

7

getEqualizeType

public int getEqualizeType()

获取均衡类型。

返回:

返回 MagicLayout.EQUALIZE_DEFAULT 或 MagicLayout.EQUALIZE_NEAR_EDGE。 前者表示MagicLayout的边缘参与均衡操作，后者表示相反的情况。

Since:

7

setMaxEqualizeMargin

public void setMaxEqualizeMargin(int maxMargin)

为均衡操作设置 MagicLayout 中组件之间的最大边距。

参数：

Since:

7

getMaxEqualizeMargin

public int getMaxEqualizeMargin()

获取 MagicLayout 中组件之间的最大边距以进行均衡操作。

返回:

返回最大边距。

Since:

7

setMinEqualizeMargin

public void setMinEqualizeMargin(int minMargin)

为均衡操作设置 MagicLayout 中组件之间的最小边距。

参数：

Since:

7

getMinEqualizeMargin

public int getMinEqualizeMargin()

获取 MagicLayout 中组件之间的最小边距以进行均衡操作。

返回:

返回最小边距。

Since:

7

verifyLayoutConfig

public ComponentContainer.LayoutConfig verifyLayoutConfig(ComponentContainer.LayoutConfig config)

从类复制的描述：ComponentContainer

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

指定者：

接口 ComponentParent 中的 verifyLayoutConfig

覆盖：

ComponentContainer 类中的 verifyLayoutConfig

参数：

返回:

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

createLayoutConfig

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

从类复制的描述：ComponentContainer

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

覆盖：

ComponentContainer 类中的 createLayoutConfig

参数：

返回:

返回创建的布局参数。