View Javadoc

1   package org.apache.myfaces.tobago.taglib.decl;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one or more
5    * contributor license agreements.  See the NOTICE file distributed with
6    * this work for additional information regarding copyright ownership.
7    * The ASF licenses this file to You under the Apache License, Version 2.0
8    * (the "License"); you may not use this file except in compliance with
9    * the License.  You may obtain a copy of the License at
10   *
11   *      http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing, software
14   * distributed under the License is distributed on an "AS IS" BASIS,
15   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   * See the License for the specific language governing permissions and
17   * limitations under the License.
18   */
19  
20  import org.apache.myfaces.tobago.apt.annotation.UIComponentTagAttribute;
21  
22  public interface IsGridLayoutComponent {
23  
24    /**
25     * @param columnSpan The number of horizontal cells this component should use.
26     */
27    @UIComponentTagAttribute(type = "java.lang.Integer", defaultValue = "1")
28    void setColumnSpan(String columnSpan);
29  
30    /**
31     * @param rowSpan The number of vertical cells this component should use.
32     */
33    @UIComponentTagAttribute(type = "java.lang.Integer", defaultValue = "1")
34    void setRowSpan(String rowSpan);
35  
36    /**
37     * This value will usually be set by the layout manager.
38     *
39     * @param width The width for this component.
40     */
41    @UIComponentTagAttribute(type = "org.apache.myfaces.tobago.layout.Measure",
42        defaultCode = "((org.apache.myfaces.tobago.renderkit.LayoutComponentRenderer)\n"
43            + "      getRenderer(getFacesContext())).getWidth(getFacesContext(), this)")
44    void setWidth(String width);
45  
46    /**
47     * This value will usually be set by the layout manager.
48     *
49     * @param height The height for this component.
50     */
51    @UIComponentTagAttribute(type = "org.apache.myfaces.tobago.layout.Measure",
52        defaultCode = "((org.apache.myfaces.tobago.renderkit.LayoutComponentRenderer)\n"
53            + "      getRenderer(getFacesContext())).getHeight(getFacesContext(), this)")
54    void setHeight(String height);
55  
56    /**
57     * @param minimumWidth The minimum width for this component.
58     */
59    @UIComponentTagAttribute(type = "org.apache.myfaces.tobago.layout.Measure",
60        defaultCode = "((org.apache.myfaces.tobago.renderkit.LayoutComponentRenderer)\n"
61            + "      getRenderer(getFacesContext())).getMinimumWidth(getFacesContext(), this)")
62    void setMinimumWidth(String minimumWidth);
63  
64    /**
65     * @param minimumHeight The minimum height for this component.
66     */
67    @UIComponentTagAttribute(type = "org.apache.myfaces.tobago.layout.Measure",
68        defaultCode = "((org.apache.myfaces.tobago.renderkit.LayoutComponentRenderer)\n"
69            + "getRenderer(getFacesContext())).getMinimumHeight(getFacesContext(), this)")
70    void setMinimumHeight(String minimumHeight);
71  
72    /**
73     * @param preferredWidth The preferred width for this component.
74     */
75    @UIComponentTagAttribute(type = "org.apache.myfaces.tobago.layout.Measure",
76        defaultCode = "((org.apache.myfaces.tobago.renderkit.LayoutComponentRenderer)\n"
77            + "getRenderer(getFacesContext())).getPreferredWidth(getFacesContext(), this)")
78    void setPreferredWidth(String preferredWidth);
79  
80    /**
81     * @param preferredHeight The preferred height for this component.
82     */
83    @UIComponentTagAttribute(type = "org.apache.myfaces.tobago.layout.Measure",
84        defaultCode = "((org.apache.myfaces.tobago.renderkit.LayoutComponentRenderer)\n"
85            + "getRenderer(getFacesContext())).getPreferredHeight(getFacesContext(), this)")
86    void setPreferredHeight(String preferredHeight);
87  
88    /**
89     * @param maximumWidth The maximum width for this component.
90     */
91    @UIComponentTagAttribute(type = "org.apache.myfaces.tobago.layout.Measure",
92        defaultCode = "((org.apache.myfaces.tobago.renderkit.LayoutComponentRenderer)\n"
93            + "getRenderer(getFacesContext())).getMaximumWidth(getFacesContext(), this)")
94    void setMaximumWidth(String maximumWidth);
95  
96    /**
97     * @param maximumHeight The maximum height for this component.
98     */
99    @UIComponentTagAttribute(type = "org.apache.myfaces.tobago.layout.Measure",
100       defaultCode = "((org.apache.myfaces.tobago.renderkit.LayoutComponentRenderer)\n"
101           + "getRenderer(getFacesContext())).getMaximumHeight(getFacesContext(), this)")
102   void setMaximumHeight(String maximumHeight);
103 
104   /**
105    * This value will usually be set by the layout manager.
106    *
107    * @param left The left position value for this component.
108    */
109   @UIComponentTagAttribute(type = "org.apache.myfaces.tobago.layout.Measure")
110   void setLeft(String left);
111 
112   /**
113    * This value will usually be set by the layout manager.
114    *
115    * @param top The top position value for this component.
116    */
117   @UIComponentTagAttribute(type = "org.apache.myfaces.tobago.layout.Measure")
118   void setTop(String top);
119 
120   /**
121    * This attribute is for internal use only.
122    *
123    * @param horizontalIndex The index of the component inside its container grid in horizontal direction.
124    */
125   @UIComponentTagAttribute(type = "java.lang.Integer")
126   void setHorizontalIndex(String horizontalIndex);
127 
128   /**
129    * This attribute is for internal use only.
130    *
131    * @param verticalIndex The index of the component inside its container grid in vertical direction.
132    */
133   @UIComponentTagAttribute(type = "java.lang.Integer")
134   void setVerticalIndex(String verticalIndex);
135 
136   /**
137    * This attribute is for internal use only.
138    *
139    * @param display Indicates the renderer to render the element as block or inline.
140    */
141   @UIComponentTagAttribute(type = "org.apache.myfaces.tobago.layout.Display")
142   void setDisplay(String display);
143 
144   /**
145    * This attribute is for internal use only.
146    * TODO: this attribute es for containers only
147    *
148    * @param leftOffset The left offset which is needed by some containers (e. g. a box).
149    */
150   @UIComponentTagAttribute(
151       type = "org.apache.myfaces.tobago.layout.Measure",
152       defaultCode = "org.apache.myfaces.tobago.config.ThemeConfig.getMeasure("
153           + "getFacesContext(), this, \"leftOffset\")")
154   void setLeftOffset(String leftOffset);
155 
156   /**
157    * This attribute is for internal use only.
158    * TODO: this attribute es for containers only
159    *
160    * @param rightOffset The right offset which is needed by some containers (e. g. a box).
161    */
162   @UIComponentTagAttribute(type = "org.apache.myfaces.tobago.layout.Measure",
163       defaultCode = "org.apache.myfaces.tobago.config.ThemeConfig.getMeasure("
164           + "getFacesContext(), this, \"rightOffset\")")
165   void setRightOffset(String rightOffset);
166 
167   /**
168    * This attribute is for internal use only.
169    * TODO: this attribute es for containers only
170    *
171    * @param topOffset The top offset which is needed by some containers (e. g. a box).
172    */
173   @UIComponentTagAttribute(type = "org.apache.myfaces.tobago.layout.Measure",
174       defaultCode = "org.apache.myfaces.tobago.config.ThemeConfig.getMeasure("
175           + "getFacesContext(), this, \"topOffset\")")
176   void setTopOffset(String topOffset);
177 
178   /**
179    * This attribute is for internal use only.
180    * TODO: this attribute es for containers only
181    *
182    * @param bottomOffset The bottom offset which is needed by some containers (e. g. a box).
183    */
184   @UIComponentTagAttribute(type = "org.apache.myfaces.tobago.layout.Measure",
185       defaultCode = "org.apache.myfaces.tobago.config.ThemeConfig.getMeasure("
186           + "getFacesContext(), this, \"bottomOffset\")")
187   void setBottomOffset(String bottomOffset);
188 
189 }