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  
20  
21  package org.apache.myfaces.custom.dojo;
22  
23  /**
24   * Basic dojo interface
25   * which has to implement
26   * certain methods regarding the dojo widgets
27   * 
28   * for now the interfaces are very limited and only 
29   * have to implement the variable binding properties
30   * 
31   * 
32   * @author werpu
33   *
34   */
35  public interface DojoWidget {
36      /**
37       * getter for an explizit widget
38       * var
39       * @return
40       */
41      public String getWidgetVar();
42      
43      /**
44       * 
45       * @param widgetVar
46       */
47      public void setWidgetVar(String widgetVar);
48    
49      
50      /**
51       * forces the internal widget id onto the given value
52       * 
53       * @param forceIt
54       */
55      public void setWidgetId(String widgetId);
56      
57      /**
58       * 
59       * @return the enforced widgetid
60       */
61      public String getWidgetId();
62  }