Package com.adobe.cq.wcm.core.components.models

Interface ProgressBar

All Superinterfaces:

Component, ComponentExporter

@ConsumerType
public interface ProgressBar
extends Component

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PN_COMPLETED	Name of property that defines the completion percentage.

Fields inherited from interface com.adobe.cq.wcm.core.components.models.Component

PN_ID

Method Summary

Modifier and Type	Method	Description
default float	getCompleted()	Get the completed percentage
default @NotNull java.lang.String	getExportedType()	Returns the type of the resource for which the export is performed.
default float	getRemaining()	Get the remaining percentage

Methods inherited from interface com.adobe.cq.wcm.core.components.models.Component

getData, getId

Field Detail

PN_COMPLETED

static final java.lang.String PN_COMPLETED

Name of property that defines the completion percentage. The property should provide a numeric value between 0 and 100.

Since:

com.adobe.cq.wcm.core.components.models 12.12.0

See Also:

Constant Field Values

Method Detail

getCompleted

default float getCompleted()

Get the completed percentage

Returns:

Completed percentage as a number between 0 and 100

Since:

com.adobe.cq.wcm.core.components.models 12.12.0

getRemaining

default float getRemaining()

Get the remaining percentage

Returns:

Remaining percentage as a number between 0 and 100

Since:

com.adobe.cq.wcm.core.components.models 12.12.0

getExportedType

@NotNull
default @NotNull java.lang.String getExportedType()

Description copied from interface: ComponentExporter

Returns the type of the resource for which the export is performed.

NOTE: methods whose JSON serialization would lead to the same JSON property name (":type") will not be serialized.

Specified by:

getExportedType in interface Component

Specified by:

getExportedType in interface ComponentExporter

Returns:

the type of the component

Since:

com.adobe.cq.wcm.core.components.models 12.12.0

See Also:

ComponentExporter.getExportedType()