com.sun.rave.designtime.markup
Interface MarkupRenderContext

public interface MarkupRenderContext

A MarkupRenderContext represents the context in which a markup bean will be rendering its markup output. This is a call-back interface used in the MarkupDesignInfo.customizeRender(...) method. A component (bean) author can use the methods in this interface to alter the markup stream that will be displayed on the design surface. They can also associate custom behavior with portions of markup using the associateMouseRegion(...) method.

IMPLEMENTED BY CREATOR - This interface is implemented by Creator for use by the component (bean) author.

Version:

1.0

Author:

Joe Nuxoll

See Also:

MarkupDesignInfo.customizeRender(MarkupDesignBean, MarkupRenderContext)

Method Summary

void	associateMouseRegion(org.w3c.dom.Element element, MarkupMouseRegion region) Associates a mouse region with a particular element of rendered markup.
MarkupPosition	getBeginPosition() The starting position within the renderFragment from where nodes were rendered for this component.
org.w3c.dom.DocumentFragment	getDocumentFragment() The 'rendered' DOM document fragment from the JSF component.
MarkupPosition	getEndPosition() The ending position within the renderFragment to which nodes were rendered for this component.

Method Detail

associateMouseRegion

public void associateMouseRegion(org.w3c.dom.Element element,
                                 MarkupMouseRegion region)

Associates a mouse region with a particular element of rendered markup.

Parameters:

element - Element

region - MarkupMouseRegion

getBeginPosition

public MarkupPosition getBeginPosition()

The starting position within the renderFragment from where nodes were rendered for this component.

getDocumentFragment

public org.w3c.dom.DocumentFragment getDocumentFragment()

The 'rendered' DOM document fragment from the JSF component.

getEndPosition

public MarkupPosition getEndPosition()

The ending position within the renderFragment to which nodes were rendered for this component. If this position is the same as begin, no nodes were rendered for the component. Note that the end position is NOT inclusive, it points to the NEXT node in the node list. Note also that the parent node for begin and end will always be the same.