NAME

Jifty::Plugin::Halo - Provides halos

DESCRIPTION

This plugin provides <http://seaside.st|Seaside>-esque halos for your application. It's included by default when using Jifty with DevelMode turned on.

init

Only enable halos in DevelMode. Add our instrumentation to Template::Declare.

find_halo_plugins

Finds plugins which have "halo_pre_template" or "halo_post_template" methods, and adds them as callbacks in the requisite places.

around_template

This is called to instrument Template::Declare templates. We also draw a halo around the template itself.

halo_header frame -> string

This will give you the halo header which includes links to the various information displays for this template.

halo_footer frame -> string

This will give you the halo footer which includes the actual information to be displayed when the user pokes the halo.

new_frame -> hashref

Gives you a new frame for storing halo information.

push_frame -> frame

Creates and pushes a frame onto the render stack. Mason's halos do not support arounding a component, so we fake it with an explicit stack.

This also triggers "halo_pre_template" for plugins adding halo data.

pop_frame -> frame

Pops a frame off the render stack. Mason's halos do not support "arounding" a component, so we fake it with an explicit stack.

This also triggers "halo_post_template" for plugins adding halo data.

body_start

Called once the "<body>" element has been opened; enables halos on templates.

body_end

Called just before the "<body>" element is closed; renders the halo component tree using "render_component_tree".

render_component_tree

Once we're just about to finish rendering our HTML page (just before the "</body"> tag, we should call render_component_tree to output all the halo data and metadata.