|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.myfaces.trinidad.change.ComponentChange
org.apache.myfaces.trinidad.change.MoveChildComponentChange
public final class MoveChildComponentChange
Change specialization for moving a child from one container to another. MoveChildComponent should be registered on a parent component that is common to the child being moved and the container component at destination. In other words, while calling addComponentChange() or addDocumentChange() methods on the ChangeManager to add a MoveChildComponentChange, the common parent component instance must be passed as an argument. The add() utility method in this class can be alternatively used to conveniently register the change against the common parent. While applying this change, if a child with the same id as the movable child were to be already present in the destination container, the move operation is aborted.
add(FacesContext, ChangeManager)
,
ChangeManager.addComponentChange(FacesContext, UIComponent, ComponentChange)
,
ChangeManager.addDocumentChange(FacesContext, UIComponent, DocumentChange)
,
Serialized FormConstructor Summary | |
---|---|
MoveChildComponentChange(javax.faces.component.UIComponent movableChild,
javax.faces.component.UIComponent destinationContainer)
Constructs a MoveChildComponentChange. |
|
MoveChildComponentChange(javax.faces.component.UIComponent movableChild,
javax.faces.component.UIComponent destinationContainer,
javax.faces.component.UIComponent insertBeforeComponent)
Constructs a MoveChildComponentChange. |
Method Summary | |
---|---|
javax.faces.component.UIComponent |
add(javax.faces.context.FacesContext facesContext,
ChangeManager changeManager)
Convenience method to add this MoveChildComponentChange to the supplied ChangeManager. |
void |
changeComponent(javax.faces.component.UIComponent changeTargetComponent)
Apply this change to the specified component. |
void |
changeDocument(Node changeTargetNode)
Given the DOM Node representing a Component, apply any necessary DOM changes. |
boolean |
equals(Object o)
|
String |
getDestinationLogicalScopedId()
Returns the absolute logical scopedId of the source component at its destination |
String |
getDestinationScopedId()
Returns the absolute scopedId of the source component at its destination |
boolean |
getForcesDocumentReload()
Returns true if adding the DocumentChange should force the JSP Document to reload |
String |
getSourceLogicalScopedId()
Returns the absolute logical scopedId of the source component |
String |
getSourceScopedId()
Returns the absolute scopedId of the source component |
int |
hashCode()
|
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public MoveChildComponentChange(javax.faces.component.UIComponent movableChild, javax.faces.component.UIComponent destinationContainer)
movableChild
- The child component to be moved.destinationContainer
- The destination component into which the child
component is to be moved.
IllegalArgumentException
- If movableChild or destinationContainer
is nullpublic MoveChildComponentChange(javax.faces.component.UIComponent movableChild, javax.faces.component.UIComponent destinationContainer, javax.faces.component.UIComponent insertBeforeComponent)
movableChild
- The child component to be moved.destinationContainer
- The destination component into which the child
component is to be moved.insertBeforeComponent
- The component before which the moved child is
to be inserted. This can be null, in which case the movableChild is
appended.
IllegalArgumentException
- If movableChild or destinationContainer
is null, or if a parent component common to movableChild and
destinationContainer could not be found.Method Detail |
---|
public javax.faces.component.UIComponent add(javax.faces.context.FacesContext facesContext, ChangeManager changeManager)
facesContext
- The FacesContext instance for the current requestchangeManager
- The ChangeManager instance on which this
MoveChildComponentChange is to be added.
public void changeComponent(javax.faces.component.UIComponent changeTargetComponent)
changeComponent
in class ComponentChange
changeTargetComponent
- The component that is a common parent to the
movable child and the destination container.
IllegalArgumentException
- If the supplied changeTargetComponent
is null.public void changeDocument(Node changeTargetNode)
changeDocument
in interface DocumentChange
changeTargetNode
- DOM Node that is a common parent for the movable
child and the destination container.
IllegalArgumentException
- If changeTargeNode were to be null.public boolean getForcesDocumentReload()
getForcesDocumentReload
in interface DocumentChange
public String getSourceScopedId()
public String getDestinationScopedId()
public String getSourceLogicalScopedId()
public String getDestinationLogicalScopedId()
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |