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

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!--
   3 Copyright (C) 2017, 2018 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 version="2.2"
  19                                 xmlns="http://xmlns.jcp.org/xml/ns/javaee"
  20                                 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  21                                 xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-facelettaglibrary_2_2.xsd">
  22         <namespace>http://mxchange.org/jsf/core/widgets</namespace>
  23         <tag>
  24                 <tag-name>outputMessageBox</tag-name>
  25                 <description>This tag renders a style-able and customizable message for any kind of messages that the user should see.</description>
  26                 <source>resources/tags/messages/message_box.tpl</source>
  27                 <attribute>
  28                         <name>message</name>
  29                         <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>
  30                         <required>true</required>
  31                         <type>java.lang.String</type>
  32                 </attribute>
  33                 <attribute>
  34                         <name>id</name>
  35                         <description>Id of the JSF component.</description>
  36                         <required>true</required>
  37                         <type>java.lang.String</type>
  38                 </attribute>
  39                 <attribute>
  40                         <name>rendered</name>
  41                         <description>Whether this tag is being rendered by JSF engine (default: true).</description>
  42                         <required>false</required>
  43                         <type>java.lang.Boolean</type>
  44                 </attribute>
  45                 <attribute>
  46                         <name>boxStyleClass</name>
  47                         <description>The optional CSS style class to be forwarded to the container div of the whole message box. Default is ".message_box" .</description>
  48                         <required>false</required>
  49                         <type>java.lang.String</type>
  50                 </attribute>
  51                 <attribute>
  52                         <name>messageStyleClass</name>
  53                         <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>
  54                         <required>false</required>
  55                         <type>java.lang.String</type>
  56                 </attribute>
  57         </tag>
  58         <tag>
  59                 <tag-name>outputContactDataGridColumns</tag-name>
  60                 <description>This tag renders columns for displaying contact data for administrative views.</description>
  61                 <source>resources/tags/admin/columns/admin_contact_data_columns.tpl</source>
  62         </tag>
  63         <tag>
  64                 <tag-name>outputPersonalTitleSelectionBox</tag-name>
  65                 <description>This tag renders a selection box for user contact's personal title (Mr./Mrs.).</description>
  66                 <source>resources/tags/input/selection_box/personal_title_selection_box.tpl</source>
  67                 <attribute>
  68                         <name>allowEmptyRequiredData</name>
  69                         <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>
  70                         <required>false</required>
  71                         <type>java.lang.Boolean</type>
  72                 </attribute>
  73                 <attribute>
  74                         <name>rendered</name>
  75                         <description>Whether this tag is being rendered by JSF engine (default: true).</description>
  76                         <required>false</required>
  77                         <type>java.lang.Boolean</type>
  78                 </attribute>
  79                 <attribute>
  80                         <name>targetController</name>
  81                         <description>A target backing bean (EL code resolving into it) extending at least BaseFacesBean where to set the data in.</description>
  82                         <required>true</required>
  83                         <!-- @TODO Find an interface for BaseFacesBean and set it here instead -->
  84                         <type>org.mxchange.jcoreee.bean.faces.BaseFacesBean</type>
  85                 </attribute>
  86         </tag>
  87         <tag>
  88                 <tag-name>outputProfileModeTableRow</tag-name>
  89                 <description>This tag renders a selection box for user's profile mode.</description>
  90                 <source>resources/tags/table_rows/user_profile_mode_table_row.tpl</source>
  91                 <attribute>
  92                         <name>labelMessage</name>
  93                         <description>A localized message for the rendered label tag. You should use EL code here to add a label message from your bundle.</description>
  94                         <required>true</required>
  95                         <type>java.lang.String</type>
  96                 </attribute>
  97                 <attribute>
  98                         <name>rendered</name>
  99                         <description>Whether this tag is being rendered by JSF engine (default: true).</description>
 100                         <required>false</required>
 101                         <type>java.lang.Boolean</type>
 102                 </attribute>
 103                 <attribute>
 104                         <name>targetController</name>
 105                         <description>A target backing bean (EL code resolving into it) extending at least BaseFacesBean where to set the data in.</description>
 106                         <required>true</required>
 107                         <!-- @TODO Find an interface for BaseFacesBean and set it here instead -->
 108                         <type>org.mxchange.jcoreee.bean.faces.BaseFacesBean</type>
 109                 </attribute>
 110         </tag>
 111         <tag>
 112                 <tag-name>outputAdminContactDataFormFields</tag-name>
 113                 <description>This tag renders a fieldset for administrative purposes of contact data.</description>
 114                 <source>resources/tags/admin/form_data/contact/admin_form_contact_data.tpl</source>
 115                 <attribute>
 116                         <name>allowEmptyRequiredData</name>
 117                         <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>
 118                         <required>false</required>
 119                         <type>java.lang.Boolean</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>outputAdminFaxDataFormFields</tag-name>
 130                 <description>This tag renders a fieldset for administrative purposes of fax data.</description>
 131                 <source>resources/tags/admin/form_data/fax/admin_form_fax_data.tpl</source>
 132                 <attribute>
 133                         <name>faxNumber</name>
 134                         <description>The fax instance that provides the data for this tag.</description>
 135                         <required>true</required>
 136                         <type>org.mxchange.jphone.model.phonenumbers.fax.DialableFaxNumber</type>
 137                 </attribute>
 138                 <attribute>
 139                         <name>rendered</name>
 140                         <description>Whether this tag is being rendered by JSF engine (default: true).</description>
 141                         <required>false</required>
 142                         <type>java.lang.Boolean</type>
 143                 </attribute>
 144         </tag>
 145         <tag>
 146                 <tag-name>outputAdminLandLineDataFormFields</tag-name>
 147                 <description>This tag renders a fieldset for administrative purposes of land-line data.</description>
 148                 <source>resources/tags/admin/form_data/landline/admin_form_landline_data.tpl</source>
 149                 <attribute>
 150                         <name>landLineNumber</name>
 151                         <description>The fax instance that provides the data for this tag.</description>
 152                         <required>true</required>
 153                         <type>org.mxchange.jphone.model.phonenumbers.landline.DialableLandLineNumber</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         </tag>
 162         <tag>
 163                 <tag-name>outputAdminMobileDataFormFields</tag-name>
 164                 <description>This tag renders a fieldset for administrative purposes of mobile data.</description>
 165                 <source>resources/tags/admin/form_data/mobile/admin_form_mobile_data.tpl</source>
 166                 <attribute>
 167                         <name>mobileNumber</name>
 168                         <description>The mobile instance that provides the data for this tag.</description>
 169                         <required>true</required>
 170                         <type>org.mxchange.jphone.model.phonenumbers.mobile.DialableMobileNumber</type>
 171                 </attribute>
 172                 <attribute>
 173                         <name>rendered</name>
 174                         <description>Whether this tag is being rendered by JSF engine (default: true).</description>
 175                         <required>false</required>
 176                         <type>java.lang.Boolean</type>
 177                 </attribute>
 178         </tag>
 179         <tag>
 180                 <tag-name>outputAdminUserDataFormFields</tag-name>
 181                 <description>This tag renders a fieldset for administrative purposes of user data.</description>
 182                 <source>resources/tags/admin/form_data/user/admin_form_user_data.tpl</source>
 183                 <attribute>
 184                         <name>mode</name>
 185                         <description>Mode of the form, must be one of "add" or "edit".</description>
 186                         <required>true</required>
 187                         <type>java.lang.String</type>
 188                 </attribute>
 189         </tag>
 190         <tag>
 191                 <tag-name>outputAdminFaxPanelGrid</tag-name>
 192                 <description>This tag renders a full p:panelGrid for administrative purposes for fax data.</description>
 193                 <source>resources/tags/admin/panel_grids/fax/admin_fax_data.tpl</source>
 194                 <attribute>
 195                         <name>renderShowLink</name>
 196                         <description>Whether this tag is used to show fax data (default true).</description>
 197                         <required>false</required>
 198                         <type>java.lang.Boolean</type>
 199                 </attribute>
 200                 <attribute>
 201                         <name>faxNumber</name>
 202                         <description>The fax instance that provides the data for this tag.</description>
 203                         <required>true</required>
 204                         <type>org.mxchange.jphone.model.phonenumbers.fax.DialableFaxNumber</type>
 205                 </attribute>
 206                 <attribute>
 207                         <name>contact</name>
 208                         <description>The contact instance that provides contact data for additional JSF links.</description>
 209                         <required>false</required>
 210                         <type>org.mxchange.jcontacts.model.contact.Contact</type>
 211                 </attribute>
 212                 <attribute>
 213                         <name>rendered</name>
 214                         <description>Whether this tag is being rendered by JSF engine (default: true).</description>
 215                         <required>false</required>
 216                         <type>java.lang.Boolean</type>
 217                 </attribute>
 218                 <attribute>
 219                         <name>showAdminMiniLinks</name>
 220                         <description>Whether to show administrative links to other pages (default: true).</description>
 221                         <required>false</required>
 222                         <type>java.lang.Boolean</type>
 223                 </attribute>
 224         </tag>
 225         <tag>
 226                 <tag-name>outputAdminLandLinePanelGrid</tag-name>
 227                 <description>This tag renders a full p:panelGrid for administrative purposes for land-line data.</description>
 228                 <source>resources/tags/admin/panel_grids/landline/admin_landline_data.tpl</source>
 229                 <attribute>
 230                         <name>renderShowLink</name>
 231                         <description>Whether this tag is used to show land-line data (default true).</description>
 232                         <required>false</required>
 233                         <type>java.lang.Boolean</type>
 234                 </attribute>
 235                 <attribute>
 236                         <name>landLineNumber</name>
 237                         <description>The fax instance that provides the data for this tag.</description>
 238                         <required>true</required>
 239                         <type>org.mxchange.jphone.model.phonenumbers.landline.DialableLandLineNumber</type>
 240                 </attribute>
 241                 <attribute>
 242                         <name>contact</name>
 243                         <description>The contact instance that provides contact data for additional JSF links.</description>
 244                         <required>false</required>
 245                         <type>org.mxchange.jcontacts.model.contact.Contact</type>
 246                 </attribute>
 247                 <attribute>
 248                         <name>rendered</name>
 249                         <description>Whether this tag is being rendered by JSF engine (default: true).</description>
 250                         <required>false</required>
 251                         <type>java.lang.Boolean</type>
 252                 </attribute>
 253                 <attribute>
 254                         <name>showAdminMiniLinks</name>
 255                         <description>Whether to show administrative links to other pages (default: true).</description>
 256                         <required>false</required>
 257                         <type>java.lang.Boolean</type>
 258                 </attribute>
 259         </tag>
 260         <tag>
 261                 <tag-name>outputAdminMobilePanelGrid</tag-name>
 262                 <description>This tag renders a full p:panelGrid for administrative purposes for mobile data.</description>
 263                 <source>resources/tags/admin/panel_grids/mobile/admin_mobile_data.tpl</source>
 264                 <attribute>
 265                         <name>renderShowLink</name>
 266                         <description>Whether this tag is used to show mobile data (default true).</description>
 267                         <required>false</required>
 268                         <type>java.lang.Boolean</type>
 269                 </attribute>
 270                 <attribute>
 271                         <name>mobileNumber</name>
 272                         <description>The mobile instance that provides the data for this tag.</description>
 273                         <required>true</required>
 274                         <type>org.mxchange.jphone.model.phonenumbers.mobile.DialableMobileNumber</type>
 275                 </attribute>
 276                 <attribute>
 277                         <name>contact</name>
 278                         <description>The contact instance that provides contact data for additional JSF links.</description>
 279                         <required>false</required>
 280                         <type>org.mxchange.jcontacts.model.contact.Contact</type>
 281                 </attribute>
 282                 <attribute>
 283                         <name>rendered</name>
 284                         <description>Whether this tag is being rendered by JSF engine (default: true).</description>
 285                         <required>false</required>
 286                         <type>java.lang.Boolean</type>
 287                 </attribute>
 288                 <attribute>
 289                         <name>showAdminMiniLinks</name>
 290                         <description>Whether to show administrative links to other pages (default: true).</description>
 291                         <required>false</required>
 292                         <type>java.lang.Boolean</type>
 293                 </attribute>
 294         </tag>
 295         <tag>
 296                 <tag-name>outputFaxInputTableRow</tag-name>
 297                 <description>This tag renders a h:panelGroup with input fields for fax numbers.</description>
 298                 <source>resources/tags/table_rows/fax_input_table_row.tpl</source>
 299                 <attribute>
 300                         <name>targetController</name>
 301                         <description>A target backing bean (EL code resolving into it) extending at least BaseFacesBean where to set the data in.</description>
 302                         <required>true</required>
 303                         <!-- @TODO Find an interface for BaseFacesBean and set it here instead -->
 304                         <type>org.mxchange.jcoreee.bean.faces.BaseFacesBean</type>
 305                 </attribute>
 306                 <attribute>
 307                         <name>labelMessage</name>
 308                         <description>A localized message for the rendered label tag. You should use EL code here to add a label message from your bundle.</description>
 309                         <required>true</required>
 310                         <type>java.lang.String</type>
 311                 </attribute>
 312                 <attribute>
 313                         <name>rendered</name>
 314                         <description>Whether this tag is being rendered by JSF engine (default: true).</description>
 315                         <required>false</required>
 316                         <type>java.lang.Boolean</type>
 317                 </attribute>
 318         </tag>
 319         <tag>
 320                 <tag-name>outputLandLineInputTableRow</tag-name>
 321                 <description>This tag renders a h:panelGroup with input fields for land-line numbers.</description>
 322                 <source>resources/tags/table_rows/landline_input_table_row.tpl</source>
 323                 <attribute>
 324                         <name>targetController</name>
 325                         <description>A target backing bean (EL code resolving into it) extending at least BaseFacesBean where to set the data in.</description>
 326                         <required>true</required>
 327                         <!-- @TODO Find an interface for BaseFacesBean and set it here instead -->
 328                         <type>org.mxchange.jcoreee.bean.faces.BaseFacesBean</type>
 329                 </attribute>
 330                 <attribute>
 331                         <name>labelMessage</name>
 332                         <description>A localized message for the rendered label tag. You should use EL code here to add a label message from your bundle.</description>
 333                         <required>true</required>
 334                         <type>java.lang.String</type>
 335                 </attribute>
 336                 <attribute>
 337                         <name>rendered</name>
 338                         <description>Whether this tag is being rendered by JSF engine (default: true).</description>
 339                         <required>false</required>
 340                         <type>java.lang.Boolean</type>
 341                 </attribute>
 342         </tag>
 343         <tag>
 344                 <tag-name>outputCountrySelector</tag-name>
 345                 <description>This tag renders a selection box for all available countries.</description>
 346                 <source>resources/tags/country/form_data/form_country_selector.tpl</source>
 347                 <attribute>
 348                         <name>rendered</name>
 349                         <description>Whether this tag is being rendered by JSF engine (default: true).</description>
 350                         <required>false</required>
 351                         <type>java.lang.Boolean</type>
 352                 </attribute>
 353                 <attribute>
 354                         <name>allowNone</name>
 355                         <description>Whether this tag allows NONE/null to be selected (default: true).</description>
 356                         <required>false</required>
 357                         <type>java.lang.Boolean</type>
 358                 </attribute>
 359                 <attribute>
 360                         <name>required</name>
 361                         <description>Whether this tag is required (default: false)</description>
 362                         <required>false</required>
 363                         <type>java.lang.Boolean</type>
 364                 </attribute>
 365                 <attribute>
 366                         <name>requiredMessage</name>
 367                         <description>Localizable message to be displayed when this field is required but not selected.</description>
 368                         <required>false</required>
 369                         <type>java.lang.String</type>
 370                 </attribute>
 371                 <attribute>
 372                         <name>id</name>
 373                         <description>Id of the JSF component.</description>
 374                         <required>true</required>
 375                         <type>java.lang.String</type>
 376                 </attribute>
 377                 <attribute>
 378                         <name>styleClass</name>
 379                         <description>CSS style class for this component, default: select.</description>
 380                         <required>false</required>
 381                         <type>java.lang.String</type>
 382                 </attribute>
 383                 <attribute>
 384                         <name>value</name>
 385                         <description>A target property to set the selected country in.</description>
 386                         <required>true</required>
 387                         <type>org.mxchange.jcountry.model.data.Country</type>
 388                 </attribute>
 389         </tag>
 390         <tag>
 391                 <tag-name>inputFaxNumberPanelGrid</tag-name>
 392                 <description>This tag renders input fields for creating a fax number.</description>
 393                 <source>resources/tags/input/panel_grid/fax_input_panel_grid.tpl</source>
 394                 <attribute>
 395                         <name>rendered</name>
 396                         <description>Whether this tag is being rendered by JSF engine (default: true).</description>
 397                         <required>false</required>
 398                         <type>java.lang.Boolean</type>
 399                 </attribute>
 400                 <attribute>
 401                         <name>targetController</name>
 402                         <description>A target backing bean (EL code resolving into it) extending at least BaseFacesBean where to set the data in.</description>
 403                         <required>true</required>
 404                         <!-- @TODO Find an interface for BaseFacesBean and set it here instead -->
 405                         <type>org.mxchange.jcoreee.bean.faces.BaseFacesBean</type>
 406                 </attribute>
 407         </tag>
 408         <tag>
 409                 <tag-name>inputLandLineNumberPanelGrid</tag-name>
 410                 <description>This tag renders input fields for creating a land-line number.</description>
 411                 <source>resources/tags/input/panel_grid/landline_input_panel_grid.tpl</source>
 412                 <attribute>
 413                         <name>rendered</name>
 414                         <description>Whether this tag is being rendered by JSF engine (default: true).</description>
 415                         <required>false</required>
 416                         <type>java.lang.Boolean</type>
 417                 </attribute>
 418                 <attribute>
 419                         <name>targetController</name>
 420                         <description>A target backing bean (EL code resolving into it) extending at least BaseFacesBean where to set the data in.</description>
 421                         <required>true</required>
 422                         <!-- @TODO Find an interface for BaseFacesBean and set it here instead -->
 423                         <type>org.mxchange.jcoreee.bean.faces.BaseFacesBean</type>
 424                 </attribute>
 425         </tag>
 426         <tag>
 427                 <tag-name>inputMobileNumberPanelGrid</tag-name>
 428                 <description>This tag renders input fields for creating a mobile number.</description>
 429                 <source>resources/tags/input/panel_grid/mobile_input_panel_grid.tpl</source>
 430                 <attribute>
 431                         <name>rendered</name>
 432                         <description>Whether this tag is being rendered by JSF engine (default: true).</description>
 433                         <required>false</required>
 434                         <type>java.lang.Boolean</type>
 435                 </attribute>
 436                 <attribute>
 437                         <name>targetController</name>
 438                         <description>A target backing bean (EL code resolving into it) extending at least BaseFacesBean where to set the data in.</description>
 439                         <required>true</required>
 440                         <!-- @TODO Find an interface for BaseFacesBean and set it here instead -->
 441                         <type>org.mxchange.jcoreee.bean.faces.BaseFacesBean</type>
 442                 </attribute>
 443         </tag>
 444 </facelet-taglib>