Package org.eclipse.draw2d
Class RoutingAnimator
java.lang.Object
org.eclipse.draw2d.Animator
org.eclipse.draw2d.RoutingAnimator
- All Implemented Interfaces:
- RoutingListener
Animates the routing of a connection. The animator will capture the effects
 of the connection's router, and the play back the placement of the routing,
 interpolating the intermediate routes.
 
 To use a routing animator, hook it as a routing listener for the connection
 whose points are to be animated, by calling
 PolylineConnection.addRoutingListener(RoutingListener). An animator
 is active only when the Animation utility is activated.
- Since:
- 3.2
- 
Nested Class SummaryNested classes/interfaces inherited from interface org.eclipse.draw2d.RoutingListenerRoutingListener.Stub
- 
Constructor SummaryConstructorsModifierConstructorDescriptionprotectedConstructs a routing animator for use with one or more connections.
- 
Method SummaryModifier and TypeMethodDescriptionprotected ObjectgetCurrentState(IFigure connection) Returns the current state of the connection.static RoutingAnimatorReturns the default instance.final voidinvalidate(Connection conn) Hooks invalidate for animation purposes.protected booleanPlays back the interpolated state.voidplaybackStarting(IFigure connection) Overridden to sync initial and final states.final voidpostRoute(Connection connection) Hooks post routing for animation purposes.final voidremove(Connection connection) This callback is unused.final booleanroute(Connection conn) Hooks route to intercept routing during animation playback.final voidsetConstraint(Connection connection, Object constraint) This callback is unused.Methods inherited from class org.eclipse.draw2d.Animatorcapture, init, recordFinalState, recordInitialState, tearDown
- 
Constructor Details- 
RoutingAnimatorprotected RoutingAnimator()Constructs a routing animator for use with one or more connections. The default instance (getDefault()can be used on any number of connections.- Since:
- 3.2
 
 
- 
- 
Method Details- 
playbackStartingOverridden to sync initial and final states.- Overrides:
- playbackStartingin class- Animator
- Parameters:
- connection- the figure
- See Also:
 
- 
getCurrentStateReturns the current state of the connection. Currently, this is a copy of the list of points. However this Object could change in future releases and should not be considered API.- Specified by:
- getCurrentStatein class- Animator
- Parameters:
- connection- the figure
- Returns:
- the current state
- See Also:
 
- 
getDefaultReturns the default instance.- Returns:
- the default instance
- Since:
- 3.2
 
- 
invalidateHooks invalidate for animation purposes.- Specified by:
- invalidatein interface- RoutingListener
- Parameters:
- conn- the connection
- See Also:
 
- 
playbackPlays back the interpolated state.
- 
postRouteHooks post routing for animation purposes.- Specified by:
- postRoutein interface- RoutingListener
- Parameters:
- connection- the routed connection
- See Also:
 
- 
removeThis callback is unused. Reserved for possible future use.- Specified by:
- removein interface- RoutingListener
- Parameters:
- connection- the connection
- See Also:
 
- 
routeHooks route to intercept routing during animation playback.- Specified by:
- routein interface- RoutingListener
- Parameters:
- conn- the connection being routed
- Returns:
- trueif routing has been performed by the listener
- See Also:
 
- 
setConstraintThis callback is unused. Reserved for possible future use.- Specified by:
- setConstraintin interface- RoutingListener
- Parameters:
- connection- the connection
- constraint- the new constraint
- See Also:
 
 
-