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

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          org.apache.myfaces.html5.component.effect.AbstractEffectOutput
              org.apache.myfaces.html5.component.effect.EffectOutput
                  org.apache.myfaces.html5.component.effect.AbstractEffects

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

Direct Known Subclasses:

Effects

@JSFComponent(name="fx:effects",
              clazz="org.apache.myfaces.html5.component.effect.Effects",
              tagClass="org.apache.myfaces.html5.tag.effect.EffectsTag",
              defaultRendererType="org.apache.myfaces.html5.Effects",
              family="org.apache.myfaces.Effects",
              type="org.apache.myfaces.html5.Effects")
public abstract class AbstractEffects
extends EffectOutput
implements TransitionProperties

Container for effects.
fx:effect... components should be nested inside this component.

Author:

Ali Ok

Field Summary

Fields inherited from class org.apache.myfaces.html5.component.effect.EffectOutput

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

AbstractEffects()

Method Summary

abstract String	getAdditionalStyleClassToActivate() Css style class name to activate additionally with the effect.
abstract Object	getDeactivationEvents() Event(s) to deactivate to effect.
abstract String	getEvent()
String	getTransitionComponentId()
void	setTransitionComponentId(String transitionComponentId)

Methods inherited from class org.apache.myfaces.html5.component.effect.EffectOutput

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

Methods inherited from interface org.apache.myfaces.html5.component.properties.effect.TransitionProperties

getDelay, getDuration, getTimingFunction

Constructor Detail

AbstractEffects

public AbstractEffects()

Method Detail

setTransitionComponentId

public void setTransitionComponentId(String transitionComponentId)

getTransitionComponentId

public String getTransitionComponentId()

getEvent

@JSFProperty(tagExcluded=true)
public abstract String getEvent()

getDeactivationEvents

@JSFProperty(deferredValueType="java.lang.Object")
public abstract Object getDeactivationEvents()

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).

getAdditionalStyleClassToActivate

@JSFProperty(deferredValueType="java.lang.String")
public abstract String getAdditionalStyleClassToActivate()

Css style class name to activate additionally with the effect.