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.component.html.ext;
20  
21  import javax.faces.context.FacesContext;
22  
23  import org.apache.myfaces.component.ForceIdAware;
24  import org.apache.myfaces.component.UserRoleAware;
25  import org.apache.myfaces.component.UserRoleUtils;
26  import org.apache.myfaces.component.html.util.HtmlComponentUtils;
27  
28  /**
29   * Extends standard commandButton by user role support. 
30   * 
31   * Unless otherwise specified, all attributes accept static values or EL expressions.
32   * 
33   * @JSFComponent
34   *   name = "t:commandButton"
35   *   class = "org.apache.myfaces.component.html.ext.HtmlCommandButton"
36   *   tagClass = "org.apache.myfaces.generated.taglib.html.ext.HtmlCommandButtonTag"
37   * @since 1.1.7
38   * @author Manfred Geiler (latest modification by $Author: lu4242 $)
39   * @version $Revision: 691856 $ $Date: 2008-09-03 21:40:30 -0500 (Wed, 03 Sep 2008) $
40   */
41  public abstract class AbstractHtmlCommandButton
42          extends javax.faces.component.html.HtmlCommandButton
43          implements UserRoleAware, ForceIdAware
44  {
45  
46      public static final String COMPONENT_TYPE = "org.apache.myfaces.HtmlCommandButton";
47      public static final String DEFAULT_RENDERER_TYPE = "org.apache.myfaces.Button";
48  
49      public String getClientId(FacesContext context)
50      {
51          String clientId = HtmlComponentUtils.getClientId(this, getRenderer(context), context);
52          if (clientId == null)
53          {
54              clientId = super.getClientId(context);
55          }
56  
57          return clientId;
58      }
59      
60      public boolean isRendered()
61      {
62          if (!UserRoleUtils.isVisibleOnUserRole(this)) return false;
63          return super.isRendered();
64      }
65  
66      /**
67       *  Comma separated list of subForm-ids for which validation 
68       *  and model update should take place when this command is 
69       *  executed. You need to wrap your input components in 
70       *  org.apache.myfaces.custom.subform.SubForm instances for 
71       *  this to work.
72       *  
73       * @JSFProperty
74       */
75      public abstract String getActionFor();
76      
77  }