org.omnifaces.component.util

Class MoveComponent

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.omnifaces.component.util.UtilFamily

org.omnifaces.component.util.MoveComponent

All Implemented Interfaces:

EventListener, ClientBehaviorHolder, PartialStateHolder, StateHolder, TransientStateHolder, ComponentSystemEventListener, FacesListener, SystemEventListener, SystemEventListenerHolder

public class MoveComponent
extends UtilFamily
implements SystemEventListener, ClientBehaviorHolder

The <o:moveComponent> component is a utility component via which components, facets and behaviors can be moved at runtime to a target component in various ways. This allows for simple programmatic composition of components using a declarative page author centric approach.

The destination of a move operation is specified in terms of a location that's relative to a given target component. The following shows a list of supported destinations:

• BEFORE - Component is moved right before target component, i.e. as a sibling with an index that's 1 position lower
• ADD_FIRST - Component is added as the first child of the target component, any other children will have their index increased by 1
• ADD_LAST - Component is added as the last child of the target component, any other children will stay at their original location
• FACET - Component will be moved to the facet section of the target component under the name denoted by "facet"
• BEHAVIOR - A Behavior will be moved to the behavior section of the target component
• AFTER - Component is moved right after target component, i.e. as a sibling with an index that's 1 position higher

Since:

2.0

Author:

Arjan Tijms

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MoveComponent.Destination

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_TYPE
static String	DEFAULT_SCOPE

Fields inherited from class org.omnifaces.component.util.UtilFamily

COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
MoveComponent()

Method Summary

Modifier and Type	Method and Description
void	addClientBehavior(String eventName, ClientBehavior behavior)
void	doProcess()
String	getBehaviorDefaultEvent()
String	getBehaviorEvents()
String	getDefaultEventName()
MoveComponent.Destination	getDestination()
Collection<String>	getEventNames()
String	getFacet()
String	getFor()
boolean	isListenerForSource(Object source)
void	processEvent(SystemEvent event)
void	setBehaviorDefaultEvent(String behaviorDefaultEventValue)
void	setBehaviorEvents(String behaviorEventsValue)
void	setDestination(MoveComponent.Destination destinationValue)
void	setFacet(String facetValue)
void	setFor(String nameValue)

Methods inherited from class org.omnifaces.component.util.UtilFamily

getFamily, getRendersChildren

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

getClientBehaviors

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

DEFAULT_SCOPE

public static final String DEFAULT_SCOPE

See Also:

Constant Field Values

Constructor Detail

MoveComponent

public MoveComponent()

Method Detail

isListenerForSource

public boolean isListenerForSource(Object source)

Specified by:

isListenerForSource in interface SystemEventListener

processEvent

public void processEvent(SystemEvent event)
                  throws AbortProcessingException

Specified by:

processEvent in interface SystemEventListener

Throws:

AbortProcessingException

addClientBehavior

public void addClientBehavior(String eventName,
                              ClientBehavior behavior)

Specified by:

addClientBehavior in interface ClientBehaviorHolder

Overrides:

addClientBehavior in class UIComponentBase

getDefaultEventName

public String getDefaultEventName()

Specified by:

getDefaultEventName in interface ClientBehaviorHolder

Overrides:

getDefaultEventName in class UIComponentBase

getEventNames

public Collection<String> getEventNames()

Specified by:

getEventNames in interface ClientBehaviorHolder

Overrides:

getEventNames in class UIComponentBase

doProcess

public void doProcess()

getFor

public String getFor()

setFor

public void setFor(String nameValue)

getDestination

public MoveComponent.Destination getDestination()

setDestination

public void setDestination(MoveComponent.Destination destinationValue)

getFacet

public String getFacet()

setFacet

public void setFacet(String facetValue)

getBehaviorDefaultEvent

public String getBehaviorDefaultEvent()

setBehaviorDefaultEvent

public void setBehaviorDefaultEvent(String behaviorDefaultEventValue)

getBehaviorEvents

public String getBehaviorEvents()

setBehaviorEvents

public void setBehaviorEvents(String behaviorEventsValue)