Package io.guise.framework.platform.web

Class WebProgressDepictEvent

java.lang.Object

java.util.EventObject

com.globalmentor.event.AbstractEvent

io.guise.framework.event.AbstractGuiseEvent

io.guise.framework.platform.AbstractPlatformEvent

io.guise.framework.platform.AbstractDepictEvent

io.guise.framework.platform.web.AbstractWebDepictEvent

io.guise.framework.platform.web.WebProgressDepictEvent

All Implemented Interfaces:

com.globalmentor.event.Event, GuiseEvent, DepictEvent, PlatformEvent, PlatformMessage, WebDepictEvent, WebPlatformEvent, WebPlatformMessage, java.io.Serializable

public class WebProgressDepictEvent
extends AbstractWebDepictEvent

Indicates that some sort of progress has been made on the web platform.

Author:

Garret Wilson

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
WebProgressDepictEvent(DepictedObject depictedObject, java.lang.String task, com.globalmentor.model.TaskState taskState, long progress)	Depicted object constructor with an unknown goal.
WebProgressDepictEvent(DepictedObject depictedObject, java.lang.String task, com.globalmentor.model.TaskState taskState, long progress, long goal)	Depicted object and goal constructor.

Method Summary

Modifier and Type	Method	Description
long	getGoal()
long	getProgress()
java.lang.String	getTask()
com.globalmentor.model.TaskState	getTaskState()

Methods inherited from class io.guise.framework.platform.AbstractDepictEvent

getDepictedObject

Methods inherited from class io.guise.framework.event.AbstractGuiseEvent

getSession

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.guise.framework.platform.DepictEvent

getDepictedObject

Methods inherited from interface com.globalmentor.event.Event

getSource

Constructor Detail

WebProgressDepictEvent

public WebProgressDepictEvent(DepictedObject depictedObject,
                              java.lang.String task,
                              com.globalmentor.model.TaskState taskState,
                              long progress)

Depicted object constructor with an unknown goal.

Parameters:

depictedObject - The depicted object on which the event initially occurred.

task - The task being performed, or null if not indicated.

taskState - The state of the task.

progress - The amount of progress that has been made, or -1 if the progress is unknown.

Throws:

java.lang.NullPointerException - if the given depicted object and/or task state is null.

WebProgressDepictEvent

public WebProgressDepictEvent(DepictedObject depictedObject,
                              java.lang.String task,
                              com.globalmentor.model.TaskState taskState,
                              long progress,
                              long goal)

Depicted object and goal constructor.

Parameters:

depictedObject - The depicted object on which the event initially occurred.

task - The task being performed, or null if not indicated.

taskState - The state of the task.

progress - The amount of progress that has been made, or -1 if the progress is unknown.

goal - The total amount of progress that will have been made upon completion, or -1 if the goal is unknown.

Throws:

java.lang.NullPointerException - if the given depicted object and/or task state is null.

Method Detail

getTask

public java.lang.String getTask()

Returns:

The task being performed, or null if not indicated.

getTaskState

public com.globalmentor.model.TaskState getTaskState()

Returns:

The state of the task.

getProgress

public long getProgress()

Returns:

The amount of progress that has been made, or -1 if the progress is unknown.

getGoal

public long getGoal()

Returns:

The total amount of progress that will have been made upon completion, or -1 if the goal is unknown.