org.apache.myfaces.html5.component.animation
Class Animation

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          org.apache.myfaces.html5.component.animation.AbstractAnimation
              org.apache.myfaces.html5.component.animation.Animation

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, EventProperty

public class Animation
extends AbstractAnimation

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

Animation()

Method Summary

String	getDelay() Duration for animation/effect to wait before running.
String	getDirection()
String	getDuration() Duration for animation/effect to run through.
String	getEvent() A String identifying the type of event the Ajax action will apply to.
String	getFamily()
String	getIteration()
String	getKeyFrame()
String	getTimingFunction() Timing function to calculate animation/effect transitions.
void	setDelay(String delay)
void	setDirection(String direction)
void	setDuration(String duration)
void	setEvent(String event)
void	setIteration(String iteration)
void	setKeyFrame(String keyFrame)
void	setTimingFunction(String timingFunction)

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

Animation

public Animation()

Method Detail

getFamily

public String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

getIteration

public String getIteration()

Specified by:

getIteration in class AbstractAnimation

setIteration

public void setIteration(String iteration)

getDirection

public String getDirection()

Specified by:

getDirection in class AbstractAnimation

setDirection

public void setDirection(String direction)

getKeyFrame

public String getKeyFrame()

Specified by:

getKeyFrame in class AbstractAnimation

setKeyFrame

public void setKeyFrame(String keyFrame)

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:

• '1' : 1 second
• '1s' : 1 seconds
• '0.1' : 0.1 second
• '100ms' : 100 milliseconds

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:

• ease
• linear
• ease-in
• ease-out
• ease-in-out
• cubic-bezier(<number>, <number>, <number>, <number>)

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:

• '1' : 1 second
• '1s' : 1 seconds
• '0.1' : 0.1 second
• '100ms' : 100 milliseconds

setDelay

public void setDelay(String delay)

getEvent

public String getEvent()

Description copied from interface: EventProperty

A String identifying the type of event the Ajax action will apply to. If specified, it must be one of the events supported by the component the Ajax behavior is being applied to.For HTML components this would be the set of supported DOM events for the component, plus "action" for Faces ActionSource components and "valueChange" for Faces EditableValueHolder components. If not specified, the default event is determined for the component. The DOM event name is the actual DOM event name (for example: "click") as opposed to (for example: "onclick").

setEvent

public void setEvent(String event)