org.springframework.extensions.surf.extensibility

Interface DeferredContentTargetModelElement

All Superinterfaces:

ContentModelElement, ExtensibilityModelElement

public interface DeferredContentTargetModelElement
extends ContentModelElement

This is a ContentModelElement that does not produce any content when it is first rendered by instead relies on subsequently rendered DeferredContentSourceModelElement instances to populate it with data before its final content is flushed. This has been provided to act as a placeholder for CSS and JavaScript dependency requests that may be made by WebScripts rendered later on in the model.

Author:

David Draper

Field Summary

Fields inherited from interface org.springframework.extensions.surf.extensibility.ContentModelElement

TYPE

Method Summary

Methods

Modifier and Type	Method and Description
void	enterEditMode(String mode, DeferredContentSourceModelElement sourceElement) Moves the DeferredContentTargetModelElement into edit mode so that subsequent requests are processed appropriately.
void	exitEditMode() Moves the DeferredContentTargetModelElement out of edit mode so that normal processing is resumed.
void	registerDeferredSourceElement(DeferredContentSourceModelElement sourceElement) This method should be called by a DeferredContentSourceModelElement to register itself with its target so that when the DeferredContentTargetModelElement flushes its content it can reach into the ExtensibilityModel to retrieve the content it needs to output.

Methods inherited from interface org.springframework.extensions.surf.extensibility.ContentModelElement

flushContent, getNextContentBufferElement

Methods inherited from interface org.springframework.extensions.surf.extensibility.ExtensibilityModelElement

getDirectiveName, getId, getType

Method Detail

registerDeferredSourceElement

void registerDeferredSourceElement(DeferredContentSourceModelElement sourceElement)

This method should be called by a DeferredContentSourceModelElement to register itself with its target so that when the DeferredContentTargetModelElement flushes its content it can reach into the ExtensibilityModel to retrieve the content it needs to output.

Parameters:

sourceElement - The DeferredContentSourceModelElement calling the method.

enterEditMode

void enterEditMode(String mode,
                 DeferredContentSourceModelElement sourceElement)

Moves the DeferredContentTargetModelElement into edit mode so that subsequent requests are processed appropriately. This allows the insertion of content at the correct point by an extension.

Parameters:

mode - The edit mode that has been started, e.g. "remove", "replace", "after", etc.

sourceElement - THe DeferredContentSourceModelElement that is being edited.

exitEditMode

void exitEditMode()

Moves the DeferredContentTargetModelElement out of edit mode so that normal processing is resumed.