1 <?xml version="1.0" encoding="UTF-8"?>
3 Copyright (C) 2017, 2018 Free Software Foundation
5 This program is free software: you can redistribute it and/or modify
6 it under the terms of the GNU Affero General Public License as
7 published by the Free Software Foundation, either version 3 of the
8 License, or (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
20 xmlns="http://xmlns.jcp.org/xml/ns/javaee"
21 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
22 xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-facelettaglibrary_2_2.xsd"
24 <namespace>http://mxchange.org/jsf/core/widgets</namespace>
26 <tag-name>outputMessageBox</tag-name>
27 <description>This tag renders a style-able and customizable message for any kind of messages that the user should see.</description>
28 <source>resources/tags/messages/message_box.tpl</source>
31 <description>The message that should be place into the message box. You may also use EL code here that resolves to a message string.</description>
32 <required>true</required>
33 <type>java.lang.String</type>
36 <name>panelGroupId</name>
37 <description>Id of the panel group component.</description>
38 <required>true</required>
39 <type>java.lang.String</type>
43 <description>Whether this tag is being rendered by JSF engine (default: true).</description>
44 <required>false</required>
45 <type>java.lang.Boolean</type>
48 <name>boxStyleClass</name>
49 <description>The optional CSS style class to be forwarded to the container div of the whole message box. Default is ".message_box" .</description>
50 <required>false</required>
51 <type>java.lang.String</type>
54 <name>messageStyleClass</name>
55 <description>The optional CSS style class to be forwarded on the h:outputText's styleClass attribute of the message. The default is "okay" which normally renders as a green colored message.</description>
56 <required>false</required>
57 <type>java.lang.String</type>
61 <tag-name>outputContactDataGridColumns</tag-name>
62 <description>This tag renders columns for displaying contact data for administrative views.</description>
63 <source>resources/tags/admin/columns/admin_contact_data_columns.tpl</source>
66 <tag-name>outputPersonalTitleSelectionBox</tag-name>
67 <description>This tag renders a selection box for user contact's personal title (Mr./Mrs.).</description>
68 <source>resources/tags/input/selection_box/personal_title_selection_box.tpl</source>
70 <name>allowEmptyRequiredData</name>
71 <description>Whether allow the personal title to be left empty. This might be the case when you create a user and want to select a contact from a selection box. EL code resolving to a boolean may be allowed here.</description>
72 <required>false</required>
73 <type>java.lang.Boolean</type>
77 <description>Whether this tag is being rendered by JSF engine (default: true).</description>
78 <required>false</required>
79 <type>java.lang.Boolean</type>
82 <name>targetController</name>
83 <description>A target backing bean (EL code resolving into it) extending at least BaseFacesBean where to set the data in.</description>
84 <required>true</required>
85 <!-- @TODO Find an interface for BaseFacesBean and set it here instead -->
86 <type>org.mxchange.jcoreee.bean.faces.BaseFacesBean</type>
90 <tag-name>outputProfileModeTableRow</tag-name>
91 <description>This tag renders a selection box for user's profile mode.</description>
92 <source>resources/tags/table_rows/user_profile_mode_table_row.tpl</source>
94 <name>labelMessage</name>
95 <description>A localized message for the rendered label tag. You should use EL code here to add a label message from your bundle.</description>
96 <required>true</required>
97 <type>java.lang.String</type>
100 <name>rendered</name>
101 <description>Whether this tag is being rendered by JSF engine (default: true).</description>
102 <required>false</required>
103 <type>java.lang.Boolean</type>
106 <name>targetController</name>
107 <description>A target backing bean (EL code resolving into it) extending at least BaseFacesBean where to set the data in.</description>
108 <required>true</required>
109 <!-- @TODO Find an interface for BaseFacesBean and set it here instead -->
110 <type>org.mxchange.jcoreee.bean.faces.BaseFacesBean</type>
114 <tag-name>outputAdminContactDataFormFields</tag-name>
115 <description>This tag renders a fieldset for administrative purposes of contact data.</description>
116 <source>resources/tags/admin/form_data/contact/admin_form_contact_data.tpl</source>
118 <name>allowEmptyRequiredData</name>
119 <description>Whether allow the personal title to be left empty. This might be the case when you create a user and want to select a contact from a selection box. EL code resolving to a boolean may be allowed here.</description>
120 <required>false</required>
121 <type>java.lang.Boolean</type>
124 <name>rendered</name>
125 <description>Whether this tag is being rendered by JSF engine (default: true).</description>
126 <required>false</required>
127 <type>java.lang.Boolean</type>
131 <tag-name>outputAdminFaxDataFormFields</tag-name>
132 <description>This tag renders a fieldset for administrative purposes of fax data.</description>
133 <source>resources/tags/admin/form_data/fax/admin_form_fax_data.tpl</source>
135 <name>faxNumber</name>
136 <description>The fax instance that provides the data for this tag.</description>
137 <required>true</required>
138 <type>org.mxchange.jphone.model.phonenumbers.fax.DialableFaxNumber</type>
141 <name>rendered</name>
142 <description>Whether this tag is being rendered by JSF engine (default: true).</description>
143 <required>false</required>
144 <type>java.lang.Boolean</type>
148 <tag-name>outputAdminLandLineDataFormFields</tag-name>
149 <description>This tag renders a fieldset for administrative purposes of land-line data.</description>
150 <source>resources/tags/admin/form_data/landline/admin_form_landline_data.tpl</source>
152 <name>landLineNumber</name>
153 <description>The fax instance that provides the data for this tag.</description>
154 <required>true</required>
155 <type>org.mxchange.jphone.model.phonenumbers.landline.DialableLandLineNumber</type>
158 <name>rendered</name>
159 <description>Whether this tag is being rendered by JSF engine (default: true).</description>
160 <required>false</required>
161 <type>java.lang.Boolean</type>
165 <tag-name>outputAdminMobileDataFormFields</tag-name>
166 <description>This tag renders a fieldset for administrative purposes of mobile data.</description>
167 <source>resources/tags/admin/form_data/mobile/admin_form_mobile_data.tpl</source>
169 <name>mobileNumber</name>
170 <description>The mobile instance that provides the data for this tag.</description>
171 <required>true</required>
172 <type>org.mxchange.jphone.model.phonenumbers.mobile.DialableMobileNumber</type>
175 <name>rendered</name>
176 <description>Whether this tag is being rendered by JSF engine (default: true).</description>
177 <required>false</required>
178 <type>java.lang.Boolean</type>
182 <tag-name>outputAdminUserDataFormFields</tag-name>
183 <description>This tag renders a fieldset for administrative purposes of user data.</description>
184 <source>resources/tags/admin/form_data/user/admin_form_user_data.tpl</source>
187 <description>Mode of the form, must be one of "add" or "edit".</description>
188 <required>true</required>
189 <type>java.lang.String</type>
193 <tag-name>outputAdminFaxPanelGrid</tag-name>
194 <description>This tag renders a full p:panelGrid for administrative purposes for fax data.</description>
195 <source>resources/tags/admin/panel_grids/fax/admin_fax_data.tpl</source>
197 <name>faxNumber</name>
198 <description>The fax instance that provides the data for this tag.</description>
199 <required>true</required>
200 <type>org.mxchange.jphone.model.phonenumbers.fax.DialableFaxNumber</type>
204 <description>The contact instance that provides contact data for additional JSF links.</description>
205 <required>false</required>
206 <type>org.mxchange.jcontacts.model.contact.Contact</type>
209 <name>rendered</name>
210 <description>Whether this tag is being rendered by JSF engine (default: true).</description>
211 <required>false</required>
212 <type>java.lang.Boolean</type>
215 <name>renderShowLink</name>
216 <description>Whether this tag is used to show fax data (default true).</description>
217 <required>false</required>
218 <type>java.lang.Boolean</type>
221 <name>showAdminDropdownMenu</name>
222 <description>Whether to show administrative links to other pages (default: true).</description>
223 <required>false</required>
224 <type>java.lang.Boolean</type>
228 <tag-name>outputAdminLandLinePanelGrid</tag-name>
229 <description>This tag renders a full p:panelGrid for administrative purposes for land-line data.</description>
230 <source>resources/tags/admin/panel_grids/landline/admin_landline_data.tpl</source>
232 <name>renderShowLink</name>
233 <description>Whether this tag is used to show land-line data (default true).</description>
234 <required>false</required>
235 <type>java.lang.Boolean</type>
238 <name>landLineNumber</name>
239 <description>The fax instance that provides the data for this tag.</description>
240 <required>true</required>
241 <type>org.mxchange.jphone.model.phonenumbers.landline.DialableLandLineNumber</type>
245 <description>The contact instance that provides contact data for additional JSF links.</description>
246 <required>false</required>
247 <type>org.mxchange.jcontacts.model.contact.Contact</type>
250 <name>rendered</name>
251 <description>Whether this tag is being rendered by JSF engine (default: true).</description>
252 <required>false</required>
253 <type>java.lang.Boolean</type>
256 <name>showAdminDropdownMenu</name>
257 <description>Whether to show administrative links to other pages (default: true).</description>
258 <required>false</required>
259 <type>java.lang.Boolean</type>
263 <tag-name>outputAdminMobilePanelGrid</tag-name>
264 <description>This tag renders a full p:panelGrid for administrative purposes for mobile data.</description>
265 <source>resources/tags/admin/panel_grids/mobile/admin_mobile_data.tpl</source>
267 <name>renderShowLink</name>
268 <description>Whether this tag is used to show mobile data (default true).</description>
269 <required>false</required>
270 <type>java.lang.Boolean</type>
273 <name>mobileNumber</name>
274 <description>The mobile instance that provides the data for this tag.</description>
275 <required>true</required>
276 <type>org.mxchange.jphone.model.phonenumbers.mobile.DialableMobileNumber</type>
280 <description>The contact instance that provides contact data for additional JSF links.</description>
281 <required>false</required>
282 <type>org.mxchange.jcontacts.model.contact.Contact</type>
285 <name>rendered</name>
286 <description>Whether this tag is being rendered by JSF engine (default: true).</description>
287 <required>false</required>
288 <type>java.lang.Boolean</type>
291 <name>showAdminDropdownMenu</name>
292 <description>Whether to show administrative links to other pages (default: true).</description>
293 <required>false</required>
294 <type>java.lang.Boolean</type>
298 <tag-name>outputFaxInputTableRow</tag-name>
299 <description>This tag renders a h:panelGroup with input fields for fax numbers.</description>
300 <source>resources/tags/table_rows/fax_input_table_row.tpl</source>
302 <name>targetController</name>
303 <description>A target backing bean (EL code resolving into it) extending at least BaseFacesBean where to set the data in.</description>
304 <required>true</required>
305 <!-- @TODO Find an interface for BaseFacesBean and set it here instead -->
306 <type>org.mxchange.jcoreee.bean.faces.BaseFacesBean</type>
309 <name>labelMessage</name>
310 <description>A localized message for the rendered label tag. You should use EL code here to add a label message from your bundle.</description>
311 <required>true</required>
312 <type>java.lang.String</type>
315 <name>rendered</name>
316 <description>Whether this tag is being rendered by JSF engine (default: true).</description>
317 <required>false</required>
318 <type>java.lang.Boolean</type>
322 <tag-name>outputLandLineInputTableRow</tag-name>
323 <description>This tag renders a h:panelGroup with input fields for land-line numbers.</description>
324 <source>resources/tags/table_rows/landline_input_table_row.tpl</source>
326 <name>targetController</name>
327 <description>A target backing bean (EL code resolving into it) extending at least BaseFacesBean where to set the data in.</description>
328 <required>true</required>
329 <!-- @TODO Find an interface for BaseFacesBean and set it here instead -->
330 <type>org.mxchange.jcoreee.bean.faces.BaseFacesBean</type>
333 <name>labelMessage</name>
334 <description>A localized message for the rendered label tag. You should use EL code here to add a label message from your bundle.</description>
335 <required>true</required>
336 <type>java.lang.String</type>
339 <name>rendered</name>
340 <description>Whether this tag is being rendered by JSF engine (default: true).</description>
341 <required>false</required>
342 <type>java.lang.Boolean</type>
346 <tag-name>outputCountrySelector</tag-name>
347 <description>This tag renders a selection box for all available countries.</description>
348 <source>resources/tags/country/form_data/form_country_selector.tpl</source>
350 <name>rendered</name>
351 <description>Whether this tag is being rendered by JSF engine (default: true).</description>
352 <required>false</required>
353 <type>java.lang.Boolean</type>
356 <name>allowNone</name>
357 <description>Whether this tag allows NONE/null to be selected (default: true).</description>
358 <required>false</required>
359 <type>java.lang.Boolean</type>
362 <name>required</name>
363 <description>Whether this tag is required (default: false)</description>
364 <required>false</required>
365 <type>java.lang.Boolean</type>
368 <name>requiredMessage</name>
369 <description>Localizable message to be displayed when this field is required but not selected.</description>
370 <required>false</required>
371 <type>java.lang.String</type>
375 <description>Id of the JSF component.</description>
376 <required>true</required>
377 <type>java.lang.String</type>
380 <name>styleClass</name>
381 <description>CSS style class for this component, default: select.</description>
382 <required>false</required>
383 <type>java.lang.String</type>
387 <description>A target property to set the selected country in.</description>
388 <required>true</required>
389 <type>org.mxchange.jcountry.model.data.Country</type>
393 <tag-name>inputFaxNumberPanelGrid</tag-name>
394 <description>This tag renders input fields for creating a fax number.</description>
395 <source>resources/tags/input/panel_grid/fax_input_panel_grid.tpl</source>
397 <name>rendered</name>
398 <description>Whether this tag is being rendered by JSF engine (default: true).</description>
399 <required>false</required>
400 <type>java.lang.Boolean</type>
403 <name>targetController</name>
404 <description>A target backing bean (EL code resolving into it) extending at least BaseFacesBean where to set the data in.</description>
405 <required>true</required>
406 <!-- @TODO Find an interface for BaseFacesBean and set it here instead -->
407 <type>org.mxchange.jcoreee.bean.faces.BaseFacesBean</type>
411 <tag-name>inputLandLineNumberPanelGrid</tag-name>
412 <description>This tag renders input fields for creating a land-line number.</description>
413 <source>resources/tags/input/panel_grid/landline_input_panel_grid.tpl</source>
415 <name>rendered</name>
416 <description>Whether this tag is being rendered by JSF engine (default: true).</description>
417 <required>false</required>
418 <type>java.lang.Boolean</type>
421 <name>targetController</name>
422 <description>A target backing bean (EL code resolving into it) extending at least BaseFacesBean where to set the data in.</description>
423 <required>true</required>
424 <!-- @TODO Find an interface for BaseFacesBean and set it here instead -->
425 <type>org.mxchange.jcoreee.bean.faces.BaseFacesBean</type>
429 <tag-name>inputMobileNumberPanelGrid</tag-name>
430 <description>This tag renders input fields for creating a mobile number.</description>
431 <source>resources/tags/input/panel_grid/mobile_input_panel_grid.tpl</source>
433 <name>rendered</name>
434 <description>Whether this tag is being rendered by JSF engine (default: true).</description>
435 <required>false</required>
436 <type>java.lang.Boolean</type>
439 <name>targetController</name>
440 <description>A target backing bean (EL code resolving into it) extending at least BaseFacesBean where to set the data in.</description>
441 <required>true</required>
442 <!-- @TODO Find an interface for BaseFacesBean and set it here instead -->
443 <type>org.mxchange.jcoreee.bean.faces.BaseFacesBean</type>
447 <tag-name>outputOpeningTimesDataTable</tag-name>
448 <description>This tag renders a full p:dataTable for opening times.</description>
449 <source>resources/tags/opening_times/opening_times_data_table.tpl</source>
452 <description>An id string for this tag.</description>
453 <required>true</required>
454 <type>java.lang.String</type>
458 <description>A list of OpeningTime objects.</description>
459 <required>true</required>
460 <type>java.util.List</type>
463 <name>widgetVar</name>
464 <description>Identifier for this widget (e.g. JavaScript).</description>
465 <required>true</required>
466 <type>java.lang.String</type>
470 <description>A string or EL code for table attribute of same name.</description>
471 <required>true</required>
472 <type>java.lang.String</type>
475 <name>emptyMessage</name>
476 <description>A string or EL code for a message shown when no row was found.</description>
477 <required>true</required>
478 <type>java.lang.String</type>
481 <name>headerMessage</name>
482 <description>A string or EL code for a message shown above table rows.</description>
483 <required>true</required>
484 <type>java.lang.String</type>
488 <description>Rows to show each page.</description>
489 <required>true</required>
490 <type>java.lang.Long</type>
493 <name>rendered</name>
494 <description>Whether this tag is being rendered by JSF engine (default: true).</description>
495 <required>false</required>
496 <type>java.lang.Boolean</type>