Class ViewMetadata
ViewMetadata
is
reponsible for extracting and providing view parameter metadata from
VDL views. Because ViewDeclarationLanguage.getViewMetadata(javax.faces.context.FacesContext, java.lang.String)
is required to return null
for JSP views and
non-null
for views authored in Facelets for JSF 2, this
specification only applys to Facelets for JSF 2. - Since:
- 2.0
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionabstract UIViewRoot
createMetadataView
(FacesContext context) Creates a newUIViewRoot
containing only view parameter metadata.static Collection<UIViewAction>
getViewActions
(UIViewRoot root) Utility method to extract view metadata from the providedUIViewRoot
.abstract String
static Collection<UIViewParameter>
getViewParameters
(UIViewRoot root) Utility method to extract view metadata from the providedUIViewRoot
.static boolean
hasMetadata
(UIViewRoot root) Utility method to determine if the the providedUIViewRoot
has metadata.
-
Constructor Details
-
ViewMetadata
public ViewMetadata()
-
-
Method Details
-
getViewId
- Returns:
- the view ID for which this
ViewMetadata
instance was created
-
createMetadataView
Creates a new
UIViewRoot
containing only view parameter metadata. The processing of building thisUIViewRoot
with metadata should not cause any events to be published to the application. The implementation must callFacesContext.setProcessingEvents(boolean)
passingfalse
as the argument, at the beginning of the method, and passtrue
to the same method at the end. The implementation must ensure that this happens regardless of ant exceptions that may be thrown.- Parameters:
context
- theFacesContext
for the current request- Returns:
- a
UIViewRoot
containing only view parameter metadata (if any)
-
getViewParameters
Utility method to extract view metadata from the provided
UIViewRoot
.- Parameters:
root
- theUIViewRoot
from which the metadata will be extracted.- Returns:
- a
Collection
ofUIViewParameter
instances. If the view has no metadata, the collection will be empty.
-
getViewActions
Utility method to extract view metadata from the provided
UIViewRoot
.- Parameters:
root
- theUIViewRoot
from which the metadata will be extracted.- Returns:
- a
Collection
ofUIViewAction
instances. If the view has no metadata, the collection will be empty.
-
hasMetadata
Utility method to determine if the the provided
UIViewRoot
has metadata. The default implementation will return true if the providedUIViewRoot
has a facet namedUIViewRoot.METADATA_FACET_NAME
and that facet has children. It will return false otherwise.- Parameters:
root
- theUIViewRoot
from which the metadata will be extracted from- Returns:
- true if the view has metadata, false otherwise.
-