Package org.teamapps.ux.component.progress

Class ProgressDisplay

java.lang.Object

org.teamapps.ux.component.AbstractComponent

org.teamapps.ux.component.progress.ProgressDisplay

All Implemented Interfaces:

ClientObject, Component

public class ProgressDisplay
extends AbstractComponent

This component displays progress information.

It is typically used to visualize the progress of an ObservableProgress. However, it can also be used manually, without attaching a progress.

Field Summary

Fields

Modifier and Type	Field	Description
Event<java.lang.Void>	onCancelButtonClicked
Event<java.lang.Void>	onClicked

Fields inherited from class org.teamapps.ux.component.AbstractComponent

DELETED_ATTRIBUTE, onRendered

Constructor Summary

Constructors

Constructor	Description
ProgressDisplay()
ProgressDisplay(org.teamapps.icons.Icon icon, java.lang.String taskName)
ProgressDisplay(org.teamapps.icons.Icon icon, java.lang.String taskName, ObservableProgress progress)

Method Summary

Modifier and Type	Method	Description
org.teamapps.dto.UiProgressDisplay	createUiComponent()
org.teamapps.icons.Icon	getIcon()
ObservableProgress	getObservedProgress()
double	getProgress()
ProgressStatus	getStatus()
java.lang.String	getStatusMessage()
java.lang.String	getTaskName()
void	handleUiEvent(org.teamapps.dto.UiEvent event)
boolean	isCancelable()
void	setCancelable(boolean cancelable)
void	setIcon(org.teamapps.icons.Icon icon)
void	setObservedProgress(ObservableProgress observableProgress)
void	setProgress(double progress)
void	setStatus(ProgressStatus status)
void	setStatusMessage(java.lang.String statusMessage)
void	setTaskName(java.lang.String taskName)

Methods inherited from class org.teamapps.ux.component.AbstractComponent

createUiReference, getDebuggingId, getId, getParent, getSessionContext, isRendered, isVisible, mapAbstractUiComponentProperties, queueCommandIfRendered, render, reRenderIfRendered, setAttribute, setCssStyle, setDebuggingId, setParent, setVisible, toggleCssClass, toString, unrender

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.teamapps.ux.component.ClientObject

handleUiQuery

Methods inherited from interface org.teamapps.ux.component.Component

setAriaLabel, setAttribute, setCssStyle, setHtmlTitle, setMargin, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setShadow, toggleCssClass

Field Detail

onClicked

public final Event<java.lang.Void> onClicked

onCancelButtonClicked

public final Event<java.lang.Void> onCancelButtonClicked

Constructor Detail

ProgressDisplay

public ProgressDisplay()

ProgressDisplay

public ProgressDisplay(org.teamapps.icons.Icon icon,
                       java.lang.String taskName)

ProgressDisplay

public ProgressDisplay(org.teamapps.icons.Icon icon,
                       java.lang.String taskName,
                       ObservableProgress progress)

Method Detail

createUiComponent

public org.teamapps.dto.UiProgressDisplay createUiComponent()

Specified by:

createUiComponent in class AbstractComponent

handleUiEvent

public void handleUiEvent(org.teamapps.dto.UiEvent event)

setObservedProgress

public void setObservedProgress(ObservableProgress observableProgress)

getObservedProgress

public ObservableProgress getObservedProgress()

getIcon

public org.teamapps.icons.Icon getIcon()

setIcon

public void setIcon(org.teamapps.icons.Icon icon)

getTaskName

public java.lang.String getTaskName()

setTaskName

public void setTaskName(java.lang.String taskName)

getStatusMessage

public java.lang.String getStatusMessage()

setStatusMessage

public void setStatusMessage(java.lang.String statusMessage)

getProgress

public double getProgress()

setProgress

public void setProgress(double progress)

getStatus

public ProgressStatus getStatus()

setStatus

public void setStatus(ProgressStatus status)

isCancelable

public boolean isCancelable()

setCancelable

public void setCancelable(boolean cancelable)