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

Class StepProgressBar

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
org.kuali.rice.krad.uif.element.StepProgressBar
All Implemented Interfaces:
Serializable, Cloneable, Copyable, DictionaryBean, UifDictionaryBean, Component, Ordered, ScriptEventSupport, ContentElement, LifecycleElement, org.springframework.core.Ordered
public class StepProgressBar extends ProgressBar
Element which shows a visual progress bar alongside a set of steps, to be used by wizard or multi-step processes, which reflects the current progress based on value of currentStep.
Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Constructor Details

    • StepProgressBar

      public StepProgressBar()

  • Method Details

    • performFinalize

      public void performFinalize(Object model, LifecycleElement parent)
      Populates the stepLabelClasses, accessibilityText, segmentSizes, and segmentClasses lists based on the settings of this StepProgressBar. 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 ProgressBar
      Parameters:
      model - - top level object containing the data
      parent - - parent component

    • populateProgressBarRenderingLists

      public void populateProgressBarRenderingLists(int totalSteps, String cssDimension, boolean explicitlySetPercentages, boolean explicitlySetClasses)
      Populate the information used by the template based on settings of this StepProgressBar by iterating of the steps and setting classes and other rendering info in list to be used by the template.
      Parameters:
      totalSteps - the total steps in this StepProgressBar
      cssDimension - the css dimension property to use for bar sizes
      explicitlySetPercentages - true if bar percentages were manually set
      explicitlySetClasses - true if bar classes wer manually set

    • getSteps

      public Map<String,String> getSteps()
      The steps as key-value pairs for this StepProgressBar, where value is human-readable text.
      Returns:
      the map of steps for this StepProgressBar

    • setSteps

      public void setSteps(Map<String,String> steps)
      See Also:

    • getStepCollection

      public Collection<String> getStepCollection()
      The list of step values; framework only, not settable.
      Returns:
      the list of step values

    • getStepLabelClasses

      public List<String> getStepLabelClasses()
      The list of step label css classes in order of steps shown; framework only, not settable
      Returns:
      the list of step label css classes

    • getAccessibilityText

      public List<String> getAccessibilityText()
      The list of additional screen reader only accessibility text to render per step, in order; framework only, not settable.
      Returns:
      the list of additional screen reader only accessibility text

    • getCurrentStep

      public String getCurrentStep()
      The current step (by key) of this progress bar to be highlighted visually as the active step.
      Returns:
      the current step (by key)

    • setCurrentStep

      public void setCurrentStep(String currentStep)
      See Also:

    • getCompleteStep

      public String getCompleteStep()
      The key that when currentStep has this value, shows the step progress bar as fully complete; this key is must not be part of the steps being shown, by default this has a value of "SUCCESS".
      Returns:
      the completeStep key for showing this bar as fully complete

    • setCompleteStep

      public void setCompleteStep(String completeStep)
      See Also:

    • getVerticalHeight

      public Integer getVerticalHeight()
      The height (in pixels) of the progress bar portion of this component, if this is not set, verticalStepHeight is used to calculate this value; only used when vertical property is true.
      Returns:
      the verticalHeight of the progress bar

    • setVerticalHeight

      public void setVerticalHeight(Integer verticalHeight)
      See Also:

    • getVerticalStepHeight

      public Integer getVerticalStepHeight()
      The height (in pixels) allocated for each step for vertical step display used to calculate verticalHeight if not set, by default this is 75.
      Returns:
      the vertical step height used to calculate verticalHeight

    • setVerticalStepHeight

      public void setVerticalStepHeight(Integer verticalStepHeight)
      See Also: