Package org.pushingpixels.trident.api

Class Timeline

java.lang.Object

org.pushingpixels.trident.api.Timeline

All Implemented Interfaces:

TimelineScenario.TimelineScenarioActor

Direct Known Subclasses:

SwingComponentTimeline, SwingRepaintTimeline

public class Timeline
extends java.lang.Object
implements TimelineScenario.TimelineScenarioActor

The main entry point into Trident. Use builder() or builder(Object) and methods on the Timeline.BaseBuilder to configure one or more properties to be interpolated over a period of time. In the simplest case, a timeline operates on a single object passed to builder(Object), and one or more properties that have matching public setters. In that case, use the Timeline.BaseBuilder.addPropertyToInterpolate(String, Object, Object) API to configure which properties should be interpolated.

In a more complex case, use Timeline.BaseBuilder.addPropertyToInterpolate(TimelinePropertyBuilder) together with property(String) and TimelinePropertyBuilder.on(Object) to interpolate properties of multiple objects. TimelinePropertyBuilder.setWith(TimelinePropertyBuilder.PropertySetter), TimelinePropertyBuilder.getWith(TimelinePropertyBuilder.PropertyGetter) and TimelinePropertyBuilder.accessWith(TimelinePropertyBuilder.PropertyAccessor) can be used to work with properties that are not exposed via public setters or getters.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Timeline.BaseBuilder<T extends Timeline,B extends Timeline.BaseBuilder<?,?,?>,M>
static class	Timeline.Builder
static class	Timeline.RepeatBehavior
static class	Timeline.TimelineState

Field Summary

Fields

Modifier and Type	Field	Description
static long	DEFAULT_DURATION
static TimelineEase	DEFAULT_EASE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Timeline(java.lang.Object mainTimelineObject)

Method Summary

Modifier and Type	Method	Description
void	abort()	Aborts this timeline.
protected void	addCallback(TimelineCallback callback)
static Timeline.Builder	builder()
static Timeline.Builder	builder(java.lang.Object mainTimelineObject)
void	cancel()	Cancels this timeline.
void	cancelAtCycleBreak()	Requests that the specified timeline should stop at the end of the cycle.
void	end()	Ends this timeline.
long	getCycleDelay()
long	getDuration()
float	getDurationFraction()
TimelineEase	getEase()
protected static long	getId()	Returns a unique ID.
long	getInitialDelay()
java.lang.Object	getMainObject()
java.lang.String	getName()
Timeline.RepeatBehavior	getRepeatBehavior()
java.lang.Comparable<?>	getSecondaryId()
Timeline.TimelineState	getState()
float	getTimelinePosition()
boolean	isDone()
void	play()
void	playLoop(int loopCount, Timeline.RepeatBehavior repeatBehavior)
void	playLoop(Timeline.RepeatBehavior repeatBehavior)
void	playLoopSkipping(int loopCount, Timeline.RepeatBehavior repeatBehavior, long msToSkip)
void	playLoopSkipping(Timeline.RepeatBehavior repeatBehavior, long msToSkip)
void	playReverse()
void	playReverseSkipping(long msToSkip)
void	playSkipping(long msToSkip)
static <T> TimelinePropertyBuilder<T>	property(java.lang.String propertyName)
void	replay()
void	replayReverse()
void	resetDoneFlag()
void	resume()
protected boolean	shouldForceUiUpdate()
boolean	supportsReplay()
void	suspend()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DURATION

public static final long DEFAULT_DURATION

See Also:

Constant Field Values

DEFAULT_EASE

public static final TimelineEase DEFAULT_EASE

Constructor Detail

Timeline

protected Timeline(java.lang.Object mainTimelineObject)

Method Detail

builder

public static Timeline.Builder builder()

builder

public static Timeline.Builder builder(java.lang.Object mainTimelineObject)

addCallback

protected final void addCallback(TimelineCallback callback)

property

public static <T> TimelinePropertyBuilder<T> property(java.lang.String propertyName)

shouldForceUiUpdate

protected boolean shouldForceUiUpdate()

play

public void play()

Specified by:

play in interface TimelineScenario.TimelineScenarioActor

playSkipping

public void playSkipping(long msToSkip)

playReverse

public void playReverse()

playReverseSkipping

public void playReverseSkipping(long msToSkip)

replay

public void replay()

replayReverse

public void replayReverse()

playLoop

public void playLoop(Timeline.RepeatBehavior repeatBehavior)

playLoopSkipping

public void playLoopSkipping(Timeline.RepeatBehavior repeatBehavior,
                             long msToSkip)

playLoop

public void playLoop(int loopCount,
                     Timeline.RepeatBehavior repeatBehavior)

playLoopSkipping

public void playLoopSkipping(int loopCount,
                             Timeline.RepeatBehavior repeatBehavior,
                             long msToSkip)

cancel

public void cancel()

Cancels this timeline. The timeline transitions to the Timeline.TimelineState.CANCELLED state, preserving its current timeline position. After application callbacks and field interpolations are done on the Timeline.TimelineState.CANCELLED state, the timeline transitions to the Timeline.TimelineState.IDLE state. Application callbacks and field interpolations are done on this state as well.

See Also:

end(), abort()

end

public void end()

Ends this timeline. The timeline transitions to the Timeline.TimelineState.DONE state, with the timeline position set to 0.0 or 1.0 - based on the direction of the timeline. After application callbacks and field interpolations are done on the Timeline.TimelineState.DONE state, the timeline transitions to the Timeline.TimelineState.IDLE state. Application callbacks and field interpolations are done on this state as well.

See Also:

cancel(), abort()

abort

public void abort()

Aborts this timeline. The timeline transitions to the Timeline.TimelineState.IDLE state. No application callbacks or field interpolations are done.

See Also:

cancel(), end()

suspend

public void suspend()

resume

public void resume()

cancelAtCycleBreak

public void cancelAtCycleBreak()

Requests that the specified timeline should stop at the end of the cycle. This method should be called only on looping timelines.

getId

protected static long getId()

Returns a unique ID.

Returns:

Unique ID.

getTimelinePosition

public final float getTimelinePosition()

getDurationFraction

public final float getDurationFraction()

getState

public final Timeline.TimelineState getState()

isDone

public boolean isDone()

Specified by:

isDone in interface TimelineScenario.TimelineScenarioActor

supportsReplay

public boolean supportsReplay()

Specified by:

supportsReplay in interface TimelineScenario.TimelineScenarioActor

resetDoneFlag

public void resetDoneFlag()

Specified by:

resetDoneFlag in interface TimelineScenario.TimelineScenarioActor

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getDuration

public final long getDuration()

getInitialDelay

public long getInitialDelay()

getCycleDelay

public long getCycleDelay()

getRepeatBehavior

public Timeline.RepeatBehavior getRepeatBehavior()

getName

public java.lang.String getName()

getEase

public TimelineEase getEase()

getMainObject

public java.lang.Object getMainObject()

getSecondaryId

public java.lang.Comparable<?> getSecondaryId()