Module org.omnifaces
Package org.omnifaces.component.output

Class PathParam<T>

  • Type Parameters:
    T - The type of the value.
    All Implemented Interfaces:
    PartialStateHolder, StateHolder, TransientStateHolder, ValueHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder, EventListener, ParamHolder<T>
    public class PathParam<T>
extends Param<T>
    The <o:pathParam> is a component that extends the OmniFaces Param to support MultiViews feature of FacesViews. It is done by rendering the supplied parameters of such components as <h:link> and <h:button> among others as path parameters and not as query parameters as otherwise will be produced by <o:param> and <f:param> tags.

    The component has built-in support for a Converter to convert the supplied value to string by usual means via the converter attribute of the tag, or the nested <f:converter> tag, or just automatically if a converter is already registered for the target class via @FacesConverter(forClass).

    This component doesn't support returning encoded output of its children as parameter value in case no value is present. This feature is provided by Param component instead.

    Also, the name attribute must not be specified for this component as it already evaluates to a predefined one.

    This component is used to create bookmarkable URLs via standard outcome target components that take into account <o:pathParam> tags nested in the components. The path parameters will be rendered in the order they were declared for a view id that is defined as a multi view and if the view was not defined as a multi view then they won't be rendered at all. Additionally, declaring path parameters for a non-multi view will be logged as a warning and a faces warning message will be added for any stage different from Production.

    In the following example the link to the multi view page will be rendered with two path parameters: 

     <h:link value="Link" outcome="multiview-supported-path">
     <o:pathParam value="first" />
     <o:pathParam value="second" />
 </h:link>
    The code above will be rendered as: <a id="..." name="..." href="/context-path/multiview-supported-path/first/second">Link</a>. The path parameters will be available via @Inject @Param(pathIndex=0) private String first; and @Inject @Param(pathIndex=1) private String second; the usual way.
    Since:
    3.6
    Author:
    Sergey Kuntsel
    See Also:
    FacesViews, FacesViewsViewHandler.getBookmarkableURL(FacesContext, String, java.util.Map, boolean)