|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.wicket.Component org.apache.wicket.MarkupContainer org.apache.wicket.markup.html.WebMarkupContainer org.apache.wicket.markup.html.WebMarkupContainerWithAssociatedMarkup org.apache.wicket.markup.html.panel.Panel org.apache.wicket.velocity.markup.html.VelocityPanel
public abstract class VelocityPanel
Panel that displays the result of rendering a Velocity template. The template itself can be any
IStringResourceStream
implementation, of which there are a number of convenient implementations in the wicket.util
package. The model can be any normal
Map
,
which will be used to create the
VelocityContext
.
Note: Be sure to properly initialize the Velocity engine before using
VelocityPanel
.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.apache.wicket.Component |
---|
Component.ComponentModelChange, Component.EnabledChange, Component.IVisitor, Component.VisibilityChange |
Field Summary |
---|
Fields inherited from class org.apache.wicket.Component |
---|
ENABLE, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PATH_SEPARATOR, RENDER |
Constructor Summary | |
---|---|
VelocityPanel(java.lang.String id,
IModel model)
Construct. |
Method Summary | |
---|---|
protected boolean |
escapeHtml()
Gets whether to escape HTML characters. |
static VelocityPanel |
forTemplateResource(java.lang.String id,
IModel model,
IStringResourceStream templateResource)
Convenience factory method to create a VelocityPanel instance with a given
template resource . |
java.lang.String |
getCacheKey(MarkupContainer container,
java.lang.Class containerClass)
Provide the markup cache key for the associated Markup resource stream. |
IResourceStream |
getMarkupResourceStream(MarkupContainer container,
java.lang.Class containerClass)
Create a new markup resource stream for the container. |
protected abstract IStringResourceStream |
getTemplateResource()
Returns the template resource passed to the constructor. |
protected void |
onComponentTagBody(MarkupStream markupStream,
ComponentTag openTag)
Handle the container's body. |
protected void |
onDetach()
Called to allow a component to detach resources after use. |
protected boolean |
parseGeneratedMarkup()
Gets whether to parse the resulting Wicket markup. |
protected boolean |
throwVelocityExceptions()
Whether any velocity exception should be trapped and displayed on the panel (false) or thrown up to be handled by the exception mechanism of Wicket (true). |
Methods inherited from class org.apache.wicket.markup.html.panel.Panel |
---|
onComponentTag, renderHead |
Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainerWithAssociatedMarkup |
---|
newHeaderPartContainer, renderHeadFromAssociatedMarkupFile |
Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer |
---|
getMarkupType, getWebPage |
Methods inherited from class org.apache.wicket.MarkupContainer |
---|
add, addOrReplace, autoAdd, autoAdd, contains, findMarkupStream, get, getAssociatedMarkupStream, getMarkupStream, hasAssociatedMarkup, internalAdd, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, replace, setMarkupStream, setModel, size, toString, toString, visitChildren, visitChildren |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public VelocityPanel(java.lang.String id, IModel model)
id
- Component idtemplateResource
- The velocity template as a string resourcemodel
- Model with variables that can be substituted by Velocity. Must return a
Map
.Method Detail |
---|
public static VelocityPanel forTemplateResource(java.lang.String id, IModel model, IStringResourceStream templateResource)
VelocityPanel
instance with a given
template resource
.
id
- Component idmodel
- optional model for variable substituation.templateResource
- The template resource
VelocityPanel
protected void onComponentTagBody(MarkupStream markupStream, ComponentTag openTag)
MarkupContainer
onComponentTagBody
in class Panel
markupStream
- The markup streamopenTag
- The open tag for the bodyPanel.onComponentTagBody(org.apache.wicket.markup.MarkupStream,
org.apache.wicket.markup.ComponentTag)
protected boolean escapeHtml()
protected abstract IStringResourceStream getTemplateResource()
protected boolean parseGeneratedMarkup()
protected boolean throwVelocityExceptions()
Trapping these exceptions without disturbing the other components is especially usefull in CMS like applications, where 'normal' users are allowed to do basic scripting. On errors, you want them to be able to have them correct them while the rest of the application keeps on working.
public final IResourceStream getMarkupResourceStream(MarkupContainer container, java.lang.Class containerClass)
IMarkupResourceStreamProvider
Note: usually it will only called once, as the IResourceStream will be cached by MarkupCache.
getMarkupResourceStream
in interface IMarkupResourceStreamProvider
container
- The MarkupContainer which requests to load the Markup resource streamcontainerClass
- The container the markup should be associated with
IMarkupResourceStreamProvider.getMarkupResourceStream(org.apache.wicket.MarkupContainer,
java.lang.Class)
public final java.lang.String getCacheKey(MarkupContainer container, java.lang.Class containerClass)
IMarkupCacheKeyProvider
getCacheKey
in interface IMarkupCacheKeyProvider
container
- The MarkupContainer object requesting the markup cache keycontainerClass
- The container the markup should be associated with
IMarkupCacheKeyProvider.getCacheKey(org.apache.wicket.MarkupContainer,
java.lang.Class)
protected void onDetach()
Component
onDetach
in class Component
Component.onDetach()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |