Package org.patternfly.component.progress

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>

public class Progress
extends BaseComponentFlat<HTMLElement,Progress>
implements HasValue<Integer>

A progress bar informs users about the completion status of an ongoing process or task.

See Also:

https://www.patternfly.org/components/progress

Method Summary

Modifier and Type	Method	Description
Progress	add(HelperText helperText)
Progress	addHelperText(HelperText helperText)
Progress	ariaLabel(String label)
Progress	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.
Progress	label(ProgressLabel label)
int	max()	Retrieves the maximum value of the progress component.
Progress	max(int max)
Progress	measureLocation(MeasureLocation location)
int	min()	Retrieves the minimum value of the progress component.
Progress	min(int min)
Progress	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.
Progress	range(int min, int max)
Progress	range(int min, int max, int step)
Progress	size(Size size)
Progress	status(Status status)
int	step()	Retrieves the current step value of the progress component.
Progress	step(int step)
Progress	that()
Progress	title(String title)
Progress	truncate()
Integer	value()
Progress	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

Methods inherited from interface org.jboss.elemento.Finder

closest, find, findAll

Methods inherited from interface org.jboss.elemento.HasElement

add, apply, aria, aria, aria, attr, attr, attr, classList, classList, css, id, id, innerHtml, on, run, textContent, textNode, toggle, toggle, toggle, uniqueId

Methods inherited from interface org.jboss.elemento.HasHTMLElement

data, hidden, style, style, style, style, style, style

Method Detail

progress

public static Progress progress()

addHelperText

public Progress addHelperText(HelperText helperText)

add

public Progress add(HelperText helperText)

min

public Progress min(int min)

max

public Progress max(int max)

step

public Progress step(int step)

range

public Progress range(int min,
                      int max)

range

public Progress range(int min,
                      int max,
                      int step)

label

public Progress label(ProgressLabel label)

measureLocation

public Progress measureLocation(MeasureLocation location)

size

public Progress size(Size size)

status

public Progress status(Status status)

title

public Progress title(String title)

Specified by:

title in interface HasHTMLElement<HTMLElement,Progress>

truncate

public Progress truncate()

value

public Progress value(int value)

that

public Progress that()

Specified by:

that in interface TypedBuilder<HTMLElement,Progress>

ariaLabel

public Progress ariaLabel(String label)

ariaLabeledBy

public Progress ariaLabeledBy(String labeledBy)

onChange

public Progress onChange(ChangeHandler<Progress,Integer> changeHandler)

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

public Integer value()

Specified by:

value in interface HasValue<Integer>