org.apache.myfaces.extensions.cdi.jsf.api.config.view
Annotation Type Page


@Stereotype
@Target(value=TYPE)
@Retention(value=RUNTIME)
@Documented
public @interface Page

Stereotype for marking a class as page for type-safe view-configs.


Optional Element Summary
 String basePath
          Allows to specify a custom base-path for the page represented by the view-conig
 String extension
          Allows to specify the (file-)extension for the page represented by the view-conig
 String name
          Allows to specify a custom (file-)name for the page represented by the view-conig
 Page.NavigationMode navigation
          Allows to specify navigation-mode which should be used to navigate to the page represented by the view-config
 Page.ViewParameterMode viewParams
          for including view params in jsf2
 

basePath

public abstract String basePath
Allows to specify a custom base-path for the page represented by the view-conig

Returns:
base-path
Default:
"."

name

public abstract String name
Allows to specify a custom (file-)name for the page represented by the view-conig

Returns:
name of the page
Default:
""

extension

public abstract String extension
Allows to specify the (file-)extension for the page represented by the view-conig

Returns:
extension of the page
Default:
"xhtml"

navigation

public abstract Page.NavigationMode navigation
Allows to specify navigation-mode which should be used to navigate to the page represented by the view-config

Returns:
navigation-mode which should be used to navigate to the page represented by the view-config
Default:
org.apache.myfaces.extensions.cdi.jsf.api.config.view.Page.NavigationMode.DEFAULT

viewParams

public abstract Page.ViewParameterMode viewParams
for including view params in jsf2

Returns:
the strategy which should be used by jsf2 for handling view-parameters (for the navigation)
Default:
org.apache.myfaces.extensions.cdi.jsf.api.config.view.Page.ViewParameterMode.DEFAULT


Copyright © 2010-2012 The Apache Software Foundation. All Rights Reserved.