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   * PanelGroup which supports a partialTriggers Attribute similar to the one in Trinidad
29   * 
30   * @JSFComponent
31   *   name = "s:layoutingSplitPane"
32   *   class = "org.apache.myfaces.custom.dojolayouts.DojoSplitPane"
33   *   tagClass = "org.apache.myfaces.custom.dojolayouts.DojoSplitPaneTag"
34   *   
35   *
36   */
37  public abstract class AbstractDojoSplitPane extends UIOutput 
38  implements DojoWidget, StyleAware{
39  
40      public static final String COMPONENT_TYPE        = "org.apache.myfaces.DojoSplitPane";
41  
42      public static final String COMPONENT_FAMILY      = "javax.faces.Output";
43  
44      public static final String DEFAULT_RENDERER_TYPE = "org.apache.myfaces.DojoSplitPaneRenderer";
45  
46       /**
47        * Optional enforced dojo widgetId
48        * 
49        * @JSFProperty
50        */
51      public abstract String getWidgetId();
52  
53      /**
54       *  optional widget var name, if this is not used only an autogenerated value is set
55       * 
56       * @JSFProperty
57       */
58      public abstract java.lang.String getWidgetVar();
59  
60      /**
61       * horizontal or vertical
62       * 
63       * @JSFProperty
64       */
65      public abstract String getOrientation();
66  
67      /**
68       * width of the sizer bar
69       * 
70       * @JSFProperty
71       */
72      public abstract Integer getSizerWidth();
73  
74      /**
75       * Size share value describing the place the content pane wants from its parent
76       * 
77       * @JSFProperty
78       */
79      public abstract Integer getActiveSizing();
80  
81      /**
82       * If true, cookie persisting of the split pane is enabled
83       * 
84       * @JSFProperty
85       */
86      public abstract Boolean getPersist();
87  
88      /**
89       * Last point of the split pane
90       * 
91       * @JSFProperty
92       */
93      public abstract Integer getLastPoint();
94  
95      /**
96       * Starting Point of the split pane as defined by dojo
97       * 
98       * @JSFProperty
99       */
100     public abstract Integer getStartPoint();
101     
102     /**
103      * The CSS class for this element. Corresponds to the HTML 'class' attribute.
104      * 
105      * @JSFProperty
106      */
107     public abstract String getStyle();
108 
109     /**
110      *  The CSS class for this element. Corresponds to the HTML 'class' attribute.
111      *  
112      * @JSFProperty
113      */
114     public abstract String getStyleClass();
115     
116     /**
117      * Size share value describing the place the content pane wants from its parent
118      * 
119      * @JSFProperty
120      */
121     public abstract Integer getSizeShare();
122     
123 }