Package com.broadleafcommerce.metadata.dsl.core.extension.columns

Interface ProgressColumn<C extends ProgressColumn<C>>

All Superinterfaces:

Column<C>, Comparable<C>, Component<C>, Copyable<C>, Serializable

All Known Implementing Classes:

DefaultProgressColumn

public interface ProgressColumn<C extends ProgressColumn<C>>
extends Column<C>

The column type that is used to render the progress in percentage. Example:

 Columns.progress().name("completeCount").totalKey("totalItems")
 

completeCount - is the "done" amount

totalItems - is the "total" amount. The percentage is calculated as "done / total * 100". By default this column uses the rc-progress component to render the line progress. You can specify the properties of this component using the attributes, e.g. .attribute("strokeColor", "#509922").

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ProgressColumn.Attributes

Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.Column

Column.ColumnAttributes

Method Summary

Modifier and Type	Method	Description
default C	strokeColor(String strokeColor)	The color of the progress line.
default C	strokeLinecap(String strokeLinecap)	The shape to be used at the end of the progress bar, can be `butt`, `square` or `round`.
default C	strokeWidth(Integer strokeWidth)	Width of the stroke.
default C	totalKey(String totalKey)	The entity property name that represents the total items to process.
default C	trailWidth(Integer trailWidth)	Width of the trail stroke.

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Column

align, alignCenter, alignLeft, alignRight, colSpan, colSpan, filterAndSortAlias, getAlign, getColSpan, getName, getWidth, isSortable, name, notSortable, setAlign, setColSpan, setName, setSortable, setWidth, sortable, sortable, width

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Component

addAction, addAction, addComponent, addEndpoint, addEndpoint, apply, attribute, augmentationKey, classifier, clearConditionals, clearEndpoints, conditional, conditionals, description, description, findAction, findAction, findActions, findAttribute, findComponent, findComponent, findComponents, findEndpoint, findEndpoint, findEndpoints, get, get, getAction, getAction, getActions, getActionsList, getAttribute, getAttribute, getAttributes, getAugmentationKey, getClassifier, getComponent, getComponent, getComponents, getComponentsList, getConditionals, getDescription, getEndpoint, getEndpoint, getEndpoints, getEndpointsList, getId, getLabel, getOrder, getScope, getType, hasAction, hasAttribute, hasComponent, hasEndpoint, id, isAugmentable, isTranslatable, label, label, notTranslatable, order, removeAction, removeAttribute, removeComponent, removeEndpoint, scope, self, setActions, setAttributes, setAugmentationKey, setClassifier, setComponents, setConditionals, setDescription, setEndpoints, setId, setLabel, setOrder, setScope, setTranslatable, setType, translatable, translatable, type

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Copyable

copy

Method Detail

strokeColor

default C strokeColor(String strokeColor)

The color of the progress line. It accepts the hexadecimal colors. Defaults to "#509922".

Parameters:

strokeColor - the hexadecimal color

Returns:

this column for further customization

strokeLinecap

default C strokeLinecap(String strokeLinecap)

The shape to be used at the end of the progress bar, can be `butt`, `square` or `round`. Defaults to "square".

Parameters:

strokeLinecap - the shape to be used at the end of the progress bar

Returns:

this column for further customization

strokeWidth

default C strokeWidth(Integer strokeWidth)

Width of the stroke. Unit is percentage of SVG canvas size. Defaults to "6".

Parameters:

strokeWidth - the width of the stroke

Returns:

this column for further customization

trailWidth

default C trailWidth(Integer trailWidth)

Width of the trail stroke. Unit is percentage of SVG canvas size. Trail is always centered relative to actual progress path. If trailWidth are not defined, it same as strokeWidth.

Parameters:

trailWidth - the width of the trail stroke

Returns:

this column for further customization

totalKey

default C totalKey(String totalKey)

The entity property name that represents the total items to process. Defaults to "total".

Parameters:

totalKey - the entity property name

Returns:

this column for further customization