org.apache.deltaspike.jsf.api.config.view

Annotation Type View

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
 @ViewMetaData(preProcessor=View.ViewConfigPreProcessor.class)
public @interface View

Optional annotation to specify page specific meta-data

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	basePath Allows to specify a custom base-path for the page represented by the view-config
Class<? extends View.NameBuilder>	basePathBuilder Allows to add a custom inline path-builder (a custom default implementation can be configured globally via the config mechanism provided by DeltaSpike)
String	extension Allows to specify the (file-)extension for the page represented by the view-config
Class<? extends View.NameBuilder>	extensionBuilder Allows to add a custom inline path-builder (a custom default implementation can be configured globally via the config mechanism provided by DeltaSpike)
Class<? extends View.NameBuilder>	fileNameBuilder Allows to add a custom inline path-builder (a custom default implementation can be configured globally via the config mechanism provided by DeltaSpike)
String	name Allows to specify a custom (file-)name for the page represented by the view-config
View.NavigationMode	navigation Allows to specify navigation-mode which should be used to navigate to the page represented by the view-config
View.ViewParameterMode	viewParams for including view params in jsf2

Element Detail

basePath

@SkipMetaDataMerge
public abstract String basePath

Allows to specify a custom base-path for the page represented by the view-config

Returns:

base-path

Default:

""

name

@SkipMetaDataMerge
public abstract String name

Allows to specify a custom (file-)name for the page represented by the view-config

Returns:

name of the page

Default:

""

extension

public abstract String extension

Allows to specify the (file-)extension for the page represented by the view-config

Returns:

extension of the page

Default:

""

navigation

public abstract View.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.deltaspike.jsf.api.config.view.View.NavigationMode.DEFAULT

viewParams

public abstract View.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.deltaspike.jsf.api.config.view.View.ViewParameterMode.DEFAULT

basePathBuilder

public abstract Class<? extends View.NameBuilder> basePathBuilder

Allows to add a custom inline path-builder (a custom default implementation can be configured globally via the config mechanism provided by DeltaSpike)

Returns:

path builder which allows to customize the naming conventions for the base-path

Default:

org.apache.deltaspike.jsf.api.config.view.View.DefaultBasePathBuilder.class

fileNameBuilder

public abstract Class<? extends View.NameBuilder> fileNameBuilder

Allows to add a custom inline path-builder (a custom default implementation can be configured globally via the config mechanism provided by DeltaSpike)

Returns:

path builder which allows to customize the naming conventions for the file-name

Default:

org.apache.deltaspike.jsf.api.config.view.View.DefaultFileNameBuilder.class

extensionBuilder

public abstract Class<? extends View.NameBuilder> extensionBuilder

Allows to add a custom inline path-builder (a custom default implementation can be configured globally via the config mechanism provided by DeltaSpike)

Returns:

path builder which allows to customize the naming conventions for the file-extension

Default:

org.apache.deltaspike.jsf.api.config.view.View.DefaultExtensionBuilder.class