| Package | org.ffilmation.engine.events |
| Class | public class fProcessEvent |
| Inheritance | fProcessEvent  flash.events.Event |
The fProcessEvent event class stores information about a process event.
Several processes in the filmation engine involve more than one subprocess, and this class stores info about the overall task that is being monitored as well as the status of the current subtask.
This allows to have progress bars that go something like:
Loading media file A. 20% done| Property | Defined by | ||
|---|---|---|---|
| complete : Boolean
A boolean value indicating if the overall process is considered done ( same as checking overall = 100 )
| fProcessEvent | ||
| current : Number
Current process completion status, from 0 to 100
| fProcessEvent | ||
| currentDescription : String
Current process description
| fProcessEvent | ||
| overall : Number
Overall process completion status, from 0 to 100
| fProcessEvent | ||
| overallDescription : String
Overall process description
| fProcessEvent | ||
| Method | Defined by | ||
|---|---|---|---|
|
fProcessEvent(type:String, bubbles:Boolean, cancelable:Boolean, overall:Number, overallDescription:String, current:Number, currentDescription:String)
Constructor for the fProcessEvent class.
| fProcessEvent | ||
| complete | property |
public var complete:BooleanA boolean value indicating if the overall process is considered done ( same as checking overall = 100 )
| current | property |
public var current:NumberCurrent process completion status, from 0 to 100
| currentDescription | property |
public var currentDescription:StringCurrent process description
| overall | property |
public var overall:NumberOverall process completion status, from 0 to 100
| overallDescription | property |
public var overallDescription:StringOverall process description
| fProcessEvent | () | constructor |
public function fProcessEvent(type:String, bubbles:Boolean, cancelable:Boolean, overall:Number, overallDescription:String, current:Number, currentDescription:String)Constructor for the fProcessEvent class.
Parameterstype:String — The type of the event. Event listeners can access this information through the inherited type property.
|
|
bubbles:Boolean — Determines whether the Event object participates in the bubbling phase of the event flow. Event listeners can access this information through the inherited bubbles property.
|
|
cancelable:Boolean — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property.
|
|
overall:Number — Overall process completion status, from 0 to 100
|
|
overallDescription:String — Overall process desccription
|
|
current:Number — Cverall process completion status, from 0 to 100
|
|
currentDescription:String — Cverall process desccription
|