org.apache.myfaces.html5.component.effect
Class Effects

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by org.apache.myfaces.html5.component.effect.AbstractEffectOutput
              extended by org.apache.myfaces.html5.component.effect.EffectOutput
                  extended by org.apache.myfaces.html5.component.effect.AbstractEffects
                      extended by org.apache.myfaces.html5.component.effect.Effects
All Implemented Interfaces:
EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, TransitionProperties, TargetProperty

public class Effects
extends AbstractEffects


Field Summary
static String COMPONENT_FAMILY
           
static String COMPONENT_TYPE
           
 
Fields inherited from class javax.faces.component.UIComponent
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY
 
Constructor Summary
Effects()
           
 
Method Summary
 String getAdditionalStyleClassToActivate()
          Css style class name to activate additionally with the effect.
 Object getDeactivationEvents()
          Event(s) to deactivate to effect.
 String getDelay()
          Duration for animation/effect to wait before running.
 String getDuration()
          Duration for animation/effect to run through.
 String getEvent()
           
 String getFamily()
           
 String getTimingFunction()
          Timing function to calculate animation/effect transitions.
 void setAdditionalStyleClassToActivate(String additionalStyleClassToActivate)
           
 void setDeactivationEvents(Object deactivationEvents)
           
 void setDelay(String delay)
           
 void setDuration(String duration)
           
 void setEvent(String event)
           
 void setTimingFunction(String timingFunction)
           
 
Methods inherited from class org.apache.myfaces.html5.component.effect.AbstractEffects
getTransitionComponentId, setTransitionComponentId
 
Methods inherited from class org.apache.myfaces.html5.component.effect.EffectOutput
getTarget, setTarget
 
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values
Constructor Detail

Effects

public Effects()
Method Detail

getFamily

public String getFamily()
Overrides:
getFamily in class EffectOutput

getEvent

public String getEvent()
Specified by:
getEvent in class AbstractEffects

setEvent

public void setEvent(String event)

getDeactivationEvents

public Object getDeactivationEvents()
Description copied from class: AbstractEffects
Event(s) to deactivate to effect. The effect is activated on the event defined with the 'event' attribute, and deactivated on any of the events defined with this attribute. Value can be strings separated with comma, list of strings or array of strings.
For example to to activate the effect on mouse hover and deactivate it on click or mouse out: event='mouseover' deactivationEvents='mouseout, click' attributes should be defined.
If nothing is defined, the renderer will use deactivation events that make sense(i.e. 'drop' and 'dragleave' for 'dragover' event).

Specified by:
getDeactivationEvents in class AbstractEffects

setDeactivationEvents

public void setDeactivationEvents(Object deactivationEvents)

getAdditionalStyleClassToActivate

public String getAdditionalStyleClassToActivate()
Description copied from class: AbstractEffects
Css style class name to activate additionally with the effect.

Specified by:
getAdditionalStyleClassToActivate in class AbstractEffects

setAdditionalStyleClassToActivate

public void setAdditionalStyleClassToActivate(String additionalStyleClassToActivate)

getDuration

public String getDuration()
Description copied from interface: TransitionProperties
Duration for animation/effect to run through.
Value must be in seconds or milliseconds, thus must end with 's' or 'ms'. If not, the value is considered in seconds.
Some of the sample values are:


setDuration

public void setDuration(String duration)

getTimingFunction

public String getTimingFunction()
Description copied from interface: TransitionProperties
Timing function to calculate animation/effect transitions.
The timing functions defined by CSS3 spec are:


setTimingFunction

public void setTimingFunction(String timingFunction)

getDelay

public String getDelay()
Description copied from interface: TransitionProperties
Duration for animation/effect to wait before running.
Value must be in seconds or milliseconds, thus must end with 's' or 'ms'. If not, the value is considered in seconds.
Some of the sample values are:


setDelay

public void setDelay(String delay)


Copyright © 2011 The Apache Software Foundation. All Rights Reserved.