1 Pixel Out

File name:

layoutManager.cfc

Version:

2.1

Last updated:

29 June 2005

Requirements:

Mach-II 1.0.10, CFMX 6.1

Usage

Place layoutManager.cfc in the MachII plugins folder. Place this in the plugins section of the Mach-II configuration file (typical usage):

<plugin name="layoutManager" type="MachII.plugins.layoutManager">
	<parameters>
		<parameter name="defaultLayoutEvent" value="layout.main" />
		<parameter name="finalOutputKey" value="request.content.final" />
	</parameters>
</plugin>

In the event-handlers section:

<event-handler event="layout.main" access="private">
	<view-page name="layout.main" contentKey="request.content.final" />
</event-handler>

This will announce layout.main at the end of the event queue. If you need to use a different layout event (such as for popups where you don’t require the normal site layout) set an event argument named layoutEvent to your chosen alternate layout event name. You can also set an event argument named skipLayoutEvent to true if you wish skip the layout altogether (such as when the output is an XML file or an image).

The final content (contained in request.content.final) will be stripped of all unnecessary whitespace. You can disable this by not setting the finalOutputKey parameter and not specifying a content key for the final layout view.

Plugin parameters

Parameter	Data type	Opt.	Default	Description
defaultLayoutEvent	string	No	N/A	Name of event to be announced at the end of the queue
defaultContentType*	string	Yes	text/html; charset=utf-8	Default content type for output
finalOutputKey*	string	Yes	N/A	Name of content key to which the final content is written
optimizeWhitespace*	boolean	Yes	true	Enables/disables whitespace optimisation
preserveWhitespaceTagList*	list of strings	Yes	pre, textarea	List of tags where content is left untouched by whitespace optimisation
defaultDispositionMethod*	string	Yes	attachment	Default disposition method when forcing a download to the browser ("attachment" or "inline")
argumentPrefix	string	Yes	empty string	Prefix for all event arguments used by layoutManager

*These parameters have no effect when the finalOutputKey parameter is omitted.

Event arguments used by layoutManager

Note: Use the argumentPrefix parameter to modify the following argument names. This can be helpful to avoid clashes with other event args such as form and url values. For example, if you set argumentPrefix to "LM_" the following argument names will be LM_layoutEvent, LM_contentType, etc).

Event argument	Data type	Description
disableLayoutManager	boolean	When set to true, disables the plugin for the current request
layoutEvent	string	Overrides the default layout event for the current request
skipLayoutEvent	boolean	When set to true, layoutManager doesn’t announce the layoutEvent (whitespace optimisation and other actions on the final output are still active)
contentType*	string	Overrides the default content type for the current request
optimizeWhitespace*	boolean	Enables/disables whitespace optimisation for the current request
forcedFileName*	string	Pushes the final output as a download and fakes the file name in the "Save as…" dialog
dispositionMethod*	string	Overrides the default disposition method for the current request ("attachment" or "inline")

*These event arguments have no effect when the finalOutputKey parameter is omitted.

Notes

Exceptions

When an exception is thrown and the exception event is announced, layoutManager will still announce the layout event at the end of the queue. If you are using the finalOuputKey method, your exception event has to write content to this content key. If the error was thrown by the layout event, you will get a white screen of death. A possible solution to this would be to add an event mapping in your layout event-handler to redirect all exceptions to an event that disables the layoutManager (using the disableLayoutManager event argument).

CFCONTENT

When using the finalOutputKey method, layoutManager always includes a cfcontent tag just before outputing the content. This means that you shouldn’t use cfcontent elsewhere in your code.

If you have any problems using this plugin don’t hesitate to post comments on this page.

Download layoutManager.cfc