org.zilonis.tool.ext.aerith.effects
Class EffectsManager

java.lang.Object
  extended by org.zilonis.tool.ext.aerith.effects.EffectsManager

public class EffectsManager
extends java.lang.Object

REMIND: docs...


Nested Class Summary
static class EffectsManager.TransitionType
          An enum that describes the type of transition that this effect should be used for.
 
Method Summary
static ComponentEffect getEffect(java.awt.Component component, EffectsManager.TransitionType transitionType)
          This method is called during the setup phase for any transition.
static void setEffect(java.awt.Component component, ComponentEffect effect, EffectsManager.TransitionType transitionType)
          This method is used to cache a custom effect on a per-component basis for the application.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

setEffect

public static void setEffect(java.awt.Component component,
                             ComponentEffect effect,
                             EffectsManager.TransitionType transitionType)
This method is used to cache a custom effect on a per-component basis for the application. Note that these custom effects are application wide for the duration of the process, or until a new or null effect is set for this component. Note also that custom effects are registered according to the TransitionType. So a custom TransitionType.CHANGING effect for a given component will have no bearing on the effect used in a transition where the component either appears or disappers between the transition states.

Parameters:
component - The Component that this effect should be applied to
effect - The custom effect desired. A null argument effectively cancels any prior custom value for this component and this TransitionType
transitionType - The type of transition to apply this effect on
See Also:
EffectsManager.TransitionType

getEffect

public static ComponentEffect getEffect(java.awt.Component component,
                                        EffectsManager.TransitionType transitionType)
This method is called during the setup phase for any transition. It queries the cache for custom effects for a given component and TransitionType

Parameters:
component - The component we are querying on behalf of
transitionType - The type of transition that the component is going to undergo
Returns:
ComponentEffect A null return value indicates that there is no custom effect associated with this component and transition type