web/WEB-INF/widgets.jsf.taglib.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!--
   3 Copyright (C) 2017 - 2022 Free Software Foundation
   4
   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.
   9
  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.
  14
  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/>.
  17 -->
  18 <facelet-taglib
  19         version="2.2"
  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"
  23 >
  24         <namespace>http://mxchange.org/jsf/core/widgets</namespace>
  25         <tag>
  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>
  29                 <attribute>
  30                         <name>message</name>
  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>
  34                 </attribute>
  35                 <attribute>
  36                         <name>panelGroupId</name>
  37                         <description>Id of the panel group component.</description>
  38                         <required>true</required>
  39                         <type>java.lang.String</type>
  40                 </attribute>
  41                 <attribute>
  42                         <name>rendered</name>
  43                         <description>Whether this tag is being rendered by JSF engine (default: true).</description>
  44                         <required>false</required>
  45                         <type>java.lang.Boolean</type>
  46                 </attribute>
  47                 <attribute>
  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>
  52                 </attribute>
  53                 <attribute>
  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>
  58                 </attribute>
  59         </tag>
  60         <tag>
  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>
  64         </tag>
  65         <tag>
  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>
  69                 <attribute>
  70                         <name>targetController</name>
  71                         <description>A target backing bean (EL code resolving into it) extending at least BaseFacesBean where to set the data in.</description>
  72                         <required>true</required>
  73                         <!-- @TODO Find an interface for BaseFacesBean and set it here instead -->
  74                         <type>org.mxchange.jcoreee.bean.faces.BaseFacesBean</type>
  75                 </attribute>
  76         </tag>
  77         <tag>
  78                 <tag-name>outputAdminFaxDataFormFields</tag-name>
  79                 <description>This tag renders a fieldset for administrative purposes of fax data.</description>
  80                 <source>resources/tags/admin/form_data/fax/admin_form_fax_data.tpl</source>
  81                 <attribute>
  82                         <name>faxNumber</name>
  83                         <description>The fax instance that provides the data for this tag.</description>
  84                         <required>true</required>
  85                         <type>org.mxchange.jphone.model.phonenumbers.fax.DialableFaxNumber</type>
  86                 </attribute>
  87                 <attribute>
  88                         <name>rendered</name>
  89                         <description>Whether this tag is being rendered by JSF engine (default: true).</description>
  90                         <required>false</required>
  91                         <type>java.lang.Boolean</type>
  92                 </attribute>
  93         </tag>
  94         <tag>
  95                 <tag-name>outputAdminLandLineDataFormFields</tag-name>
  96                 <description>This tag renders a fieldset for administrative purposes of land-line data.</description>
  97                 <source>resources/tags/admin/form_data/landline/admin_form_landline_data.tpl</source>
  98                 <attribute>
  99                         <name>landLineNumber</name>
 100                         <description>The fax instance that provides the data for this tag.</description>
 101                         <required>true</required>
 102                         <type>org.mxchange.jphone.model.phonenumbers.landline.DialableLandLineNumber</type>
 103                 </attribute>
 104                 <attribute>
 105                         <name>rendered</name>
 106                         <description>Whether this tag is being rendered by JSF engine (default: true).</description>
 107                         <required>false</required>
 108                         <type>java.lang.Boolean</type>
 109                 </attribute>
 110         </tag>
 111         <tag>
 112                 <tag-name>outputAdminMobileDataFormFields</tag-name>
 113                 <description>This tag renders a fieldset for administrative purposes of mobile data.</description>
 114                 <source>resources/tags/admin/form_data/mobile/admin_edit_form_mobile_data.tpl</source>
 115                 <attribute>
 116                         <name>mobileNumber</name>
 117                         <description>The mobile instance that provides the data for this tag.</description>
 118                         <required>true</required>
 119                         <type>org.mxchange.jphone.model.phonenumbers.mobile.DialableMobileNumber</type>
 120                 </attribute>
 121                 <attribute>
 122                         <name>rendered</name>
 123                         <description>Whether this tag is being rendered by JSF engine (default: true).</description>
 124                         <required>false</required>
 125                         <type>java.lang.Boolean</type>
 126                 </attribute>
 127         </tag>
 128         <tag>
 129                 <tag-name>outputAdminUserDataFormFields</tag-name>
 130                 <description>This tag renders a fieldset for administrative purposes of user data.</description>
 131                 <source>resources/tags/admin/form_data/user/admin_form_user_data.tpl</source>
 132                 <attribute>
 133                         <name>mode</name>
 134                         <description>Mode of the form, must be one of "add" or "edit".</description>
 135                         <required>true</required>
 136                         <type>java.lang.String</type>
 137                 </attribute>
 138         </tag>
 139         <tag>
 140                 <tag-name>outputAdminFaxPanelGrid</tag-name>
 141                 <description>This tag renders a full p:panelGrid for administrative purposes for fax data.</description>
 142                 <source>resources/tags/admin/panel_grids/fax/admin_fax_data.tpl</source>
 143                 <attribute>
 144                         <name>faxNumber</name>
 145                         <description>The fax instance that provides the data for this tag.</description>
 146                         <required>true</required>
 147                         <type>org.mxchange.jphone.model.phonenumbers.fax.DialableFaxNumber</type>
 148                 </attribute>
 149                 <attribute>
 150                         <name>contact</name>
 151                         <description>The contact instance that provides contact data for additional JSF links.</description>
 152                         <required>false</required>
 153                         <type>org.mxchange.jcontacts.model.contact.Contact</type>
 154                 </attribute>
 155                 <attribute>
 156                         <name>rendered</name>
 157                         <description>Whether this tag is being rendered by JSF engine (default: true).</description>
 158                         <required>false</required>
 159                         <type>java.lang.Boolean</type>
 160                 </attribute>
 161                 <attribute>
 162                         <name>renderShowLink</name>
 163                         <description>Whether this tag is used to show fax data (default true).</description>
 164                         <required>false</required>
 165                         <type>java.lang.Boolean</type>
 166                 </attribute>
 167                 <attribute>
 168                         <name>showAdminDropdownMenu</name>
 169                         <description>Whether to show administrative links to other pages (default: true).</description>
 170                         <required>false</required>
 171                         <type>java.lang.Boolean</type>
 172                 </attribute>
 173         </tag>
 174         <tag>
 175                 <tag-name>outputAdminLandLinePanelGrid</tag-name>
 176                 <description>This tag renders a full p:panelGrid for administrative purposes for land-line data.</description>
 177                 <source>resources/tags/admin/panel_grids/landline/admin_landline_data.tpl</source>
 178                 <attribute>
 179                         <name>renderShowLink</name>
 180                         <description>Whether this tag is used to show land-line data (default true).</description>
 181                         <required>false</required>
 182                         <type>java.lang.Boolean</type>
 183                 </attribute>
 184                 <attribute>
 185                         <name>landLineNumber</name>
 186                         <description>The fax instance that provides the data for this tag.</description>
 187                         <required>true</required>
 188                         <type>org.mxchange.jphone.model.phonenumbers.landline.DialableLandLineNumber</type>
 189                 </attribute>
 190                 <attribute>
 191                         <name>contact</name>
 192                         <description>The contact instance that provides contact data for additional JSF links.</description>
 193                         <required>false</required>
 194                         <type>org.mxchange.jcontacts.model.contact.Contact</type>
 195                 </attribute>
 196                 <attribute>
 197                         <name>rendered</name>
 198                         <description>Whether this tag is being rendered by JSF engine (default: true).</description>
 199                         <required>false</required>
 200                         <type>java.lang.Boolean</type>
 201                 </attribute>
 202                 <attribute>
 203                         <name>showAdminDropdownMenu</name>
 204                         <description>Whether to show administrative links to other pages (default: true).</description>
 205                         <required>false</required>
 206                         <type>java.lang.Boolean</type>
 207                 </attribute>
 208         </tag>
 209         <tag>
 210                 <tag-name>outputAdminMobilePanelGrid</tag-name>
 211                 <description>This tag renders a full p:panelGrid for administrative purposes for mobile data.</description>
 212                 <source>resources/tags/admin/panel_grids/mobile/admin_mobile_data.tpl</source>
 213                 <attribute>
 214                         <name>renderShowLink</name>
 215                         <description>Whether this tag is used to show mobile data (default true).</description>
 216                         <required>false</required>
 217                         <type>java.lang.Boolean</type>
 218                 </attribute>
 219                 <attribute>
 220                         <name>mobileNumber</name>
 221                         <description>The mobile instance that provides the data for this tag.</description>
 222                         <required>true</required>
 223                         <type>org.mxchange.jphone.model.phonenumbers.mobile.DialableMobileNumber</type>
 224                 </attribute>
 225                 <attribute>
 226                         <name>contact</name>
 227                         <description>The contact instance that provides contact data for additional JSF links.</description>
 228                         <required>false</required>
 229                         <type>org.mxchange.jcontacts.model.contact.Contact</type>
 230                 </attribute>
 231                 <attribute>
 232                         <name>rendered</name>
 233                         <description>Whether this tag is being rendered by JSF engine (default: true).</description>
 234                         <required>false</required>
 235                         <type>java.lang.Boolean</type>
 236                 </attribute>
 237                 <attribute>
 238                         <name>showAdminDropdownMenu</name>
 239                         <description>Whether to show administrative links to other pages (default: true).</description>
 240                         <required>false</required>
 241                         <type>java.lang.Boolean</type>
 242                 </attribute>
 243         </tag>
 244         <tag>
 245                 <tag-name>outputFaxInputTableRow</tag-name>
 246                 <description>This tag renders a h:panelGroup with input fields for fax numbers.</description>
 247                 <source>resources/tags/table_rows/fax_input_table_row.tpl</source>
 248                 <attribute>
 249                         <name>targetController</name>
 250                         <description>A target backing bean (EL code resolving into it) extending at least BaseFacesBean where to set the data in.</description>
 251                         <required>true</required>
 252                         <!-- @TODO Find an interface for BaseFacesBean and set it here instead -->
 253                         <type>org.mxchange.jcoreee.bean.faces.BaseFacesBean</type>
 254                 </attribute>
 255                 <attribute>
 256                         <name>labelMessage</name>
 257                         <description>A localized message for the rendered label tag. You should use EL code here to add a label message from your bundle.</description>
 258                         <required>true</required>
 259                         <type>java.lang.String</type>
 260                 </attribute>
 261                 <attribute>
 262                         <name>rendered</name>
 263                         <description>Whether this tag is being rendered by JSF engine (default: true).</description>
 264                         <required>false</required>
 265                         <type>java.lang.Boolean</type>
 266                 </attribute>
 267         </tag>
 268         <tag>
 269                 <tag-name>outputLandLineInputTableRow</tag-name>
 270                 <description>This tag renders a h:panelGroup with input fields for land-line numbers.</description>
 271                 <source>resources/tags/table_rows/landline_input_table_row.tpl</source>
 272                 <attribute>
 273                         <name>targetController</name>
 274                         <description>A target backing bean (EL code resolving into it) extending at least BaseFacesBean where to set the data in.</description>
 275                         <required>true</required>
 276                         <!-- @TODO Find an interface for BaseFacesBean and set it here instead -->
 277                         <type>org.mxchange.jcoreee.bean.faces.BaseFacesBean</type>
 278                 </attribute>
 279                 <attribute>
 280                         <name>labelMessage</name>
 281                         <description>A localized message for the rendered label tag. You should use EL code here to add a label message from your bundle.</description>
 282                         <required>true</required>
 283                         <type>java.lang.String</type>
 284                 </attribute>
 285                 <attribute>
 286                         <name>rendered</name>
 287                         <description>Whether this tag is being rendered by JSF engine (default: true).</description>
 288                         <required>false</required>
 289                         <type>java.lang.Boolean</type>
 290                 </attribute>
 291         </tag>
 292         <tag>
 293                 <tag-name>outputCountrySelector</tag-name>
 294                 <description>This tag renders a selection box for all available countries.</description>
 295                 <source>resources/tags/country/form_data/form_country_selector.tpl</source>
 296                 <attribute>
 297                         <name>rendered</name>
 298                         <description>Whether this tag is being rendered by JSF engine (default: true).</description>
 299                         <required>false</required>
 300                         <type>java.lang.Boolean</type>
 301                 </attribute>
 302                 <attribute>
 303                         <name>allowNone</name>
 304                         <description>Whether this tag allows NONE/null to be selected (default: true).</description>
 305                         <required>false</required>
 306                         <type>java.lang.Boolean</type>
 307                 </attribute>
 308                 <attribute>
 309                         <name>required</name>
 310                         <description>Whether this tag is required (default: false)</description>
 311                         <required>false</required>
 312                         <type>java.lang.Boolean</type>
 313                 </attribute>
 314                 <attribute>
 315                         <name>requiredMessage</name>
 316                         <description>Localizable message to be displayed when this field is required but not selected.</description>
 317                         <required>false</required>
 318                         <type>java.lang.String</type>
 319                 </attribute>
 320                 <attribute>
 321                         <name>id</name>
 322                         <description>Id of the JSF component.</description>
 323                         <required>true</required>
 324                         <type>java.lang.String</type>
 325                 </attribute>
 326                 <attribute>
 327                         <name>styleClass</name>
 328                         <description>CSS style class for this component, default: select.</description>
 329                         <required>false</required>
 330                         <type>java.lang.String</type>
 331                 </attribute>
 332                 <attribute>
 333                         <name>value</name>
 334                         <description>A target property to set the selected country in.</description>
 335                         <required>true</required>
 336                         <type>org.mxchange.jcountry.model.data.Country</type>
 337                 </attribute>
 338         </tag>
 339         <tag>
 340                 <tag-name>inputFaxNumberPanelGrid</tag-name>
 341                 <description>This tag renders input fields for creating a fax number.</description>
 342                 <source>resources/tags/input/panel_grid/fax_input_panel_grid.tpl</source>
 343                 <attribute>
 344                         <name>rendered</name>
 345                         <description>Whether this tag is being rendered by JSF engine (default: true).</description>
 346                         <required>false</required>
 347                         <type>java.lang.Boolean</type>
 348                 </attribute>
 349                 <attribute>
 350                         <name>targetController</name>
 351                         <description>A target backing bean (EL code resolving into it) extending at least BaseFacesBean where to set the data in.</description>
 352                         <required>true</required>
 353                         <!-- @TODO Find an interface for BaseFacesBean and set it here instead -->
 354                         <type>org.mxchange.jcoreee.bean.faces.BaseFacesBean</type>
 355                 </attribute>
 356                 <attribute>
 357                         <name>required</name>
 358                         <description>Whether the fax number is a required field (default: false).</description>
 359                         <required>false</required>
 360                         <type>java.lang.Boolean</type>
 361                 </attribute>
 362         </tag>
 363         <tag>
 364                 <tag-name>inputLandLineNumberPanelGrid</tag-name>
 365                 <description>This tag renders input fields for creating a land-line number.</description>
 366                 <source>resources/tags/input/panel_grid/landline_input_panel_grid.tpl</source>
 367                 <attribute>
 368                         <name>rendered</name>
 369                         <description>Whether this tag is being rendered by JSF engine (default: true)</description>
 370                         <required>false</required>
 371                         <type>java.lang.Boolean</type>
 372                 </attribute>
 373                 <attribute>
 374                         <name>targetController</name>
 375                         <description>A target backing bean (EL code resolving into it) extending at least BaseFacesBean where to set the data in.</description>
 376                         <required>true</required>
 377                         <!-- @TODO Find an interface for BaseFacesBean and set it here instead -->
 378                         <type>org.mxchange.jcoreee.bean.faces.BaseFacesBean</type>
 379                 </attribute>
 380                 <attribute>
 381                         <name>required</name>
 382                         <description>Whether the land-line number is a required field (default: false).</description>
 383                         <required>false</required>
 384                         <type>java.lang.Boolean</type>
 385                 </attribute>
 386         </tag>
 387         <tag>
 388                 <tag-name>inputMobileNumberPanelGrid</tag-name>
 389                 <description>This tag renders input fields for creating a mobile number.</description>
 390                 <source>resources/tags/input/panel_grid/mobile_input_panel_grid.tpl</source>
 391                 <attribute>
 392                         <name>rendered</name>
 393                         <description>Whether this tag is being rendered by JSF engine (default: true).</description>
 394                         <required>false</required>
 395                         <type>java.lang.Boolean</type>
 396                 </attribute>
 397                 <attribute>
 398                         <name>targetController</name>
 399                         <description>A target backing bean (EL code resolving into it) extending at least BaseFacesBean where to set the data in.</description>
 400                         <required>true</required>
 401                         <!-- @TODO Find an interface for BaseFacesBean and set it here instead -->
 402                         <type>org.mxchange.jcoreee.bean.faces.BaseFacesBean</type>
 403                 </attribute>
 404                 <attribute>
 405                         <name>required</name>
 406                         <description>Whether the mobile number is a required field (default: false).</description>
 407                         <required>false</required>
 408                         <type>java.lang.Boolean</type>
 409                 </attribute>
 410         </tag>
 411         <tag>
 412                 <tag-name>outputOpeningTimesDataTable</tag-name>
 413                 <description>This tag renders a full p:dataTable for opening times.</description>
 414                 <source>resources/tags/opening_times/opening_times_data_table.tpl</source>
 415                 <attribute>
 416                         <name>id</name>
 417                         <description>An id string for this tag.</description>
 418                         <required>true</required>
 419                         <type>java.lang.String</type>
 420                 </attribute>
 421                 <attribute>
 422                         <name>value</name>
 423                         <description>A list of OpeningTime objects.</description>
 424                         <required>true</required>
 425                         <type>java.util.List</type>
 426                 </attribute>
 427                 <attribute>
 428                         <name>widgetVar</name>
 429                         <description>Identifier for this widget (e.g. JavaScript).</description>
 430                         <required>true</required>
 431                         <type>java.lang.String</type>
 432                 </attribute>
 433                 <attribute>
 434                         <name>summary</name>
 435                         <description>A string or EL code for table attribute of same name.</description>
 436                         <required>true</required>
 437                         <type>java.lang.String</type>
 438                 </attribute>
 439                 <attribute>
 440                         <name>emptyMessage</name>
 441                         <description>A string or EL code for a message shown when no row was found.</description>
 442                         <required>true</required>
 443                         <type>java.lang.String</type>
 444                 </attribute>
 445                 <attribute>
 446                         <name>headerMessage</name>
 447                         <description>A string or EL code for a message shown above table rows.</description>
 448                         <required>true</required>
 449                         <type>java.lang.String</type>
 450                 </attribute>
 451                 <attribute>
 452                         <name>rows</name>
 453                         <description>Rows to show each page.</description>
 454                         <required>true</required>
 455                         <type>java.lang.Long</type>
 456                 </attribute>
 457                 <attribute>
 458                         <name>rendered</name>
 459                         <description>Whether this tag is being rendered by JSF engine (default: true).</description>
 460                         <required>false</required>
 461                         <type>java.lang.Boolean</type>
 462                 </attribute>
 463         </tag>
 464 </facelet-taglib>