Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
   *
   * Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
   *
   * The contents of this file are subject to the terms of either the GNU
   * General Public License Version 2 only ("GPL") or the Common Development
   * and Distribution License("CDDL") (collectively, the "License").  You
   * may not use this file except in compliance with the License.  You can
  * obtain a copy of the License at
  * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
  * or packager/legal/LICENSE.txt.  See the License for the specific
  * language governing permissions and limitations under the License.
  *
  * When distributing the software, include this License Header Notice in each
  * file and include the License file at packager/legal/LICENSE.txt.
  *
  * GPL Classpath Exception:
  * Oracle designates this particular file as subject to the "Classpath"
  * exception as provided by Oracle in the GPL Version 2 section of the License
  * file that accompanied this code.
  *
  * Modifications:
  * If applicable, add the following below the License Header, with the fields
  * enclosed by brackets [] replaced by your own identifying information:
  * "Portions Copyright [year] [name of copyright owner]"
  *
  * Contributor(s):
  * If you wish your version of this file to be governed by only the CDDL or
  * only the GPL Version 2, indicate your decision by adding "[Contributor]
  * elects to include this software in this distribution under the [CDDL or GPL
  * Version 2] license."  If you don't indicate a single choice of license, a
  * recipient has the option to distribute your version of this file under
  * either the CDDL, the GPL Version 2 or to extend the choice of license to
  * its licensees as provided above.  However, if you add GPL Version 2 code
  * and therefore, elected the GPL Version 2 license, then the option applies
  * only if the new code is made subject to such option by the copyright
  * holder.
  */
 
 package javax.faces.view;
 
 import java.util.List;

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
 
 public abstract class ViewMetadata {


    

Returns:
the view ID for which this ViewMetadata instance was created
 
     public abstract String getViewId();


    

Creates a new javax.faces.component.UIViewRoot containing only view parameter metadata. The processing of building this UIViewRoot with metadata should not cause any events to be published to the application. The implementation must call javax.faces.context.FacesContext.setProcessingEvents(boolean) passing false as the argument, at the beginning of the method, and pass true to the same method at the end. The implementation must ensure that this happens regardless of ant exceptions that may be thrown.

Parameters:
context the javax.faces.context.FacesContext for the current request
Returns:
a UIViewRoot containing only view parameter metadata (if any)
 
     public abstract UIViewRoot createMetadataView(FacesContext context);


    

Utility method to extract view metadata from the provided javax.faces.component.UIViewRoot.

Parameters:
root the javax.faces.component.UIViewRoot from which the metadata will be extracted from
Returns:
a Collection of javax.faces.component.UIViewParameter instances. If the view has no metadata, the collection will be empty.
    public static Collection<UIViewParametergetViewParameters(UIViewRoot root) {
        Collection<UIViewParameterparams;
        UIComponent metadataFacet = root.getFacet(.);
        if (metadataFacet == null) {
            params = Collections.emptyList();
        } else {
            params = new ArrayList<UIViewParameter>();
            List<UIComponentchildren = metadataFacet.getChildren();
            int len = children.size();
            for (int i = 0; i < leni++) {
                UIComponent c = children.get(i);
                if (c instanceof UIViewParameter) {
                    params.add((UIViewParameterc);
                }
            }
        }
        return params;
    }
New to GrepCode? Check out our FAQ X