Class Progress
java.lang.Object
org.patternfly.component.BaseComponentFlat<HTMLElement,Progress>
org.patternfly.component.progress.Progress
- All Implemented Interfaces:
Finder<HTMLElement>
,HasElement<HTMLElement,
,Progress> HasHTMLElement<HTMLElement,
,Progress> IsElement<HTMLElement>
,TypedBuilder<HTMLElement,
,Progress> Component
,HasValue<Integer>
A progress bar informs users about the completion status of an ongoing process or task.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionadd
(HelperText helperText) addHelperText
(HelperText helperText) ariaLabeledBy
(String labeledBy) void
decrease()
Decreases the value of the progress component by the step value.void
increase()
Increases the value of the progress component by the step value.label
(ProgressLabel label) int
max()
Retrieves the maximum value of the progress component.max
(int max) measureLocation
(MeasureLocation location) int
min()
Retrieves the minimum value of the progress component.min
(int min) onChange
(ChangeHandler<Progress, Integer> changeHandler) Sets the change handler for the progress component.static Progress
progress()
int[]
range()
Retrieves the range of values for the progress component.range
(int min, int max) range
(int min, int max, int step) int
step()
Retrieves the current step value of the progress component.step
(int step) that()
truncate()
value()
value
(int value) Methods inherited from class org.patternfly.component.BaseComponentFlat
componentType, element
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Method Details
-
progress
-
addHelperText
-
add
-
min
-
max
-
step
-
range
-
range
-
label
-
measureLocation
-
size
-
status
-
title
- Specified by:
title
in interfaceHasHTMLElement<HTMLElement,
Progress>
-
truncate
-
value
-
that
- Specified by:
that
in interfaceTypedBuilder<HTMLElement,
Progress>
-
ariaLabel
-
ariaLabeledBy
-
onChange
Sets the change handler for the progress component.- Parameters:
changeHandler
- The change handler to be set.- Returns:
- The progress component.
-
decrease
public void decrease()Decreases the value of the progress component by the step value. If the new value is less than the minimum value, the minimum value is used instead. -
increase
public void increase()Increases the value of the progress component by the step value. If the new value is greater than the maximum value, the maximum value is used instead. -
min
public int min()Retrieves the minimum value of the progress component.- Returns:
- The minimum value of the progress component.
-
max
public int max()Retrieves the maximum value of the progress component.- Returns:
- The maximum value of the progress component.
-
step
public int step()Retrieves the current step value of the progress component.- Returns:
- The current step value of the progress component.
-
range
public int[] range()Retrieves the range of values for the progress component.- Returns:
- An array containing the minimum, maximum, and step values of the Progress component.
-
value
-