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.TagAttribute;
23  import org.apache.myfaces.tobago.apt.annotation.UIComponentTagAttribute;
24  
25  /**
26   * The width and height attributes can be set explicitly on some components.
27   * Generally it should be checked, if using of a layout manager is a better alternative.
28   */
29  public interface IsGridLayoutComponentWithDimension extends IsGridLayoutComponentBase {
30  
31    /**
32     * The width of the component in the UI.
33     * This value will usually be set by the layout manager, but can be set explicitly here.
34     *
35     * @param width The width for this component.
36     */
37    @TagAttribute
38    @UIComponentTagAttribute(type = "org.apache.myfaces.tobago.layout.Measure",
39        defaultCode = "getRendererType() != null ? ((LayoutComponentRenderer)"
40            + " getRenderer(getFacesContext())).getWidth(getFacesContext(), this) : Measure.ZERO")
41    void setWidth(String width);
42  
43    /**
44     * The height of the component in the UI.
45     * This value will usually be set by the layout manager, but can be set explicitly here.
46     *
47     * @param height The height for this component.
48     */
49    @TagAttribute
50    @UIComponentTagAttribute(type = "org.apache.myfaces.tobago.layout.Measure",
51        defaultCode = "getRendererType() != null ? ((LayoutComponentRenderer)"
52            + " getRenderer(getFacesContext())).getHeight(getFacesContext(), this) : Measure.ZERO")
53    void setHeight(String height);
54  
55  }