Package org.kuali.rice.krad.uif.element

Class ProgressBar

java.lang.Object
org.kuali.rice.krad.datadictionary.DictionaryBeanBase
org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase
org.kuali.rice.krad.uif.component.ComponentBase
org.kuali.rice.krad.uif.element.ContentElementBase
org.kuali.rice.krad.uif.element.ProgressBar
All Implemented Interfaces:
Serializable, Cloneable, Copyable, DictionaryBean, UifDictionaryBean, Component, Ordered, ScriptEventSupport, ContentElement, LifecycleElement, org.springframework.core.Ordered
Direct Known Subclasses:
StepProgressBar
public class ProgressBar extends ContentElementBase
Element which shows a visual progress bar based on percentageValue passed in or segmentPercentages passed in
Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Constructor Details

    • ProgressBar

      public ProgressBar()

  • Method Details

    • performFinalize

      public void performFinalize(Object model, LifecycleElement parent)
      Sets the appropriate classes and bar widths based on values in percentComplete or segmentPercentages The following finalization is done here:
      • progressiveRender and conditionalRefresh variables are processed if set
      • If any of the style properties were given, sets the style string on the style property
      • Set the skipInTabOrder flag for nested components
      The last phase before the view is rendered

      Here final preparations can be made based on the updated view state.

      Specified by:
      performFinalize in interface LifecycleElement
      Overrides:
      performFinalize in class ComponentBase
      Parameters:
      model - - top level object containing the data
      parent - - parent component

    • getPercentComplete

      public Integer getPercentComplete()
      Percent value complete used to visually indicate this ProgressBar's completeness
      Returns:
      the Integer value representing perecent complete for this ProgressBar

    • setPercentComplete

      public void setPercentComplete(Integer percentComplete)
      See Also:

    • getSegmentClasses

      public List<String> getSegmentClasses()
      List of bar classes to use for each bar "section" for coloring or styling purposes, only settable for full configuration purposes and should not normally be set

      These are normally set automatically by the framework, but can be explicitly defined if segmentPercentages are also explicitly set. When setting segmentClasses, it's list size MUST equal segmentPercentages.

      Returns:
      the list of bar classes

    • setSegmentClasses

      public void setSegmentClasses(List<String> segmentClasses)
      See Also:

    • getSegmentPercentages

      public List<Integer> getSegmentPercentages()
      The percentage each bar "section" will take up on the progress bar, only settable for full configuration purposes and should not normally be set

      This is normally automatically set by the framework with no additional configuration. When explicitly set for ProgressBars, barClases should ALSO be set (this however is optional for StepProgressBars). The percentages effects how much space each section will take up on the bar and the total should not exceed 100. For StepProgressBars, this list's size must equal the number of steps.

      Returns:
      the bar percentages to use

    • setSegmentPercentages

      public void setSegmentPercentages(List<String> segmentPercentages)
      See Also:

    • getSegmentSizes

      public List<String> getSegmentSizes()
      The bar sizes as String css style properties (ie, "width: 20%") in a list, framework only, not settable.
      Returns:
      the bar sizes as String css style properties

    • isVertical

      public boolean isVertical()
      True if this ProgressBar should render vertical (this requires a defined height - which by default is defined in the css, or by the framework for StepProgressBars), false otherwise
      Returns:
      true if this

    • setVertical

      public void setVertical(boolean vertical)
      See Also: