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  package org.apache.myfaces.custom.dojolayouts;
21  
22  import javax.faces.component.UIOutput;
23  
24  import org.apache.myfaces.component.StyleAware;
25  import org.apache.myfaces.custom.dojo.DojoWidget;
26  
27  /**
28   * Base content pane for the dojo layouts
29   * 
30   * jsfed dojo content pane
31   * 
32   * @see http://www.dojotoolkit.org for further references to this control and
33   *      its parameters
34   * 
35   * @JSFComponent
36   *   name = "s:layoutingContentPane"
37   *   class = "org.apache.myfaces.custom.dojolayouts.DojoContentPane"
38   *   tagClass = "org.apache.myfaces.custom.dojolayouts.DojoContentPaneTag"
39   *   
40   * @author werpu
41   * 
42   */
43  public abstract class AbstractDojoContentPane extends UIOutput 
44      implements DojoWidget, StyleAware 
45  {
46  
47      public static final String COMPONENT_FAMILY = "javax.faces.Output";
48  
49      public static final String COMPONENT_TYPE   = "org.apache.myfaces.DojoContentPane";
50  
51      public static final String DEFAULT_RENDERER_TYPE    = "org.apache.myfaces.DojoContentPaneRenderer";
52  
53      /**
54       * Path adjustment as defined by dojo
55       * 
56       * @JSFProperty
57       */
58      public abstract Boolean getAdjustPaths();
59  
60      /**
61       * @JSFProperty
62       */
63      public abstract Boolean getCacheContent();
64  
65      /**
66       * If true scripts will be evaled after rendering
67       * 
68       * @JSFProperty
69       */
70      public abstract Boolean getExecuteScripts();
71  
72      /**
73       * Defined by dojo, see the examples
74       * 
75       * @JSFProperty
76       */
77      public abstract Boolean getExtractContent();
78  
79      public String getFamily() {
80          return COMPONENT_FAMILY;
81      }
82  
83      /**
84       * Javascript function which should generate the content
85       * 
86       * @JSFProperty
87       */
88      public abstract String getHandler();
89  
90      /**
91       * Remote href for iframe simulation
92       * 
93       * @JSFProperty
94       */
95      public abstract String getHref();
96  
97      /**
98       * Layoutalignment usable in conjunction with a layout container
99       * 
100      * @JSFProperty
101      */
102     public abstract String getLayoutAlign();
103 
104     /**
105      * Defined by dojo see the examples
106      * 
107      * @JSFProperty
108      */
109     public abstract Boolean getParseContent();
110 
111     /**
112      * Content Preloading
113      * 
114      * @JSFProperty
115      */
116     public abstract Boolean getPreload();
117 
118     /**
119      * Description for the attribute
120      * 
121      * @JSFProperty
122      */
123     public abstract Boolean getRefreshOnShow();
124 
125     /**
126      * Size share value describing the place the content pane wants from its parent
127      * 
128      * @JSFProperty
129      */
130     public abstract Integer getSizeShare();
131 
132     /**
133      * The CSS class for this element. Corresponds to the HTML 'class' attribute.
134      * 
135      * @JSFProperty
136      */
137     public abstract String getStyle();
138 
139     /**
140      * The CSS class for this element. Corresponds to the HTML 'class' attribute.
141      * 
142      * @JSFProperty
143      */
144     public abstract String getStyleClass();
145 
146     /**
147      * Optional enforced dojo widgetId
148      * 
149      * @JSFProperty
150      */
151     public abstract String getWidgetId();
152 
153     /**
154      * optional widget var name, if this is not used only an autogenerated value 
155      * is set
156      * 
157      * @JSFProperty
158      */
159     public abstract String getWidgetVar();
160 
161     /**
162      * Scopecontainer for downloaded Scripts
163      * 
164      * @JSFProperty
165      */
166     public abstract String getScriptScope();
167 }