fr.paris.lutece.plugins.forms.web.breadcrumb

Interface IBreadcrumb

All Known Implementing Classes:

HorizontalBreadcrumb, VerticalBreadcrumb

public interface IBreadcrumb

Interface for the entry data services

Method Summary

Modifier and Type	Method and Description
String	getBottomHtml(javax.servlet.http.HttpServletRequest request, FormResponseManager formResponseManager) Gives the HTML displayed after the current step
String	getBreadcrumbBeanName() Gives the bean name of the breadcrumb
String	getBreadcrumbDisplayName() Gives the display name of the breadcrumb
default Map<String,Object>	getModelForCurrentStep(javax.servlet.http.HttpServletRequest request, FormResponseManager formResponseManager) Gives the model to use for the current step
String	getTopHtml(javax.servlet.http.HttpServletRequest request, FormResponseManager formResponseManager) Gives the HTML displayed before the current step

Method Detail

getBreadcrumbBeanName

String getBreadcrumbBeanName()

Gives the bean name of the breadcrumb

Returns:

the Breadcrumb bean name

getBreadcrumbDisplayName

String getBreadcrumbDisplayName()

Gives the display name of the breadcrumb

Returns:

the Breadcrumb display name

getTopHtml

String getTopHtml(javax.servlet.http.HttpServletRequest request,
                  FormResponseManager formResponseManager)

Gives the HTML displayed before the current step

Parameters:

request - the request

formResponseManager - the object that contains the actual visited list of step

Returns:

the HTML displayed before the current step

getModelForCurrentStep

default Map<String,Object> getModelForCurrentStep(javax.servlet.http.HttpServletRequest request,
                                                  FormResponseManager formResponseManager)

Gives the model to use for the current step

Parameters:

request - the request

formResponseManager - the form response manager

Returns:

the model

getBottomHtml

String getBottomHtml(javax.servlet.http.HttpServletRequest request,
                     FormResponseManager formResponseManager)

Gives the HTML displayed after the current step

Parameters:

request - the request

formResponseManager - the object that contains the actual visited list of step

Returns:

the HTML displayed after the current step