org.jvnet.lafwidget.layout

Class TransitionLayoutManager

java.lang.Object

org.jvnet.lafwidget.layout.TransitionLayoutManager

public class TransitionLayoutManager
extends java.lang.Object

Transition layout manager. Contains method for installing / uninstalling transition layout effects on containers. Application code should use the methods in this class instead of using the TransitionLayout class directly.

Author:

Kirill Grouchnikov.

Method Summary

Methods

Modifier and Type	Method and Description
static TransitionLayoutManager	getInstance() Returns the manager instance.
void	track(java.awt.Container container, boolean hasFades) Starts tracking the specified container adding the transition layout effects.
void	track(java.awt.Container container, boolean hasFades, boolean doImmediateRepaint) Starts tracking the specified container adding the transition layout effects.
void	untrack(java.awt.Container container) Removes the transition layout effects from the specified container.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static TransitionLayoutManager getInstance()

Returns the manager instance.

Returns:

Manager instance.

track

public void track(java.awt.Container container,
         boolean hasFades)

Starts tracking the specified container adding the transition layout effects. This method can be called on a container that already has transition layout effects installed - in this case the call will have no effect (preserving the transition layout effects).

Parameters:

container - Container for transition layout effects.

hasFades - Indication whether the fade effects should be applied. Use true only for look-and-feels that honour the TransitionLayout.ALPHA client property (directly, via calls to TransitionLayout.getAlphaComposite(java.awt.Component) / TransitionLayout.getAlphaComposite(java.awt.Component, float) or with the bytecode augmentation.

track

public void track(java.awt.Container container,
         boolean hasFades,
         boolean doImmediateRepaint)

Starts tracking the specified container adding the transition layout effects. Note that providing true for the doImmediateRepaint parameter will result in very CPU-intensive code - this is not recommended for now. This method can be called on a container that already has transition layout effects installed - in this case the call will have no effect (preserving the transition layout effects).

Parameters:

container - Container for transition layout effects.

hasFades - Indication whether the fade effects should be applied. Use true only for look-and-feels that honour the TransitionLayout.ALPHA client property (directly, via calls to TransitionLayout.getAlphaComposite(java.awt.Component) / TransitionLayout.getAlphaComposite(java.awt.Component, float) or with the bytecode augmentation.

doImmediateRepaint - If true, every transition step will result in repainting the relevant component. Recommended value is false for better performance.

untrack

public void untrack(java.awt.Container container)

Removes the transition layout effects from the specified container. The layout manager is reset to the original layout manager. This method can be called on a container that hadn't been tracked with track(Container, boolean) or track(Container, boolean, boolean).

Parameters:

container - Container.