Skip navigation links

org.apache.myfaces.trinidad.change
Class AddChildDocumentChange

java.lang.Object
org.apache.myfaces.trinidad.change.AddComponentDocumentChange
org.apache.myfaces.trinidad.change.AddChildDocumentChange

All Implemented Interfaces:

DocumentChange

public class AddChildDocumentChange

extends AddComponentDocumentChange

Change specialization for adding a child component using document mark up. While applying this Change, the child component is created and added to the document.

Constructor Summary

AddChildDocumentChange(org.w3c.dom.DocumentFragment componentFragment)
Constructs an AddChildDocumentChange with the specified child component mark up.

AddChildDocumentChange(java.lang.String insertBeforeId, org.w3c.dom.DocumentFragment componentFragment)
Constructs an AddChildDocumentChange with the specified child component mark up and the identifier of the neighbour.

Method Summary

void	changeDocument(org.w3c.dom.Node componentNode) Given the DOM Node representing a Component, apply any necessary DOM changes.
java.lang.String	getInsertBeforeId() Returns the identifier of the sibling before which this new child needs to be inserted.

Methods inherited from class org.apache.myfaces.trinidad.change.AddComponentDocumentChange

getComponentFragment, getForcesDocumentReload, getImportedComponentFragment

Methods inherited from class java.lang.Object

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

Constructor Detail

AddChildDocumentChange

public AddChildDocumentChange(org.w3c.dom.DocumentFragment componentFragment)

Constructs an AddChildDocumentChange with the specified child component mark up.

Parameters:

componentFragment - DOM mark up for child component to be appended.

Throws:

java.lang.IllegalArgumentException - if componentFragment is null

AddChildDocumentChange

public AddChildDocumentChange(java.lang.String insertBeforeId,
                              org.w3c.dom.DocumentFragment componentFragment)

Constructs an AddChildDocumentChange with the specified child component mark up and the identifier of the neighbour. If the neighbour were not to be found while applying this Change, the child is appended to the end of the list of children.

Parameters:

insertBeforeId - The identifier of the sibling before which this new child is to be inserted or null to append the child

componentFragment - DOM mark up for child component to be inserted.

Throws:

java.lang.IllegalArgumentException - if componentFragment is null

Method Detail

getInsertBeforeId

public java.lang.String getInsertBeforeId()

Returns the identifier of the sibling before which this new child needs to be inserted.

changeDocument

public void changeDocument(org.w3c.dom.Node componentNode)

Given the DOM Node representing a Component, apply any necessary DOM changes.

Parameters:

componentNode - DOM node of the component to apply the change to

Skip navigation links