com.hybris.cockpitng.engine.operations

Class LongOperationNotifier

java.lang.Object

com.hybris.cockpitng.engine.operations.LongOperationNotifier

public class LongOperationNotifier
extends Object

Long operation notifier.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	HUNDRED
protected static String	PERCENT
protected static int	PROGRESS_TIMER_DELAY
protected static String	SCLASS_PROGRESS_CANCEL
protected static String	SCLASS_PROGRESS_METER_CONTAINER
protected static String	SCLASS_PROGRESS_TITLE
protected static String	SCLASS_PROGRESS_VALUE_LABEL

Constructor Summary

Constructors

Constructor and Description
LongOperationNotifier(Operation operation)

Method Summary

Modifier and Type	Method and Description
Progress	getProgress()
void	removeNotification() Hides long operation notification by detaching renderComponent passed in showNotification(Component)
void	showNotification(org.zkoss.zk.ui.Component renderComponent) Shows long operation notification.
void	showNotification(org.zkoss.zk.ui.Component renderComponent, Cancellable cancellable) Shows long operation notification.

Methods inherited from class java.lang.Object

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

Field Detail

SCLASS_PROGRESS_VALUE_LABEL

protected static final String SCLASS_PROGRESS_VALUE_LABEL

See Also:

Constant Field Values

SCLASS_PROGRESS_METER_CONTAINER

protected static final String SCLASS_PROGRESS_METER_CONTAINER

See Also:

Constant Field Values

SCLASS_PROGRESS_CANCEL

protected static final String SCLASS_PROGRESS_CANCEL

See Also:

Constant Field Values

SCLASS_PROGRESS_TITLE

protected static final String SCLASS_PROGRESS_TITLE

See Also:

Constant Field Values

HUNDRED

protected static final int HUNDRED

See Also:

Constant Field Values

PROGRESS_TIMER_DELAY

protected static final int PROGRESS_TIMER_DELAY

See Also:

Constant Field Values

PERCENT

protected static final String PERCENT

See Also:

Constant Field Values

Constructor Detail

LongOperationNotifier

public LongOperationNotifier(Operation operation)

Parameters:

operation - holds long operation information which is used to display notification Operation.isTerminable(),Operation.getProgressType(), Operation.getLabel()

Method Detail

removeNotification

public void removeNotification()

Hides long operation notification by detaching renderComponent passed in showNotification(Component)

getProgress

public Progress getProgress()

showNotification

public void showNotification(org.zkoss.zk.ui.Component renderComponent)

Shows long operation notification.

Parameters:

renderComponent - component on which notification will be rendered. The component will be detached from parent when the notification is removed.

showNotification

public void showNotification(org.zkoss.zk.ui.Component renderComponent,
                             Cancellable cancellable)

Shows long operation notification.

Parameters:

renderComponent - component on which notification will be rendered. The component will be detached from parent when the notification is removed.

cancellable - on cancel request from ui Cancellable.cancel() will be called.