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, 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:

Serialized Form

Field Summary

Fields inherited from class org.kuali.rice.krad.uif.component.ComponentBase

templateOptions

Fields inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase

componentCode, namespaceCode

Fields inherited from interface org.kuali.rice.krad.uif.component.Ordered

INITIAL_ORDER_VALUE

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
StepProgressBar()

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getAccessibilityText() The list of additional screen reader only accessibility text to render per step, in order; framework only, not settable.
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".
String	getCurrentStep() The current step (by key) of this progress bar to be highlighted visually as the active step.
Collection<String>	getStepCollection() The list of step values; framework only, not settable.
List<String>	getStepLabelClasses() The list of step label css classes in order of steps shown; framework only, not settable
Map<String,String>	getSteps() The steps as key-value pairs for this StepProgressBar, where value is human-readable text.
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.
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.
void	performFinalize(Object model, LifecycleElement parent) Populates the stepLabelClasses, accessibilityText, segmentSizes, and segmentClasses lists based on the settings of this StepProgressBar.
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.
void	setCompleteStep(String completeStep)
void	setCurrentStep(String currentStep)
void	setSteps(Map<String,String> steps)
void	setVerticalHeight(Integer verticalHeight)
void	setVerticalStepHeight(Integer verticalStepHeight)

Methods inherited from class org.kuali.rice.krad.uif.element.ProgressBar

getPercentComplete, getSegmentClasses, getSegmentPercentages, getSegmentSizes, isVertical, setPercentComplete, setSegmentClasses, setSegmentPercentages, setVertical

Methods inherited from class org.kuali.rice.krad.uif.element.ContentElementBase

afterEvaluateExpression, getComponentTypeName

Methods inherited from class org.kuali.rice.krad.uif.component.ComponentBase

addAriaAttribute, addDataAttribute, addScriptDataAttribute, addStyleClass, addWrapperCssClass, appendToStyle, checkMutable, clone, completeValidation, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAdditionalTemplates, getAlign, getAriaAttributes, getAriaAttributesAsString, getCanCopyOnReadOnly, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContainerIdSuffix, getContext, getCssClasses, getCssGridSizes, getDataAttributes, getEventHandlerScript, getExcludeIf, getExcludeUnless, getFieldsToSendOnRefresh, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getLibraryCssClasses, getMethodToCallOnRefresh, getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnInputScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getOrder, getPhasePathMapping, getPostRenderContent, getPreRenderContent, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getReadOnly, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRole, getRowSpan, getScriptDataAttributes, getScriptDataAttributesJs, getSimpleDataAttributes, getStyle, getStyleClassesAsString, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getViewPath, getViewStatus, getWidth, getWrapperCssClasses, getWrapperCssClassesAsString, getWrapperStyle, initializeComponentSecurity, isDisableSessionPersistence, isDisclosedByAction, isEditAuthz, isFinal, isForceSessionPersistence, isHidden, isInitialized, isModelApplied, isMutable, isOmitFromFormPost, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isRefreshedByAction, isRender, isRendered, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, isSkipInTabOrder, isViewAuthz, notifyCompleted, performApplyModel, performInitialization, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setAriaAttributes, setCanCopyOnReadOnly, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContainerIdSuffix, setContext, setCssClasses, setCssGridSizes, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setEditAuthz, setExcludeIf, setExcludeUnless, setFieldsToSendOnRefresh, setFinalizeMethodAdditionalArguments, setFinalizeMethodInvoker, setFinalizeMethodToCall, setForceSessionPersistence, setHidden, setId, setLibraryCssClasses, setMethodToCallOnRefresh, setOmitFromFormPost, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnInputScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript, setOrder, setPhasePathMapping, setPostRenderContent, setPreRenderContent, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRetrieveViaAjax, setRole, setRowSpan, setScriptDataAttributes, setSelfRendered, setSkipInTabOrder, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setViewAuthz, setViewPath, setViewStatus, setWidth, setWrapperCssClasses, setWrapperStyle, skipLifecycle

Methods inherited from class org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase

getExpressionGraph, getPropertyExpression, getPropertyExpressions, setExpressionGraph, setPropertyExpressions

Methods inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase

copy, dataDictionaryPostProcessing, getComponentCode, getNamespaceCode, setComponentCode, setNamespaceCode

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.kuali.rice.krad.uif.component.Component

addAriaAttribute, addDataAttribute, addScriptDataAttribute, addStyleClass, addWrapperCssClass, appendToStyle, completeValidation, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAdditionalTemplates, getAlign, getAriaAttributes, getAriaAttributesAsString, getCanCopyOnReadOnly, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getCssGridSizes, getDataAttributes, getEventHandlerScript, getExcludeIf, getExcludeUnless, getFieldsToSendOnRefresh, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getLibraryCssClasses, getMethodToCallOnRefresh, getOrder, getPostRenderContent, getPreRenderContent, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getReadOnly, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRole, getRowSpan, getScriptDataAttributes, getScriptDataAttributesJs, getSimpleDataAttributes, getStyle, getStyleClassesAsString, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getWidth, getWrapperCssClasses, getWrapperStyle, isDisableSessionPersistence, isDisclosedByAction, isForceSessionPersistence, isHidden, isOmitFromFormPost, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isRefreshedByAction, isRendered, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setAriaAttributes, setCanCopyOnReadOnly, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setCssGridSizes, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setFieldsToSendOnRefresh, setForceSessionPersistence, setHidden, setLibraryCssClasses, setOmitFromFormPost, setOrder, setPostRenderContent, setPreRenderContent, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRetrieveViaAjax, setRole, setRowSpan, setScriptDataAttributes, setSelfRendered, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setViewStatus, setWidth, setWrapperCssClasses, setWrapperStyle

Methods inherited from interface org.kuali.rice.krad.datadictionary.uif.UifDictionaryBean

getExpressionGraph, getPropertyExpression, getPropertyExpressions, setExpressionGraph, setPropertyExpressions

Methods inherited from interface org.kuali.rice.krad.datadictionary.DictionaryBean

dataDictionaryPostProcessing, getComponentCode, getNamespaceCode

Methods inherited from interface org.kuali.rice.krad.uif.util.LifecycleElement

checkMutable, getContainerIdSuffix, getId, getPhasePathMapping, getViewPath, getViewStatus, isFinal, isInitialized, isModelApplied, isMutable, isRender, notifyCompleted, performApplyModel, performInitialization, pushAllToContext, pushObjectToContext, setContainerIdSuffix, setId, setPhasePathMapping, setRender, setViewPath, skipLifecycle

Methods inherited from interface org.kuali.rice.krad.datadictionary.Copyable

clone

Methods inherited from interface org.kuali.rice.krad.uif.component.ScriptEventSupport

getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnInputScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnInputScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript

Constructor Detail

StepProgressBar

public StepProgressBar()

Method Detail

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:

getSteps()

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:

getCurrentStep()

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:

getCompleteStep()

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:

getVerticalHeight()

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:

getVerticalStepHeight()