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.custom.jsvalueset;
20
21 import javax.faces.component.UIOutput;
22
23 import org.apache.myfaces.component.UserRoleUtils;
24
25 /**
26 * Setting a value from the model in java-script so that it can be
27 * used (e.g. by the value change listener) afterwards.
28 *
29 * Unless otherwise specified, all attributes accept static values
30 * or EL expressions.
31 *
32 * @JSFComponent
33 * name = "t:jsValueSet"
34 * class = "org.apache.myfaces.custom.jsvalueset.HtmlJsValueSet"
35 * tagClass = "org.apache.myfaces.custom.jsvalueset.HtmlJsValueSetTag"
36 * @JSFJspProperty name = "id" tagExcluded = "true"
37 * @JSFJspProperty name = "binding" tagExcluded = "true"
38 * @JSFJspProperty name = "rendered" tagExcluded = "true"
39 * @JSFJspProperty name = "converter" tagExcluded = "true"
40 * @since 1.1.7
41 * @author Martin Marinschek (latest modification by $Author: lu4242 $)
42 * @version $Revision: 691856 $ $Date: 2008-09-03 21:40:30 -0500 (Wed, 03 Sep 2008) $
43 */
44 public abstract class AbstractHtmlJsValueSet extends UIOutput
45 {
46
47 public static final String COMPONENT_TYPE = "org.apache.myfaces.HtmlJsValueSet";
48 public static final String COMPONENT_FAMILY = "javax.faces.Output";
49 private static final String DEFAULT_RENDERER_TYPE = "org.apache.myfaces.JsValueSet";
50
51 /**
52 * javascript variable to be set.
53 *
54 * @JSFProperty
55 * required="true"
56 */
57 public abstract String getName();
58
59 public boolean isRendered()
60 {
61 if (!UserRoleUtils.isVisibleOnUserRole(this)) return false;
62 return super.isRendered();
63 }
64
65 /**
66 * value to be set in the variable.
67 *
68 * @JSFProperty
69 * required="true"
70 */
71 public Object getValue()
72 {
73 return super.getValue();
74 }
75
76 }
77
78