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;
20  
21  /**
22   * Behavioral interface.
23   * By default, displayValueOnly is false, and the components have the default behaviour.
24   * When displayValueOnly is true, the renderer should not render any input widget.
25   * Only the text corresponding to the component's value should be rendered instead.
26   * 
27   * org.apache.myfaces.shared_tomahawk.component.DisplayValueOnlyCapable 
28   * are available on shared, but we need something on tomahawk
29   * to define and generate properties.
30   * 
31   * @since 1.1.7
32   * @author Leonardo Uribe (latest modification by $Author: lu4242 $)
33   * @version $Revision: 691856 $ $Date: 2008-09-03 21:40:30 -0500 (Wed, 03 Sep 2008) $
34   *
35   */
36  public interface DisplayValueOnlyAware
37  {
38      /**
39       *  If true, renders only the value of the component, 
40       *  but no input widget. Default is false.
41       * 
42       * @JSFProperty
43       */
44      public Boolean getDisplayValueOnly();
45  
46      public void setDisplayValueOnly(Boolean b);
47      
48      /**
49       * Style used when displayValueOnly is true.
50       * 
51       * @JSFProperty
52       */
53      public String getDisplayValueOnlyStyle();
54      
55      public void setDisplayValueOnlyStyle(String displayValueOnlyStyle);
56      
57      /**
58       * Style class used when displayValueOnly is true.
59       * 
60       * @JSFProperty
61       */
62      public String getDisplayValueOnlyStyleClass();
63      
64      public void setDisplayValueOnlyStyleClass(String displayValueOnlyStyleClass);    
65      
66  }