Package org.eclipse.draw2d
Class LayoutAnimator
java.lang.Object
org.eclipse.draw2d.Animator
org.eclipse.draw2d.LayoutAnimator
- All Implemented Interfaces:
- LayoutListener
Animates the layout of a figure's children. The animator will capture the
 effects of a layout manager, and then play back the placement of children
 using linear interpolation for each child's start and end locations.
 
 To use an animator, hook it as a layout listener for the figure whose layout
 is to be animated, by calling
 IFigure.addLayoutListener(LayoutListener). It is not necessary to
 have an animator for every figure in a composition that is undergoing
 animation. For example, if a figure without an animator moves during the
 animation, it will continue to move and layout its children normally during
 each step of the animation.
 
 Animator must be used in conjunction with layouts. If figures are placed
 manually using setBounds(), the animator may not be able to
 track and playback the changes that occur.
- Since:
- 3.2
- 
Nested Class SummaryNested classes/interfaces inherited from interface org.eclipse.draw2d.LayoutListenerLayoutListener.Stub
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionprotected ObjectgetCurrentState(IFigure container) Returns an object encapsulating the placement of children in a container.static LayoutAnimatorReturns the default instance.final voidinvalidate(IFigure container) Hooks invalidation in case animation is in progress.final booleanHooks layout in case animation is in progress.protected booleanPlays back the animated layout.final voidpostLayout(IFigure container) Hooks post layout in case animation is in progress.final voidThis callback is unused.final voidsetConstraint(IFigure child, Object constraint) This callback is unused.Methods inherited from class org.eclipse.draw2d.Animatorcapture, init, playbackStarting, recordFinalState, recordInitialState, tearDown
- 
Constructor Details- 
LayoutAnimatorprotected LayoutAnimator()Constructs a new Animator. The default instance (getDefault()) can be used on all figures being animated.- Since:
- 3.2
 
 
- 
- 
Method Details- 
getCurrentStateReturns an object encapsulating the placement of children in a container. This method is called to capture both the initial and final states.- Specified by:
- getCurrentStatein class- Animator
- Parameters:
- container- the container figure
- Returns:
- the current state
- Since:
- 3.2
 
- 
getDefaultReturns the default instance.- Returns:
- the default instance
- Since:
- 3.2
 
- 
invalidateHooks invalidation in case animation is in progress.- Specified by:
- invalidatein interface- LayoutListener
- Parameters:
- container- the invalidated Figure
- See Also:
 
- 
layoutHooks layout in case animation is in progress.- Specified by:
- layoutin interface- LayoutListener
- Parameters:
- container- the figure incurring a layout
- Returns:
- trueif the layout has been intercepted by the listener
- See Also:
 
- 
playbackPlays back the animated layout.
- 
postLayoutHooks post layout in case animation is in progress.- Specified by:
- postLayoutin interface- LayoutListener
- Parameters:
- container- the figure incurring a layout
- See Also:
 
- 
removeThis callback is unused. Reserved for possible future use.- Specified by:
- removein interface- LayoutListener
- Parameters:
- child- the child being removed
- See Also:
 
- 
setConstraintThis callback is unused. Reserved for possible future use.- Specified by:
- setConstraintin interface- LayoutListener
- Parameters:
- child- the child being updated
- constraint- the child's new constraint
- See Also:
 
 
-