View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.myfaces.commons.outputClientId;
20  
21  import java.io.IOException;
22  
23  import javax.faces.component.UIComponent;
24  import javax.faces.component.UIComponentBase;
25  import javax.faces.context.FacesContext;
26  
27  import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFComponent;
28  import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFProperty;
29  
30  /**
31   * Output the clientId of a component specified by for property.
32   * 
33   * @author Leonardo Uribe
34   * @since 1.0.1
35   */
36  @JSFComponent(
37          name = "mc:outputClientId",
38          clazz = "org.apache.myfaces.commons.outputClientId.OutputClientId",
39          tagClass = "org.apache.myfaces.commons.outputClientId.OutputClientIdTag")
40  public abstract class AbstractOutputClientId extends UIComponentBase
41  {
42      public static final String COMPONENT_FAMILY = "javax.faces.Output";
43      public static final String COMPONENT_TYPE = "org.apache.myfaces.commons.OutputClientId";
44  
45      /**
46       * The ID of the component that should be rendered.
47       * 
48       * @return
49       */
50      @JSFProperty
51      public abstract String getFor();
52  
53      @Override
54      public void encodeBegin(FacesContext context) throws IOException
55      {
56          super.encodeBegin(context);
57  
58          String forId = getFor();
59          UIComponent referencedComponent = null;
60  
61          if (forId == null)
62          {
63              referencedComponent = getParent();
64          }
65          else
66          {
67              referencedComponent = this.findComponent(forId);
68          }
69  
70          if (referencedComponent == null)
71          {
72              throw new IllegalStateException("No component found for id : "
73                      + forId);
74          }
75  
76          context.getResponseWriter().write(
77                  referencedComponent.getClientId(context));
78      }
79  }