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.renderkit.html;
21  
22  /**
23   * Custom data attributes.
24   * These attributes may transport data to DOM which are not standardized.
25   * The format is "data-tobago-*" which is conform to HTML 5, but also works in older browsers.
26   */
27  public enum DataAttributes implements MarkupLanguageAttributes {
28  
29    /**
30     * Ajax behaviors execute and render attributes for TabGroup and Sheet reload
31     */
32    BEHAVIOR_COMMANDS("data-tobago-behavior-commands"),
33  
34    /**
35     * The index of the column of a sheet. This index means the position of the rendered column. It can differ, if there
36     * are tc:column with rendered=false.
37     */
38    COLUMN_INDEX("data-tobago-column-index"),
39  
40    /**
41     * Custom command attribute. Is used to mark different client side JavaScript buttons.
42     * Should only contain the command name as a keyword, for security reasons.
43     */
44    COMMAND("data-tobago-command"),
45  
46    /**
47     * The list of commands attached to an element.
48     */
49    COMMANDS("data-tobago-commands"),
50  
51    /**
52     * The context path of the application, may be needed in the Client.
53     */
54    CONTEXT_PATH("data-tobago-context-path"),
55  
56    DATE_TIME_I18N("data-tobago-date-time-i18n"),
57  
58    /**
59     * Holds the day of a calendar control.
60     */
61    DAY("data-tobago-day"),
62  
63    /**
64     * Custom disabled attribute. Use for element, that don't have the disabled attribute.
65     */
66    DISABLED("data-tobago-disabled"),
67  
68    DISMISS("data-dismiss"),
69  
70    /**
71     * Custom form attribute. Used to show the virtual form of the component.
72     */
73    DEFAULT("data-tobago-default"),
74  
75    DELAY("data-tobago-delay"),
76  
77    FOR("data-tobago-for"),
78  
79    /**
80     * Holds the id of the first row in a sheet.
81     */
82    FIRST("data-tobago-first"),
83  
84    /*
85     * Holds the index of the row in a sheet, if the sheed has a rowRendered attribute.
86     */
87    ROW_INDEX("data-tobago-row-index"),
88  
89    /**
90     * Holds the first day of a week of a calendar control.
91     */
92    FIRST_DAY_OF_WEEK("data-tobago-first-day-of-week"),
93  
94    /**
95     * Defines a maximum value.
96     */
97    LAYOUT("data-tobago-layout"),
98  
99    /**
100    * Defines a maximum value.
101    */
102   MAX("data-tobago-max"),
103 
104   /**
105    * Holds the month of a calendar control.
106    */
107   MONTH("data-tobago-month"),
108 
109   /**
110    * Holds the names of the months of a calendar control.
111    */
112   MONTH_NAMES("data-tobago-month-names"),
113 
114   PARTIAL_IDS("data-tobago-partial-ids"),
115 
116   PARTIAL_ACTION("data-tobago-partial-action"),
117 
118   /**
119    * Custom attribute to describe a pattern, e. g. for an date input field.
120    */
121   PATTERN("data-tobago-pattern"),
122 
123   /**
124    * Custom reload attribute. Used to reload a panel.
125    */
126   RELOAD("data-tobago-reload"),
127 
128   ROW_ACTION("data-tobago-row-action"),
129 
130   SELECTION_MODE("data-tobago-selection-mode"),
131 
132   /**
133    * The selectable attribute e. g. for trees.
134    */
135   SELECTABLE("data-tobago-selectable"),
136 
137   /**
138    * Reference to a sheet.
139    */
140   SHEET_ID("data-tobago-sheet-id"),
141 
142   /**
143    * Alternate to the src attribute, to implement a hover effect.
144    */
145   SRC_HOVER("data-tobago-src-hover"),
146 
147   /**
148    * Alternate to the src attribute, to implement a hover effect.
149    */
150   SRC_DEFAULT("data-tobago-src-default"),
151 
152   /**
153    * Alternate to the src attribute, icon open and close.
154    */
155   SRC_CLOSE("data-tobago-src-close"),
156 
157   /**
158    * Alternate to the src attribute, icon open and close.
159    */
160   SRC_OPEN("data-tobago-src-open"),
161 
162   /**
163    * A way to transport style data in JSON format to the browser. With CSP the normal style attribute isn't allowed.
164    */
165   STYLE("data-tobago-style"),
166 
167   SCROLL_PANEL("data-tobago-scroll-panel"),
168 
169   SCROLL_POSITION("data-tobago-scroll-position"),
170 
171   SUGGEST_DATA("data-tobago-suggest-data"),
172 
173   SUGGEST_DELAY("data-tobago-suggest-delay"),
174 
175   SUGGEST_FOR("data-tobago-suggest-for"),
176 
177   SUGGEST_MAX_ITEMS("data-tobago-suggest-max-items"),
178 
179   SUGGEST_MIN_CHARS("data-tobago-suggest-min-chars"),
180 
181   SUGGEST_TOTAL_COUNT("data-tobago-suggest-total-count"),
182 
183   SUGGEST_UPDATE("data-tobago-suggest-update"),
184 
185   TARGET("data-target"),
186 
187   TO_PAGE("data-tobago-to-page"),
188 
189   TOGGLE("data-toggle"),
190 
191   TRANSITION("data-tobago-transition"),
192 
193   /**
194    * Id of the parent node in a tree node.
195    */
196   TREE_PARENT("data-tobago-tree-parent"),
197 
198   /**
199    * Defines the unit, e. g. to differ between hours, minutes and seconds in a time control.
200    */
201   UNIT("data-tobago-unit"),
202 
203   /**
204    * Holds the value (for tags, that don't have a value in HTML).
205    */
206   VALUE("data-tobago-value"),
207 
208   /**
209    * Holds the year of a calendar control.
210    */
211   YEAR("data-tobago-year");
212 
213   private final String value;
214 
215   DataAttributes(String value) {
216     this.value = value;
217   }
218 
219   @Override
220   public String getValue() {
221     return value;
222   }
223 
224   public static MarkupLanguageAttributes dynamic(final String withoutPrefix) {
225     return new MarkupLanguageAttributes() {
226       @Override
227       public String getValue() {
228         return "data-" + withoutPrefix;
229       }
230     };
231   }
232 
233 }