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.tobago.internal.taglib.declaration;
21  
22  import org.apache.myfaces.tobago.apt.annotation.UIComponentTagAttribute;
23  
24  /**
25   * @deprecated This class should not be used directly, please use IsGridLayoutComponent. 
26   */
27  @Deprecated
28  public interface IsGridLayoutComponentBase {
29  
30    /**
31     * This value will usually be set by the layout manager. It holds the current width computed by the layout manager.
32     *
33     * @param currentWidth The current width for this component.
34     */
35    @UIComponentTagAttribute(type = "org.apache.myfaces.tobago.layout.Measure",
36        defaultCode = "getWidth()")
37    void setCurrentWidth(String currentWidth);
38  
39    /**
40     * This value will usually be set by the layout manager. It holds the current height computed by the layout manager.
41     *
42     * @param currentHeight The current height for this component.
43     */
44    @UIComponentTagAttribute(type = "org.apache.myfaces.tobago.layout.Measure",
45        defaultCode = "getHeight()")
46    void setCurrentHeight(String currentHeight);
47    
48    /**
49     * @param columnSpan The number of horizontal cells this component should use.
50     */
51    @UIComponentTagAttribute(type = "java.lang.Integer", defaultValue = "1")
52    void setColumnSpan(String columnSpan);
53  
54    /**
55     * @param rowSpan The number of vertical cells this component should use.
56     */
57    @UIComponentTagAttribute(type = "java.lang.Integer", defaultValue = "1")
58    void setRowSpan(String rowSpan);
59  
60    /**
61     * @param minimumWidth The minimum width for this component.
62     */
63    @UIComponentTagAttribute(type = "org.apache.myfaces.tobago.layout.Measure",
64        defaultCode = "getRendererType() != null ? ((LayoutComponentRenderer) "
65            + "getRenderer(getFacesContext())).getMinimumWidth(getFacesContext(), this) : Measure.ZERO")
66    void setMinimumWidth(String minimumWidth);
67  
68    /**
69     * @param minimumHeight The minimum height for this component.
70     */
71    @UIComponentTagAttribute(type = "org.apache.myfaces.tobago.layout.Measure",
72        defaultCode = "getRendererType() != null ? ((LayoutComponentRenderer) "
73            + "getRenderer(getFacesContext())).getMinimumHeight(getFacesContext(), this) : Measure.ZERO")
74    void setMinimumHeight(String minimumHeight);
75  
76    /**
77     * @param preferredWidth The preferred width for this component.
78     */
79    @UIComponentTagAttribute(type = "org.apache.myfaces.tobago.layout.Measure",
80        defaultCode = "getRendererType() != null ? ((LayoutComponentRenderer) "
81            + "getRenderer(getFacesContext())).getPreferredWidth(getFacesContext(), this) : Measure.ZERO")
82    void setPreferredWidth(String preferredWidth);
83  
84    /**
85     * @param preferredHeight The preferred height for this component.
86     */
87    @UIComponentTagAttribute(type = "org.apache.myfaces.tobago.layout.Measure",
88        defaultCode = "getRendererType() != null ? ((LayoutComponentRenderer) "
89            + "getRenderer(getFacesContext())).getPreferredHeight(getFacesContext(), this) : Measure.ZERO")
90    void setPreferredHeight(String preferredHeight);
91  
92    /**
93     * @param maximumWidth The maximum width for this component.
94     */
95    @UIComponentTagAttribute(type = "org.apache.myfaces.tobago.layout.Measure",
96        defaultCode = "getRendererType() != null ? ((LayoutComponentRenderer) "
97            + "getRenderer(getFacesContext())).getMaximumWidth(getFacesContext(), this) : Measure.ZERO")
98    void setMaximumWidth(String maximumWidth);
99  
100   /**
101    * @param maximumHeight The maximum height for this component.
102    */
103   @UIComponentTagAttribute(type = "org.apache.myfaces.tobago.layout.Measure",
104       defaultCode = "getRendererType() != null ? ((LayoutComponentRenderer) "
105           + "getRenderer(getFacesContext())).getMaximumHeight(getFacesContext(), this) : Measure.ZERO")
106   void setMaximumHeight(String maximumHeight);
107 
108   /**
109    * @param marginLeft The margin at the left of this component.
110    */
111   @UIComponentTagAttribute(type = "org.apache.myfaces.tobago.layout.Measure",
112       defaultCode = "getRendererType() != null ? ((LayoutComponentRenderer) "
113           + "getRenderer(getFacesContext())).getMarginLeft(getFacesContext(), this) : Measure.ZERO")
114   void setMarginLeft(String marginLeft);
115 
116   /**
117    * @param marginRight The margin at the right of this component.
118    */
119   @UIComponentTagAttribute(type = "org.apache.myfaces.tobago.layout.Measure",
120       defaultCode = "getRendererType() != null ? ((LayoutComponentRenderer) "
121           + "getRenderer(getFacesContext())).getMarginRight(getFacesContext(), this) : Measure.ZERO")
122   void setMarginRight(String marginRight);
123 
124   /**
125    * @param marginTop The margin at the top of this component.
126    */
127   @UIComponentTagAttribute(type = "org.apache.myfaces.tobago.layout.Measure",
128       defaultCode = "getRendererType() != null ? ((LayoutComponentRenderer) "
129           + "getRenderer(getFacesContext())).getMarginTop(getFacesContext(), this) : Measure.ZERO")
130   void setMarginTop(String marginTop);
131 
132   /**
133    * @param marginBottom The margin at the bottom of this component.
134    */
135   @UIComponentTagAttribute(type = "org.apache.myfaces.tobago.layout.Measure",
136       defaultCode = "getRendererType() != null ? ((LayoutComponentRenderer) "
137           + "getRenderer(getFacesContext())).getMarginBottom(getFacesContext(), this) : Measure.ZERO")
138   void setMarginBottom(String marginBottom);
139 
140   /**
141    * This value will usually be set by the layout manager.
142    *
143    * @param left The left position value for this component.
144    */
145   @UIComponentTagAttribute(type = "org.apache.myfaces.tobago.layout.Measure")
146   void setLeft(String left);
147 
148   /**
149    * This value will usually be set by the layout manager.
150    *
151    * @param top The top position value for this component.
152    */
153   @UIComponentTagAttribute(type = "org.apache.myfaces.tobago.layout.Measure")
154   void setTop(String top);
155 
156   /**
157    * This attribute is for internal use only.
158    *
159    * @param horizontalIndex The index of the component inside its container grid in horizontal direction.
160    */
161   @UIComponentTagAttribute(type = "java.lang.Integer")
162   void setHorizontalIndex(String horizontalIndex);
163 
164   /**
165    * This attribute is for internal use only.
166    *
167    * @param verticalIndex The index of the component inside its container grid in vertical direction.
168    */
169   @UIComponentTagAttribute(type = "java.lang.Integer")
170   void setVerticalIndex(String verticalIndex);
171 
172   /**
173    * This attribute is for internal use only.
174    *
175    * @param display Indicates the renderer to render the element as block or inline.
176    */
177   @UIComponentTagAttribute(type = "org.apache.myfaces.tobago.layout.Display")
178   void setDisplay(String display);
179   
180 }