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  package org.apache.myfaces.shared.renderkit;
20  
21  import javax.faces.event.ActionListener;
22  
23  
24  /**
25   * Constant declarations for JSF tags
26   */
27  public interface JSFAttr
28  {
29      //~ Static fields/initializers -----------------------------------------------------------------
30  
31      // Common Attributes
32      String   ID_ATTR                        = "id";
33      String   VALUE_ATTR                     = "value";
34      String   BINDING_ATTR                   = "binding";
35      String   STYLE_ATTR                     = "style";
36      String   STYLE_CLASS_ATTR               = "styleClass";
37      String   ESCAPE_ATTR                    = "escape";
38      String   FORCE_ID_ATTR                  = "forceId";
39      String   FORCE_ID_INDEX_ATTR            = "forceIdIndex";
40      String   RENDERED                       = "rendered";
41  
42      // Common Output Attributes
43      String   FOR_ATTR                       = "for";
44      String   CONVERTER_ATTR                 = "converter";
45  
46      // Ouput_Time Attributes
47      String   TIME_STYLE_ATTR                = "timeStyle";
48      String   TIMEZONE_ATTR                  = "timezone";
49  
50      // Common Input Attributes
51      String   REQUIRED_ATTR                  = "required";
52      String   VALIDATOR_ATTR                 = "validator";
53      String   DISABLED_ATTR                  = "disabled";
54      String   READONLY_ATTR                  = "readonly";
55  
56      // Input_Secret Attributes
57      String   REDISPLAY_ATTR                 = "redisplay";
58  
59      // Input_Checkbox Attributes
60      String   LAYOUT_ATTR                    = "layout";
61  
62      // Select_Menu Attributes
63      String   SIZE_ATTR                     = "size";
64  
65      // SelectMany Checkbox List/ Select One Radio Attributes
66      String BORDER_ATTR                   = "border";
67      String DISABLED_CLASS_ATTR           = "disabledClass";
68      String ENABLED_CLASS_ATTR            = "enabledClass";
69      String SELECTED_CLASS_ATTR           = "selectedClass";
70      String UNSELECTED_CLASS_ATTR         = "unselectedClass";
71      String HIDE_NO_SELECTION_OPTION_ATTR = "hideNoSelectionOption";
72  
73      // Common Command Attributes
74      /**@deprecated */
75      String   COMMAND_CLASS_ATTR           = "commandClass";
76      String   LABEL_ATTR                   = "label";
77      String   IMAGE_ATTR                   = "image";
78      String   ACTION_ATTR                 = "action";
79      String   IMMEDIATE_ATTR              = "immediate";
80  
81  
82      // Command_Button Attributes
83      String   TYPE_ATTR                    = "type";
84  
85      // Common Panel Attributes
86      /**@deprecated */
87      String   PANEL_CLASS_ATTR       = "panelClass";
88      String   FOOTER_CLASS_ATTR      = "footerClass";
89      String   HEADER_CLASS_ATTR      = "headerClass";
90      String   COLUMN_CLASSES_ATTR    = "columnClasses";
91      String   ROW_CLASSES_ATTR       = "rowClasses";
92      String   BODYROWS_ATTR          = "bodyrows";
93  
94      // Panel_Grid Attributes
95      String   COLUMNS_ATTR          = "columns";
96      String   COLSPAN_ATTR          = "colspan"; // extension
97      String   CAPTION_CLASS_ATTR    = "captionClass";
98      String   CAPTION_STYLE_ATTR    = "captionStyle";
99  
100     // UIMessage and UIMessages attributes
101     String SHOW_SUMMARY_ATTR            = "showSummary";
102     String SHOW_DETAIL_ATTR             = "showDetail";
103     String GLOBAL_ONLY_ATTR             = "globalOnly";
104 
105     // HtmlOutputMessage attributes
106     String ERROR_CLASS_ATTR            = "errorClass";
107     String ERROR_STYLE_ATTR            = "errorStyle";
108     String FATAL_CLASS_ATTR            = "fatalClass";
109     String FATAL_STYLE_ATTR            = "fatalStyle";
110     String INFO_CLASS_ATTR             = "infoClass";
111     String INFO_STYLE_ATTR             = "infoStyle";
112     String WARN_CLASS_ATTR             = "warnClass";
113     String WARN_STYLE_ATTR             = "warnStyle";
114     String TITLE_ATTR                  = "title";
115     String TOOLTIP_ATTR                = "tooltip";
116     
117     // HtmlOutputLink Attributes
118     String FRAGMENT_ATTR               = "fragment";
119 
120     // GraphicImage attributes
121     String NAME_ATTR                   = "name";
122     String URL_ATTR                    = "url";
123     String LIBRARY_ATTR                = "library";
124     
125     // HtmlOutputScript (missing) attributes
126     String TARGET_ATTR                 = "target";
127     
128     // UISelectItem attributes
129     String ITEM_DISABLED_ATTR          = "itemDisabled";
130     String ITEM_DESCRIPTION_ATTR       = "itemDescription";
131     String ITEM_LABEL_ATTR             = "itemLabel";
132     String ITEM_VALUE_ATTR             = "itemValue";
133     String ITEM_ESCAPED_ATTR           = "itemEscaped";
134     String NO_SELECTION_OPTION_ATTR    = "noSelectionOption";
135     
136     // UISelectItems attributes
137     String ITEM_LABEL_ESCAPED_ATTR     = "itemLabelEscaped";
138     String NO_SELECTION_VALUE_ATTR     = "noSelectionValue";
139 
140     // UIData attributes
141     String ROWS_ATTR                   = "rows";
142     String VAR_ATTR                    = "var";
143     String FIRST_ATTR                  = "first";
144 
145     // dataTable (extended) attributes
146     String ROW_ID                      = "rowId";
147     String ROW_STYLECLASS_ATTR         = "rowStyleClass";
148     String ROW_STYLE_ATTR              = "rowStyle";
149     
150     // HtmlColumn attributes
151     String ROW_HEADER_ATTR             = "rowHeader";
152 
153     // Alternate locations (instead of using AddResource)
154     String JAVASCRIPT_LOCATION         = "javascriptLocation";
155     String IMAGE_LOCATION              = "imageLocation";
156     String STYLE_LOCATION              = "styleLocation";
157 
158     String ACCEPTCHARSET_ATTR          = "acceptcharset";
159     
160     //~ Myfaces Extensions -------------------------------------------------------------------------------
161 
162     // UISortData attributes
163     String COLUMN_ATTR                 = "column";
164     String ASCENDING_ATTR              = "ascending";
165     
166     // HtmlSelectManyCheckbox attributes
167     String LAYOUT_WIDTH_ATTR           = "layoutWidth";
168 
169     //
170     String TO_FLOW_DOCUMENT_ID_ATTR    = ActionListener.TO_FLOW_DOCUMENT_ID_ATTR_NAME;
171 }