Module com.semanticcms.core.servlet

Package com.semanticcms.core.servlet

Interface Component

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface Component

A component is able to render itself within the page. The theme will call all registered components at the correct stages of page rendering.

Method Summary

Modifier and Type	Method	Description
void	doComponent(ServletContext servletContext, HttpServletRequest request, HttpServletResponse response, DocumentEE document, View view, Page page, ComponentPosition position)	Renders a component in the output stream.

Method Details

doComponent

void doComponent(ServletContext servletContext,
 HttpServletRequest request,
 HttpServletResponse response,
 DocumentEE document,
 View view,
 Page page,
 ComponentPosition position)
          throws ServletException,
IOException

Renders a component in the output stream.

This will be called for each of the component positions as the page is rendered by the theme. A component that does not apply to the given view, page, or position should take no action and return quickly.

Parameters:

view - The view that is currently being rendered. May be null during error handling.

page - The page that is currently being rendered. May be null during error handling.

Throws:

ServletException

IOException