|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RenderingPluginModel
The PluginModel provides the RenderingPlugin with all the context information necessary to render its output.
Method Summary | |
---|---|
java.lang.String |
getBody()
Return the body of the plugin tag. |
java.lang.String |
getBody(RenderingContext p_renderingContext)
Return the body of the plugin tag in a given context. |
java.util.Locale |
getLocale()
Get the locale to render in for the current user. |
java.util.Map<java.lang.String,java.util.List<java.lang.String>> |
getPluginParameters()
The parameters are return as a Map, where the key is a String containing the parameter name and the value is a List of Strings for the values. |
RenderingContext |
getRenderingContext()
|
javax.servlet.ServletRequest |
getRequest()
Returns the underlying request that triggered the plugin render method |
java.io.Writer |
getWriter()
|
Method Detail |
---|
java.io.Writer getWriter()
RenderingContext getRenderingContext()
java.util.Map<java.lang.String,java.util.List<java.lang.String>> getPluginParameters()
java.util.Locale getLocale()
javax.servlet.ServletRequest getRequest()
java.lang.String getBody()
When used within a List Presentation Component, Menu, Navigator, Personalization or Search Component,
in order for the result design for the body to include the current result values, the RenderingPlugin tag must include the
parameter "compute" with value "always" so that it is recomputed for each result. Otherwise the
rendering plugin will be called once without any active result value.
Note: When rendering the body through the plugin, it is recommended
that the plugin return false from the render()
method to avoid rendering the body
twice.
java.lang.String getBody(RenderingContext p_renderingContext)
#render()
method to avoid rendering the body
twice.
p_renderingContext
- rendering context to render tag body
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |