Class Progress

java.lang.Object
org.patternfly.component.BaseComponent<HTMLElement, Progress>
org.patternfly.component.progress.Progress
All Implemented Interfaces:
ElementAttributeMethods<HTMLElement, Progress>, ElementClassListMethods<HTMLElement, Progress>, ElementConsumerMethods<HTMLElement, Progress>, ElementContainerMethods<HTMLElement, Progress>, ElementEventMethods<HTMLElement, Progress>, ElementIdMethods<HTMLElement, Progress>, ElementQueryMethods<HTMLElement>, HTMLElementAttributeMethods<HTMLElement, Progress>, HTMLElementDataMethods<HTMLElement, Progress>, HTMLElementStyleMethods<HTMLElement, Progress>, HTMLElementVisibilityMethods<HTMLElement, Progress>, IsElement<HTMLElement>, TypedBuilder<HTMLElement, Progress>, Component, HasValue<Integer>
public class Progress extends BaseComponent<HTMLElement, Progress> implements HasValue<Integer>
A progress bar informs users about the completion status of an ongoing process or task.
See Also:

  • Method Details

    • 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 HTMLElementAttributeMethods<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>