Presto (Xalys Graphic Library 1.0.0-SNAPSHOT API)

java.lang.Object
- com.xalys.xgl.AnimationFrame
- - com.xalys.xgl.presto.Presto

```
@JsType(namespace="xgl")
public class Presto
extends AnimationFrame
```
Presto schedules the readings and writings and execute them during the browser's animation frame. Presto prevents layout trashing/reflow.

Presto allows the throttling of high firing rates events.

Author:

Paul Sitarz

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Presto.State
State is the current state of the Presto scheduler.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Presto.State` State is the current state of the Presto scheduler.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`asSoonAsPossible(Measure measure)` Runs a measure as soon as possible, which means that if the scheduler is in the `Presto.State.MEASURING` state, the measure is run immediately.
`static void`	`asSoonAsPossible(Mutation mutation)` Runs a mutation as soon as possible, which means that if the scheduler is in the `Presto.State.MEASURING` or `Presto.State.MUTATING` state, the mutation is run in the current cycle.
`static void`	`cancel(Measure measure)` Cancels a measure scheduled in the next Presto's cycle.
`static void`	`cancel(Mutation mutation)` Cancels a mutation scheduled in the next Presto's cycle.
`static void`	`cancelMeasure(Measure measure)` Cancels a measure scheduled in the next Presto's cycle.
`static void`	`cancelMutation(Mutation mutation)` Cancels a mutation scheduled in the next Presto's cycle.
`static boolean`	`canRead()` Checks if Presto will allow reading the DOM.
`static boolean`	`canWrite()` Checks if Presto will allow writing in the DOM.
`static void`	`ensureReadable()` Ensures Presto will allow reading the DOM.
`static void`	`ensuresSynchronous()` Ensures Presto is not running its cycle.
`static void`	`ensureWriteable(boolean attached)` Ensures Presto will allow writing in the DOM.
`static double`	`getCycleHighResTimeStamp()` Gets the high-resolution time stamp of the start time of the current cycle.
`static LayoutLock`	`getLock()`
`static long`	`getRunId()` The run id is incremented at the start of each run of the Presto's cycle.
`static Presto.State`	`getState()`
`static double`	`highResTimeStamp()` Gets the current high-resolution time stamp.
`static boolean`	`isAsynchronous()` Checks if Presto is running its cycle.
`static boolean`	`isStrictLockMode()` Gets the current Presto's lock mode.
`static boolean`	`isSynchronous()` Checks if Presto is not running its cycle.
`static void`	`measureAsSoonAsPossible(Measure measure)` Runs a measure as soon as possible, which means that if the scheduler is in the `Presto.State.MEASURING` state, the measure is run immediately.
`static void`	`mutateAsSoonAsPossible(Mutation mutation)` Runs a mutation as soon as possible, which means that if the scheduler is in the `Presto.State.MEASURING` or `Presto.State.MUTATING` state, the mutation is run in the current cycle.
`static void`	`now(Immediate immediate)` Execute synchronously the `Immediate` object.
`void`	`run(double highResTimeStamp)` Runs the Presto cycle.
`static void`	`schedule(Measure measure)` Runs a measure in next Presto's cycle.
`static void`	`schedule(Mutation mutation)` Runs a mutation in the next Presto's cycle.
`static void`	`scheduleMeasure(Measure measure)` Runs a measure in next Presto's cycle.
`static void`	`scheduleMutation(Mutation mutation)` Runs a mutation in the next Presto's cycle.
`static void`	`setStrictLockMode(boolean strictLockMode)` If strictLockMode is false, Presto will allow any interaction with the DOM outside its cycle.

Methods inherited from class com.xalys.xgl.AnimationFrame
cancel, isScheduled, schedule

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - now
```
public static void now(Immediate immediate)
```
    Execute synchronously the Immediate object. Presto allows any measure and mutation to be performed.
    
    Parameters:
    
    immediate - the action to perform synchronously.
  - schedule
```
@JsIgnore
public static void schedule(Measure measure)
```
    Runs a measure in next Presto's cycle.
    
    Parameters:
    
    measure - the measure to perform during the next cycle
  - scheduleMeasure
```
public static void scheduleMeasure(Measure measure)
```
    Runs a measure in next Presto's cycle.
    
    Parameters:
    
    measure - the measure to perform during the next cycle
  - schedule
```
@JsIgnore
public static void schedule(Mutation mutation)
```
    Runs a mutation in the next Presto's cycle.
    
    Note: Mutations are performed after all scheduled measures are executed.
    
    Parameters:
    
    mutation - the mutation to perform during the next cycle
  - scheduleMutation
```
public static void scheduleMutation(Mutation mutation)
```
    Runs a mutation in the next Presto's cycle.
    
    Note: Mutations are performed after all scheduled measures are executed.
    
    Parameters:
    
    mutation - the mutation to perform during the next cycle
  - measureAsSoonAsPossible
```
public static void measureAsSoonAsPossible(Measure measure)
```
    Runs a measure as soon as possible, which means that if the scheduler is in the Presto.State.MEASURING state, the measure is run immediately.
    
    Parameters:
    
    measure - the measure to performed as soon as possible
  - asSoonAsPossible
```
@JsIgnore
public static void asSoonAsPossible(Measure measure)
```
    Runs a measure as soon as possible, which means that if the scheduler is in the Presto.State.MEASURING state, the measure is run immediately.
    
    Parameters:
    
    measure - the measure to perform as soon as possible
  - mutateAsSoonAsPossible
```
public static void mutateAsSoonAsPossible(Mutation mutation)
```
    Runs a mutation as soon as possible, which means that if the scheduler is in the Presto.State.MEASURING or Presto.State.MUTATING state, the mutation is run in the current cycle. It should never be used when a measure is needed to perform a mutation. The measure may or may not be performed when the mutation is performed.
    
    Parameters:
    
    mutation - the mutation to perform as soon as possible
  - asSoonAsPossible
```
@JsIgnore
public static void asSoonAsPossible(Mutation mutation)
```
    Runs a mutation as soon as possible, which means that if the scheduler is in the Presto.State.MEASURING or Presto.State.MUTATING state, the mutation is run in the current cycle. It should never be used when a measure is needed to perform a mutation. The measure may or may not be performed when the mutation is performed.
    
    Parameters:
    
    mutation - the mutation to perform as soon as possible
  - getState
```
public static Presto.State getState()
```
    Returns:
    
    the state
  - cancel
```
@JsIgnore
public static void cancel(Measure measure)
```
    Cancels a measure scheduled in the next Presto's cycle.
    
    Parameters:
    
    measure - the measure to cancel
  - cancelMeasure
```
public static void cancelMeasure(Measure measure)
```
    Cancels a measure scheduled in the next Presto's cycle.
    
    Parameters:
    
    measure - the measure to cancel
  - cancel
```
@JsIgnore
public static void cancel(Mutation mutation)
```
    Cancels a mutation scheduled in the next Presto's cycle.
    
    Parameters:
    
    mutation - the mutation to cancel
  - cancelMutation
```
public static void cancelMutation(Mutation mutation)
```
    Cancels a mutation scheduled in the next Presto's cycle.
    
    Parameters:
    
    mutation - the mutation to cancel
  - run
```
public void run(double highResTimeStamp)
```
    Runs the Presto cycle.
    
    Not available to outside access since the class is not instanciable...
    
    Specified by:
    
    run in class AnimationFrame
    
    See Also:
    
    AnimationFrame.run(double)
  - getLock
```
public static LayoutLock getLock()
```
    Returns:
    
    the lock
  - isStrictLockMode
```
public static boolean isStrictLockMode()
```
    Gets the current Presto's lock mode.
    
    Returns:
    
    the current locking mode
    
    See Also:
    
    setStrictLockMode(boolean)
  - setStrictLockMode
```
public static void setStrictLockMode(boolean strictLockMode)
```
    If strictLockMode is false, Presto will allow any interaction with the DOM outside its cycle. This disable Presto.
    
    Any measure or mutation added will still be subject to Presto's policy regarding the access to the DOM.
    
    Note: It is best to keep the Strict Lock Mode on.
    
    Parameters:
    
    strictLockMode - True (default): Presto will control all access to the DOM. False: Presto will not control access to the DOM not in its cycle.
  - canRead
```
public static boolean canRead()
```
    Checks if Presto will allow reading the DOM.
    
    Returns:
    
    true if DOM reading is allowed
  - canWrite
```
public static boolean canWrite()
```
    Checks if Presto will allow writing in the DOM.
    
    Returns:
    
    true if DOM writing is allowed
  - ensureReadable
```
public static void ensureReadable()
```
    Ensures Presto will allow reading the DOM.
    
    Throws:
    
    IllegalStateException - if DOM reading is not allowed
  - ensureWriteable
```
public static void ensureWriteable(boolean attached)
```
    Ensures Presto will allow writing in the DOM.
    
    Throws:
    
    IllegalStateException - if DOM writing is not allowed
  - isSynchronous
```
public static boolean isSynchronous()
```
    Checks if Presto is not running its cycle.
    
    Returns:
    
    true if Presto is stopped or waiting for the animation frame
  - ensuresSynchronous
```
public static void ensuresSynchronous()
```
    Ensures Presto is not running its cycle.
    
    Throws:
    
    IllegalStateException - if Presto cycle is running
  - isAsynchronous
```
public static boolean isAsynchronous()
```
    Checks if Presto is running its cycle.
    
    Returns:
    
    true if Presto is running
  - getRunId
```
@JsIgnore
public static long getRunId()
```
    The run id is incremented at the start of each run of the Presto's cycle.
    
    Returns:
    
    the current run id.
  - getCycleHighResTimeStamp
```
public static double getCycleHighResTimeStamp()
```
    Gets the high-resolution time stamp of the start time of the current cycle.
    
    Returns:
    
    the high-resolution time stamp of the starting time of the cycle
  - highResTimeStamp
```
public static double highResTimeStamp()
```
    Gets the current high-resolution time stamp.
    
    Returns:
    
    the current high-resolution time stamp

Class Presto

Nested Class Summary

Method Summary

Methods inherited from class com.xalys.xgl.AnimationFrame

Methods inherited from class java.lang.Object

Method Detail

now

schedule

scheduleMeasure

schedule

scheduleMutation

measureAsSoonAsPossible

asSoonAsPossible

mutateAsSoonAsPossible

asSoonAsPossible

getState

cancel

cancelMeasure

cancel

cancelMutation

run

getLock

isStrictLockMode

setStrictLockMode

canRead

canWrite

ensureReadable

ensureWriteable

isSynchronous

ensuresSynchronous

isAsynchronous

getRunId

getCycleHighResTimeStamp

highResTimeStamp