鸿蒙OS ProgressBar

ProgressBar

java.lang.Object

|—ohos.agp.components.Component

|—|—ohos.agp.components.ProgressBar

public class ProgressBar
extends Component

提供用于指示 UI 上操作的进度的元素。

进度条支持确定类型和不确定类型。 进度条显示在 UI 或通知中，不会打扰用户。

不确定的进展

当操作所需的时间不确定时，使用不确定的进度条。

确定进度

当您需要显示操作的具体进度量时，使用确定进度条。 您可以使用 setProgressValue(int) 函数来更新当前进度。 默认情况下，当进度条上显示的进度值达到 100 时，操作完成。

Since:

1

嵌套类摘要

字段摘要

构造函数摘要

方法总结

构造函数详细信息

ProgressBar

public ProgressBar(Context context)

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

参数：

ProgressBar

public ProgressBar(Context context, AttrSet attrSet)

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

参数：

ProgressBar

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

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

参数：

方法详情

setOrientation

public void setOrientation(int orientation)

设置进度条方向。

参数：

Since:

2

getOrientation

public int getOrientation()

获取进度条方向。

返回:

返回进度条方向，可以是 Component.HORIZONTAL 或 Component.VERTICAL。

Since:

2

setMinValue

public void setMinValue(int min)

设置进度条的下限。

此方法在实际进度小于下限时显示进度条的下限。

参数：

Since:

4

setMaxValue

public void setMaxValue(int max)

设置进度条的上限。

当实际进度大于上限时，该方法在进度条上显示上限。

参数：

Since:

4

setProgressValue

public void setProgressValue(int progress)

设置进度条的当前进度。

此方法立即更新进度指示器。

参数：

Since:

4

setViceProgress

public void setViceProgress(int progress)

设置进度条的次要进度值。

参数：

Since:

4

setStep

public void setStep(int step)

设置进度步骤。

此方法设置增加或减少进度值的步骤。 默认值为 1。如果步长为 10，则进度值为 10 的倍数。

参数：

Since:

1

setIndeterminate

public void setIndeterminate(boolean indeterminate)

设置是否为进度条启用不确定模式。

如果禁用不确定模式，将显示进度值。 如果启用了不确定模式，则会显示无限循环的动画。

参数：

Since:

1

isIndeterminate

public boolean isIndeterminate()

检查是否启用了不确定模式。

返回:

如果启用了不确定模式，则返回 true； 否则返回 false。

Since:

3

setInfiniteModeElement

public void setInfiniteModeElement(Element element)

设置用于绘制不确定进度条的元素对象。

元素对象围绕其中心重复顺时针旋转。

参数：

Since:

4

setMaxWidth

public void setMaxWidth(int maxWidth)

设置进度条的最大宽度。

如果父布局提供的宽度大于最大宽度，则使用最大宽度进行绘制。

参数：

Since:

1

setMaxHeight

public void setMaxHeight(int maxHeight)

设置进度条的最大高度。

如果父布局提供的高度大于最大高度，则使用最大高度绘制进度条。

参数：

Since:

1

getInfiniteModeElement

public Element getInfiniteModeElement()

获取用于绘制不确定进度条的元素对象。

元素对象围绕其中心重复顺时针旋转。

返回:

返回元素对象。

Since:

4

getMin

public int getMin()

获取确定进度条的下限。

默认情况下，下限为 0。

返回:

返回确定进度条的下限，为 0 或正整数。

Since:

1

getMax

public int getMax()

获取确定进度条的上限。

默认情况下，上限为 100。

返回:

返回确定进度条的上限，为正整数。

Since:

1

getProgress

public int getProgress()

获取进度条的当前进度值。

该方法获取确定进度条的当前进度值。 默认情况下，初始值设置为下限。

返回:

返回进度值，它是一个整数。

Since:

1

getViceProgressValue

public int getViceProgressValue()

获取进度条的二级进度值。

返回:

返回进度条的二级进度值。

Since:

4

getStep

public int getStep()

获取进度条的进度步骤。

进度值只能是进度步长的倍数。 进度步默认设置为 1。

返回:

返回进度条的进度步长，为正整数。

Since:

1

isInfiniteMode

public boolean isInfiniteMode()

检查是否为进度条启用了不确定模式。

确定模式是指在进度条上显示一定的进度值来显示当前的进度。 不确定模式表示进度值不可用，并显示一个围绕其中心顺时针重复旋转的元素对象，以显示操作的进行状态。

返回:

如果为进度条启用了不确定模式，则返回 true； 否则返回 false。

Since:

4

getMaxWidth

public int getMaxWidth()

获取进度条的最大宽度。

此方法将进度条的最大宽度与父组件提供的最大宽度进行比较。 如果父组件提供的宽度超过最大宽度，进度条将使用其最大宽度绘制。

返回:

返回进度条的最大宽度。

Since:

1

getMaxHeight

public int getMaxHeight()

获取进度条的最大高度。

此方法将进度条的最大高度与父组件提供的高度进行比较。 如果父组件提供的高度超过最大高度，进度条将使用其最大高度绘制。

返回:

返回进度条的最大高度。

Since:

1

setProgressBackgroundElement

public void setProgressBackgroundElement(Element element)

将 Element 对象设置为进度条的背景。

参数：

Since:

2

setProgressElement

public void setProgressElement(Element element)

将 Element 对象设置为进度条。

参数：

Since:

2

setViceProgressElement

public void setViceProgressElement(Element element)

将 Element 对象设置为副进度条。

参数：

Since:

4

getBackgroundInstructElement

public Element getBackgroundInstructElement()

获取用作进度条背景的 Element 对象。

返回:

返回用作进度条背景的 Element 对象。

Since:

4

getProgressElement

public Element getProgressElement()

获取用作进度条的 Element 对象。

返回:

返回用作进度条的 Element 对象。

Since:

2

getViceProgressElement

public Element getViceProgressElement()

获取用作副进度条的 Element 对象。

返回:

返回用作副进度条的 Element 对象。

Since:

4

getProgressHintText

public String getProgressHintText()

获取进度条上的提示文本。

返回:

返回进度条上的提示文本。

Since:

2

setProgressHintText

public void setProgressHintText(String text)

设置进度条的提示文本。

参数：

Since:

2

setProgressHintTextSize

public void setProgressHintTextSize(int size)

设置此进度条上提示文本的大小。

参数：

Since:

4

getProgressHintTextSize

public int getProgressHintTextSize()

获取此进度条上提示文本的大小。

返回:

返回提示文本大小，以像素为单位。

Since:

4

setProgressHintTextColor

public void setProgressHintTextColor(Color color)

在进度条上设置提示文本颜色。

参数：

Since:

2

getProgressHintTextColor

public Color getProgressHintTextColor()

获取进度条上的提示文本颜色。

返回:

返回提示文本颜色。

Since:

2

setProgressHintTextAlignment

public void setProgressHintTextAlignment(int alignment)

在进度条上设置提示文本对齐模式。

参数：

Since:

2

getProgressHintTextAlignment

public int getProgressHintTextAlignment()

获取进度条上的提示文本对齐方式。

返回:

返回提示文本对齐模式。

Since:

2

enableDividerLines

public void enableDividerLines(boolean enable)

设置进度条的分隔符状态。

此方法启用或禁用进度条的分隔线。

参数：

Since:

3

isDividerLinesEnabled

public boolean isDividerLinesEnabled()

检查是否启用了分隔线。

返回:

如果启用了分隔线，则返回 true； 否则返回 false。

Since:

3

setDividerLinesNumber

public void setDividerLinesNumber(int number)

设置此进度条的分隔线数量。

参数：

Since:

3

getDividerLinesNumber

public int getDividerLinesNumber()

获取此进度条的分隔线数。

返回:

返回分频器的数量。

Since:

3

setDividerLineThickness

public void setDividerLineThickness(int thickness)

设置分隔线粗细。

参数：

Since:

3

getDividerLineThickness

public int getDividerLineThickness()

获取分隔线粗细。

返回:

返回分隔线粗细。

Since:

3

setDividerLineColor

public void setDividerLineColor(Color color)

设置分隔线颜色。

参数：

Since:

3

getDividerLineColor

public Color getDividerLineColor()

获取分隔线颜色。

返回:

返回分隔线颜色。

Since:

3

setProgressWidth

public void setProgressWidth(int progressWidth)

设置此进度条的最大宽度。

将使用其宽度绘制进度条。

参数：

Since:

3

getProgressWidth

public int getProgressWidth()

获取此进度条的最大宽度。

将使用其宽度绘制进度条。

返回:

返回最大宽度。

Since:

3

setProgressColor

public void setProgressColor(Color color)

设置此进度条的颜色。

参数：

Since:

3

getProgressColor

public Color getProgressColor()

获取此进度条的颜色。

返回:

返回颜色。

Since:

3

setProgressColors

public void setProgressColors(int[] colors)

设置此进度条的渐变效果的颜色。

参数：

Since:

3

getProgressColors

public int[] getProgressColors()

获取用于绘制此进度条的 ShapeElement 对象的填充颜色。

返回:

如果可用，则返回填充颜色数组； 如果使用纯色，则返回一个只有一个元素的数组。

Since:

3

addBarObserver

public void addBarObserver(ProgressBar.BarObserver observer)

添加一个 BarObserver 来监控这个进度条的变化。

在使用 BarObserver 之前，您必须实现 BarObserver#onBarChanged。

参数：

Since:

4

removeBarObserver

public void removeBarObserver(ProgressBar.BarObserver observer)

移除此进度条的 BarObserver。

参数：

Since:

4