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.component;
21  
22  import org.apache.myfaces.tobago.apt.annotation.SimpleTag;
23  import org.apache.myfaces.tobago.apt.annotation.Tag;
24  import org.apache.myfaces.tobago.apt.annotation.TagAttribute;
25  import org.apache.myfaces.tobago.apt.annotation.UIComponentTagAttribute;
26  import org.apache.myfaces.tobago.layout.Margin;
27  
28  import javax.el.ValueExpression;
29  
30  /**
31   * Set a offset for the parent UIComponent withing a segment layout.
32   */
33  @Tag(name = "segmentLayoutConstraint")
34  @SimpleTag(faceletHandler = "org.apache.myfaces.tobago.facelets.SegmentLayoutConstraintHandler")
35  public interface SegmentLayoutConstraintTagDeclaration {
36  
37    /**
38     * Overwrite the default layout for extra small devices.
39     * Possible values are: segment values between 1 and 12, 'auto' and '*'.
40     */
41    @TagAttribute
42    void setExtraSmall(final ValueExpression extraSmall);
43  
44    /**
45     * Overwrite the default layout for small devices.
46     * Possible values are: segment values between 1 and 12, 'auto' and '*'.
47     */
48    @TagAttribute
49    void setSmall(final ValueExpression small);
50  
51    /**
52     * Overwrite the default layout for medium devices.
53     * Possible values are: segment values between 1 and 12, 'auto' and '*'.
54     */
55    @TagAttribute
56    void setMedium(final ValueExpression medium);
57  
58    /**
59     * Overwrite the default layout for large devices.
60     * Possible values are: segment values between 1 and 12, 'auto' and '*'.
61     */
62    @TagAttribute
63    void setLarge(final ValueExpression large);
64  
65    /**
66     * Overwrite the default layout for extra large devices.
67     * Possible values are: segment values between 1 and 12, 'auto' and '*'.
68     */
69    @TagAttribute
70    void setExtraLarge(final ValueExpression extraLarge);
71  
72    /**
73     * Overwrite the default margin for extra small devices.
74     */
75    @TagAttribute
76    @UIComponentTagAttribute(allowedValues = {Margin.NONE, Margin.LEFT, Margin.RIGHT, Margin.BOTH})
77    void setMarginExtraSmall(final ValueExpression overwriteMarginExtraSmall);
78  
79    /**
80     * Overwrite the default margin for small devices.
81     */
82    @TagAttribute
83    @UIComponentTagAttribute(allowedValues = {Margin.NONE, Margin.LEFT, Margin.RIGHT, Margin.BOTH})
84    void setMarginSmall(final ValueExpression overwriteMarginSmall);
85  
86    /**
87     * Overwrite the default margin for medium devices.
88     */
89    @TagAttribute
90    @UIComponentTagAttribute(allowedValues = {Margin.NONE, Margin.LEFT, Margin.RIGHT, Margin.BOTH})
91    void setMarginMedium(final ValueExpression overwriteMarginMedium);
92  
93    /**
94     * Overwrite the default margin for large devices.
95     */
96    @TagAttribute
97    @UIComponentTagAttribute(allowedValues = {Margin.NONE, Margin.LEFT, Margin.RIGHT, Margin.BOTH})
98    void setMarginLarge(final ValueExpression overwriteMarginLarge);
99  
100   /**
101    * Overwrite the default margin for extra large devices.
102    */
103   @TagAttribute
104   @UIComponentTagAttribute(allowedValues = {Margin.NONE, Margin.LEFT, Margin.RIGHT, Margin.BOTH})
105   void setMarginExtraLarge(final ValueExpression overwriteMarginExtraLarge);
106 
107   /**
108    * The number of columns this component moves to the right for extra small devices.
109    */
110   @TagAttribute(type = "java.lang.Integer")
111   void setOffsetExtraSmall(final ValueExpression offsetExtraSmall);
112 
113   /**
114    * The number of columns this component moves to the right for small devices.
115    */
116   @TagAttribute(type = "java.lang.Integer")
117   void setOffsetSmall(final ValueExpression offsetSmall);
118 
119   /**
120    * The number of columns this component moves to the right for medium devices.
121    */
122   @TagAttribute(type = "java.lang.Integer")
123   void setOffsetMedium(final ValueExpression offsetMedium);
124 
125   /**
126    * The number of columns this component moves to the right for large devices.
127    */
128   @TagAttribute(type = "java.lang.Integer")
129   void setOffsetLarge(final ValueExpression offsetLarge);
130 
131   /**
132    * The number of columns this component moves to the right for extra large devices.
133    */
134   @TagAttribute(type = "java.lang.Integer")
135   void setOffsetExtraLarge(final ValueExpression offsetLarge);
136 }