Package org.dwcj.controls.progressbar

Class ProgressBar

java.lang.Object
org.dwcj.controls.AbstractControl
org.dwcj.controls.AbstractDwcControl
org.dwcj.controls.progressbar.ProgressBar
All Implemented Interfaces:
Control, Enableable, HasAttribute, HasClassName, HasComputedStyle, HasControlText, HasDestroy, HasStyle, HasTooltip, HasVisibility
public final class ProgressBar extends AbstractDwcControl

  • Constructor Details

    • ProgressBar

      public ProgressBar()

  • Method Details

    • create

      protected void create(AbstractDwcjPanel p)
      Description copied from class: AbstractControl
      Create the object on a panel p. The preferred way of creating an object is using the Panel::add(Control) method, instead of this
      Overrides:
      create in class AbstractControl
      Parameters:
      p - the panel to add this control on

    • getMaximum

      public Integer getMaximum()
      This method returns the maximum range of theProgressBar control.
      Returns:
      Returns the maximum range of the progress bar.

    • getMinimum

      public Integer getMinimum()
      This method returns the minimum range of theProgressBar control.
      Returns:
      Returns the minimum range of the progress bar.

    • getOrientation

      public Integer getOrientation()
      This method returns the orientation of the ProgressBar control.
      Returns:
      Returns 0 if horizontal, 1 if vertical.

    • getText

      public String getText()
      This method returns the text of aProgressBar control.
      Specified by:
      getText in interface HasControlText
      Overrides:
      getText in class AbstractDwcControl
      Returns:
      Returns the text (label) of the progress bar control.

    • getValue

      public Integer getValue()
      This method returns the current value of a ProgressBar control.
      Returns:
      Returns the current value of the progress bar control.

    • isIndeterminate

      public Boolean isIndeterminate()
      This method returns whether the ProgressBar control.
      Returns:
      Returns whether the progress bar is indeterminate (false = specific range, true = indeterminate).

    • isStringPainted

      public Boolean isStringPainted()
      This method returns whether the ProgressBar control will display a label (defaults to % complete).
      Returns:
      Returns whether the progress bar will show a label (false = no label, true = label will be displayed).

    • setIndeterminate

      public ProgressBar setIndeterminate(Boolean indeterminate)
      This method sets whether the ProgressBar control is indeterminate. This option is not available on all platforms.
      Parameters:
      indeterminate - - Sets whether the progress bar is indeterminate (false = Progress bar has a fixed range, which can be retrieved with getMinimum() and getMaximum(), true = Progress bar is indeterminate, indicating that the duration of the task is not yet known.)
      Returns:
      Returns this

    • setMaximum

      public ProgressBar setMaximum(Integer maximum)
      This method sets the maximum range for the ProgressBar control.
      Parameters:
      maximum - - Specifies the maximum range of the BBjProgressBar control.
      Returns:
      Returns this

    • setMinimum

      public ProgressBar setMinimum(Integer minimum)
      This method sets the minimum range for the ProgressBar control.
      Parameters:
      minimum - - Specifies the minimum range of the BBjProgressBar control.
      Returns:
      Returns this

    • setOrientation

      public ProgressBar setOrientation(Integer orientation)
      This method sets the orientation of the ProgressBar control to HORIZONTAL or VERTICAL.
      Parameters:
      orientation - - Specifies the orientation as HORIZONTAL or VERTICAL.
      Returns:
      Returns this

    • setStringPainted

      public ProgressBar setStringPainted(Boolean stringPainted)
      This method determines whether the ProgressBar control will show a label.
      Parameters:
      stringPainted - - Specifies whether the progress bar should display a label (false = Not painted, 1 = Painted)
      Returns:
      Returns this

    • setProgressBarText

      public ProgressBar setProgressBarText(String text)
      This method sets the text (label) of a ProgressBar control.
      Parameters:
      text - - Specifies the text to be displayed on the BBjProgressBar. If text is set to "", the progress bar will display percentage complete in the format "XX%".
      Returns:
      Returns this

    • setValue

      public ProgressBar setValue(Integer value)
      This method sets the value of a ProgressBar control.
      Parameters:
      value - - Specifies the value of the control.
      Returns:
      Returns this

    • setText

      public ProgressBar setText(String text)
      Description copied from interface: HasControlText
      set the text of the control Each control implementing this interface has a text property, which might be visible in different ways (caption, title, contents of edit) or sometimes not visible at all
      Specified by:
      setText in interface HasControlText
      Overrides:
      setText in class AbstractDwcControl
      Returns:
      the control itself

    • setVisible

      public ProgressBar setVisible(Boolean visible)
      Description copied from interface: HasVisibility
      Set whether the control is visible or invisible
      Specified by:
      setVisible in interface HasVisibility
      Overrides:
      setVisible in class AbstractDwcControl
      Returns:
      the control itself

    • setEnabled

      public ProgressBar setEnabled(Boolean enabled)
      Description copied from interface: Enableable
      Set whether the control is to be enabled
      Specified by:
      setEnabled in interface Enableable
      Overrides:
      setEnabled in class AbstractDwcControl
      Returns:
      the control itself

    • setTooltipText

      public ProgressBar setTooltipText(String text)
      Description copied from interface: HasTooltip
      Set the tooltip text of the control
      Specified by:
      setTooltipText in interface HasTooltip
      Overrides:
      setTooltipText in class AbstractDwcControl
      Returns:
      the control itself

    • setAttribute

      public ProgressBar setAttribute(String attribute, String value)
      Description copied from class: AbstractDwcControl
      set the value for an attribute in the control
      Specified by:
      setAttribute in interface HasAttribute
      Overrides:
      setAttribute in class AbstractDwcControl
      Parameters:
      attribute - the name of the attribute
      value - the value to be set
      Returns:
      the control itself

    • setId

      public ProgressBar setId(String elementId)
      Description copied from interface: Control
      Assigns the ID of a control
      Specified by:
      setId in interface Control
      Overrides:
      setId in class AbstractControl
      Parameters:
      elementId - Desired ID designation
      Returns:
      The control itself

    • setStyle

      public ProgressBar setStyle(String property, String value)
      Description copied from interface: HasStyle
      Assigns specified value to the specified CSS property
      Specified by:
      setStyle in interface HasStyle
      Overrides:
      setStyle in class AbstractDwcControl
      Parameters:
      property - The CSS property to be changed
      value - The value of the selected CSS property
      Returns:
      The control itself

    • addClassName

      public ProgressBar addClassName(String selector)
      Description copied from interface: HasClassName
      Adds a CSS class to the list of CSS classes for the control.
      Specified by:
      addClassName in interface HasClassName
      Overrides:
      addClassName in class AbstractDwcControl
      Returns:
      The control itself

    • removeClassName

      public ProgressBar removeClassName(String selector)
      Description copied from interface: HasClassName
      Removes a CSS class from the list of CSS classes for the control.
      Specified by:
      removeClassName in interface HasClassName
      Overrides:
      removeClassName in class AbstractDwcControl
      Returns:
      The control itself

    • catchUp

      protected void catchUp() throws IllegalAccessException
      Description copied from class: AbstractDwcControl
      The catchUp method is used to replay attributes and settings that the API user might have added to a control before its creation. A control is not created before it's added to a panel. Anything that is added between instantiation of a control and its addition to a panel has to be recorded and replayed in this method
      Overrides:
      catchUp in class AbstractDwcControl
      Throws:
      IllegalAccessException - - thrown if an attempt is made to call this method more than once