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

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!--
   3 Copyright (C) 2017 Roland Häder
   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>rendered</name>
  35                         <description>Whether this tag is being rendered by JSF engine.</description>
  36                         <required>false</required>
  37                         <type>java.lang.Boolean</type>
  38                 </attribute>
  39                 <attribute>
  40                         <name>boxStyleClass</name>
  41                         <description>The optional CSS style class to be forwarded to the container div of the whole message box. Default is ".message_box" .</description>
  42                         <required>false</required>
  43                         <type>java.lang.String</type>
  44                 </attribute>
  45                 <attribute>
  46                         <name>messageStyleClass</name>
  47                         <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>
  48                         <required>false</required>
  49                         <type>java.lang.String</type>
  50                 </attribute>
  51         </tag>
  52         <tag>
  53                 <tag-name>outputContactDataGridColumns</tag-name>
  54                 <description>This tag renders columns for displaying contact data for administrative views.</description>
  55                 <source>resources/tags/admin/columns/admin_contact_data_columns.tpl</source>
  56         </tag>
  57         <tag>
  58                 <tag-name>outputPersonalTitleTableRow</tag-name>
  59                 <description>This tag renders a selection box for user contact's personal title (Mr./Mrs.).</description>
  60                 <source>resources/tags/table_rows/user_personal_title_table_row.tpl</source>
  61                 <attribute>
  62                         <name>allowEmptyRequiredData</name>
  63                         <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>
  64                         <required>false</required>
  65                         <type>java.lang.Boolean</type>
  66                 </attribute>
  67                 <attribute>
  68                         <name>rendered</name>
  69                         <description>Whether this tag is being rendered by JSF engine.</description>
  70                         <required>false</required>
  71                         <type>java.lang.Boolean</type>
  72                 </attribute>
  73                 <attribute>
  74                         <name>targetController</name>
  75                         <description>A target backing bean (EL code resolving into it) extending at least BaseFacesBean where to set the data in.</description>
  76                         <required>true</required>
  77                         <!-- @TODO Find an interface for BaseFacesBean and set it here instead -->
  78                         <type>org.mxchange.jcoreee.bean.faces.BaseFacesBean</type>
  79                 </attribute>
  80         </tag>
  81         <tag>
  82                 <tag-name>outputMobileNumberTableRow</tag-name>
  83                 <description>This tag renders a selection box for contact's personal title (Mr./Mrs.).</description>
  84                 <source>resources/tags/table_rows/mobile_selection_table_row.tpl</source>
  85                 <attribute>
  86                         <name>labelMessage</name>
  87                         <description>A localized message for the rendered label tag. You should use EL code here to add a label message from your bundle.</description>
  88                         <required>true</required>
  89                         <!-- @TODO Find an interface for BaseFacesBean and set it here instead -->
  90                         <type>org.mxchange.jcoreee.bean.faces.BaseFacesBean</type>
  91                 </attribute>
  92                 <attribute>
  93                         <name>rendered</name>
  94                         <description>Whether this tag is being rendered by JSF engine.</description>
  95                         <required>false</required>
  96                         <type>java.lang.Boolean</type>
  97                 </attribute>
  98                 <attribute>
  99                         <name>targetController</name>
 100                         <description>A target backing bean (EL code resolving into it) extending at least BaseFacesBean where to set the data in.</description>
 101                         <required>true</required>
 102                         <!-- @TODO Find an interface for BaseFacesBean and set it here instead -->
 103                         <type>org.mxchange.jcoreee.bean.faces.BaseFacesBean</type>
 104                 </attribute>
 105         </tag>
 106         <tag>
 107                 <tag-name>outputProfileModeTableRow</tag-name>
 108                 <description>This tag renders a selection box for user's profile mode.</description>
 109                 <source>resources/tags/table_rows/user_profile_mode_table_row.tpl</source>
 110                 <attribute>
 111                         <name>labelMessage</name>
 112                         <description>A localized message for the rendered label tag. You should use EL code here to add a label message from your bundle.</description>
 113                         <required>true</required>
 114                         <type>java.lang.String</type>
 115                 </attribute>
 116                 <attribute>
 117                         <name>rendered</name>
 118                         <description>Whether this tag is being rendered by JSF engine.</description>
 119                         <required>false</required>
 120                         <type>java.lang.Boolean</type>
 121                 </attribute>
 122                 <attribute>
 123                         <name>targetController</name>
 124                         <description>A target backing bean (EL code resolving into it) extending at least BaseFacesBean where to set the data in.</description>
 125                         <required>true</required>
 126                         <!-- @TODO Find an interface for BaseFacesBean and set it here instead -->
 127                         <type>org.mxchange.jcoreee.bean.faces.BaseFacesBean</type>
 128                 </attribute>
 129         </tag>
 130         <tag>
 131                 <tag-name>outputAdminContactDataFormFields</tag-name>
 132                 <description>This tag renders a fieldset for administrative purposes of contact data.</description>
 133                 <source>resources/tags/admin/form_data/contact/admin_form_contact_data.tpl</source>
 134                 <attribute>
 135                         <name>allowEmptyRequiredData</name>
 136                         <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>
 137                         <required>false</required>
 138                         <type>java.lang.Boolean</type>
 139                 </attribute>
 140         </tag>
 141         <tag>
 142                 <tag-name>outputAdminFaxDataFormFields</tag-name>
 143                 <description>This tag renders a fieldset for administrative purposes of fax data.</description>
 144                 <source>resources/tags/admin/form_data/fax/admin_form_fax_data.tpl</source>
 145                 <attribute>
 146                         <name>faxNumber</name>
 147                         <description>The fax instance that provides the data for this tag.</description>
 148                         <required>true</required>
 149                         <type>org.mxchange.jphone.phonenumbers.fax.DialableFaxNumber</type>
 150                 </attribute>
 151                 <attribute>
 152                         <name>rendered</name>
 153                         <description>Whether this tag is being rendered by JSF engine.</description>
 154                         <required>false</required>
 155                         <type>java.lang.Boolean</type>
 156                 </attribute>
 157         </tag>
 158         <tag>
 159                 <tag-name>outputAdminLandLineDataFormFields</tag-name>
 160                 <description>This tag renders a fieldset for administrative purposes of land-line data.</description>
 161                 <source>resources/tags/admin/form_data/landline/admin_form_landline_data.tpl</source>
 162                 <attribute>
 163                         <name>landLineNumber</name>
 164                         <description>The fax instance that provides the data for this tag.</description>
 165                         <required>true</required>
 166                         <type>org.mxchange.jphone.phonenumbers.landline.DialableLandLineNumber</type>
 167                 </attribute>
 168                 <attribute>
 169                         <name>rendered</name>
 170                         <description>Whether this tag is being rendered by JSF engine.</description>
 171                         <required>false</required>
 172                         <type>java.lang.Boolean</type>
 173                 </attribute>
 174         </tag>
 175         <tag>
 176                 <tag-name>outputAdminMobileDataFormFields</tag-name>
 177                 <description>This tag renders a fieldset for administrative purposes of mobile data.</description>
 178                 <source>resources/tags/admin/form_data/mobile/admin_form_mobile_data.tpl</source>
 179                 <attribute>
 180                         <name>mobileNumber</name>
 181                         <description>The mobile instance that provides the data for this tag.</description>
 182                         <required>true</required>
 183                         <type>org.mxchange.jphone.phonenumbers.mobile.DialableMobileNumber</type>
 184                 </attribute>
 185                 <attribute>
 186                         <name>rendered</name>
 187                         <description>Whether this tag is being rendered by JSF engine.</description>
 188                         <required>false</required>
 189                         <type>java.lang.Boolean</type>
 190                 </attribute>
 191         </tag>
 192         <tag>
 193                 <tag-name>outputAdminUserDataFormFields</tag-name>
 194                 <description>This tag renders a fieldset for administrative purposes of user data.</description>
 195                 <source>resources/tags/admin/form_data/user/admin_form_user_data.tpl</source>
 196                 <attribute>
 197                         <name>mode</name>
 198                         <description>Mode of the form, must be one of "add" or "edit".</description>
 199                         <required>true</required>
 200                         <type>java.lang.String</type>
 201                 </attribute>
 202         </tag>
 203         <tag>
 204                 <tag-name>outputUserProfileLink</tag-name>
 205                 <description>This tag renders a h:link JSF tag for a user profile.</description>
 206                 <source>resources/tags/profile/user/user_profile_link.tpl</source>
 207                 <attribute>
 208                         <name>user</name>
 209                         <description>An instance of a User class.</description>
 210                         <required>true</required>
 211                         <type>org.mxchange.jusercore.model.user.User</type>
 212                 </attribute>
 213         </tag>
 214         <tag>
 215                 <tag-name>outputAdminFaxPanelGrid</tag-name>
 216                 <description>This tag renders a full h:panelGrid for administrative purposes for fax data.</description>
 217                 <source>resources/tags/admin/panel_grids/fax/admin_fax_data.tpl</source>
 218                 <attribute>
 219                         <name>isShowPage</name>
 220                         <description>Whether this tag is used to show mobile data (default true).</description>
 221                         <required>false</required>
 222                         <type>java.lang.Boolean</type>
 223                 </attribute>
 224                 <attribute>
 225                         <name>faxNumber</name>
 226                         <description>The fax instance that provides the data for this tag.</description>
 227                         <required>true</required>
 228                         <type>org.mxchange.jphone.phonenumbers.fax.DialableFaxNumber</type>
 229                 </attribute>
 230                 <attribute>
 231                         <name>contact</name>
 232                         <description>The contact instance that provides contact data for additional JSF links.</description>
 233                         <required>false</required>
 234                         <type>org.mxchange.jcontacts.contact.Contact</type>
 235                 </attribute>
 236                 <attribute>
 237                         <name>rendered</name>
 238                         <description>Whether this tag is being rendered by JSF engine.</description>
 239                         <required>false</required>
 240                         <type>java.lang.Boolean</type>
 241                 </attribute>
 242                 <attribute>
 243                         <name>showAdminLinks</name>
 244                         <description>Whether to show administrative links to other pages (default: true).</description>
 245                         <required>false</required>
 246                         <type>java.lang.Boolean</type>
 247                 </attribute>
 248         </tag>
 249         <tag>
 250                 <tag-name>outputAdminLandLinePanelGrid</tag-name>
 251                 <description>This tag renders a full h:panelGrid for administrative purposes for land-line data.</description>
 252                 <source>resources/tags/admin/panel_grids/landline/admin_landline_data.tpl</source>
 253                 <attribute>
 254                         <name>isShowPage</name>
 255                         <description>Whether this tag is used to show mobile data (default true).</description>
 256                         <required>false</required>
 257                         <type>java.lang.Boolean</type>
 258                 </attribute>
 259                 <attribute>
 260                         <name>landLineNumber</name>
 261                         <description>The fax instance that provides the data for this tag.</description>
 262                         <required>true</required>
 263                         <type>org.mxchange.jphone.phonenumbers.landline.DialableLandLineNumber</type>
 264                 </attribute>
 265                 <attribute>
 266                         <name>contact</name>
 267                         <description>The contact instance that provides contact data for additional JSF links.</description>
 268                         <required>false</required>
 269                         <type>org.mxchange.jcontacts.contact.Contact</type>
 270                 </attribute>
 271                 <attribute>
 272                         <name>rendered</name>
 273                         <description>Whether this tag is being rendered by JSF engine.</description>
 274                         <required>false</required>
 275                         <type>java.lang.Boolean</type>
 276                 </attribute>
 277                 <attribute>
 278                         <name>showAdminLinks</name>
 279                         <description>Whether to show administrative links to other pages (default: true).</description>
 280                         <required>false</required>
 281                         <type>java.lang.Boolean</type>
 282                 </attribute>
 283         </tag>
 284         <tag>
 285                 <tag-name>outputAdminMobilePanelGrid</tag-name>
 286                 <description>This tag renders a full h:panelGrid for administrative purposes for mobile data.</description>
 287                 <source>resources/tags/admin/panel_grids/mobile/admin_mobile_data.tpl</source>
 288                 <attribute>
 289                         <name>isShowPage</name>
 290                         <description>Whether this tag is used to show mobile data (default true).</description>
 291                         <required>false</required>
 292                         <type>java.lang.Boolean</type>
 293                 </attribute>
 294                 <attribute>
 295                         <name>mobileNumber</name>
 296                         <description>The mobile instance that provides the data for this tag.</description>
 297                         <required>true</required>
 298                         <type>org.mxchange.jphone.phonenumbers.mobile.DialableMobileNumber</type>
 299                 </attribute>
 300                 <attribute>
 301                         <name>contact</name>
 302                         <description>The contact instance that provides contact data for additional JSF links.</description>
 303                         <required>false</required>
 304                         <type>org.mxchange.jcontacts.contact.Contact</type>
 305                 </attribute>
 306                 <attribute>
 307                         <name>rendered</name>
 308                         <description>Whether this tag is being rendered by JSF engine.</description>
 309                         <required>false</required>
 310                         <type>java.lang.Boolean</type>
 311                 </attribute>
 312                 <attribute>
 313                         <name>showAdminLinks</name>
 314                         <description>Whether to show administrative links to other pages (default: true).</description>
 315                         <required>false</required>
 316                         <type>java.lang.Boolean</type>
 317                 </attribute>
 318         </tag>
 319         <tag>
 320                 <tag-name>outputFaxInputTableRow</tag-name>
 321                 <description>This tag renders a h:panelGroup with input fields for fax numbers.</description>
 322                 <source>resources/tags/table_rows/fax_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.</description>
 339                         <required>false</required>
 340                         <type>java.lang.Boolean</type>
 341                 </attribute>
 342         </tag>
 343         <tag>
 344                 <tag-name>outputLandLineInputTableRow</tag-name>
 345                 <description>This tag renders a h:panelGroup with input fields for land-line numbers.</description>
 346                 <source>resources/tags/table_rows/landline_input_table_row.tpl</source>
 347                 <attribute>
 348                         <name>targetController</name>
 349                         <description>A target backing bean (EL code resolving into it) extending at least BaseFacesBean where to set the data in.</description>
 350                         <required>true</required>
 351                         <!-- @TODO Find an interface for BaseFacesBean and set it here instead -->
 352                         <type>org.mxchange.jcoreee.bean.faces.BaseFacesBean</type>
 353                 </attribute>
 354                 <attribute>
 355                         <name>labelMessage</name>
 356                         <description>A localized message for the rendered label tag. You should use EL code here to add a label message from your bundle.</description>
 357                         <required>true</required>
 358                         <type>java.lang.String</type>
 359                 </attribute>
 360                 <attribute>
 361                         <name>rendered</name>
 362                         <description>Whether this tag is being rendered by JSF engine.</description>
 363                         <required>false</required>
 364                         <type>java.lang.Boolean</type>
 365                 </attribute>
 366         </tag>
 367         <tag>
 368                 <tag-name>outputAdminFaxLinks</tag-name>
 369                 <description>This tag renders a full h:panelGroup for administrative links for fax data.</description>
 370                 <source>resources/tags/admin/links/fax/admin_fax_data.tpl</source>
 371                 <attribute>
 372                         <name>isShowPage</name>
 373                         <description>Whether this tag is used to show mobile data (default true).</description>
 374                         <required>false</required>
 375                         <type>java.lang.Boolean</type>
 376                 </attribute>
 377                 <attribute>
 378                         <name>faxNumber</name>
 379                         <description>The fax instance that provides the data for this tag.</description>
 380                         <required>true</required>
 381                         <type>org.mxchange.jphone.phonenumbers.fax.DialableFaxNumber</type>
 382                 </attribute>
 383                 <attribute>
 384                         <name>contact</name>
 385                         <description>The contact instance that provides contact data for additional JSF links.</description>
 386                         <required>false</required>
 387                         <type>org.mxchange.jcontacts.contact.Contact</type>
 388                 </attribute>
 389                 <attribute>
 390                         <name>rendered</name>
 391                         <description>Whether this tag is being rendered by JSF engine.</description>
 392                         <required>false</required>
 393                         <type>java.lang.Boolean</type>
 394                 </attribute>
 395         </tag>
 396         <tag>
 397                 <tag-name>outputAdminLandLineLinks</tag-name>
 398                 <description>This tag renders a full h:panelGroup for administrative links for land-line data.</description>
 399                 <source>resources/tags/admin/panel_grids/landline/admin_landline_data.tpl</source>
 400                 <attribute>
 401                         <name>isShowPage</name>
 402                         <description>Whether this tag is used to show mobile data (default true).</description>
 403                         <required>false</required>
 404                         <type>java.lang.Boolean</type>
 405                 </attribute>
 406                 <attribute>
 407                         <name>landLineNumber</name>
 408                         <description>The fax instance that provides the data for this tag.</description>
 409                         <required>true</required>
 410                         <type>org.mxchange.jphone.phonenumbers.landline.DialableLandLineNumber</type>
 411                 </attribute>
 412                 <attribute>
 413                         <name>contact</name>
 414                         <description>The contact instance that provides contact data for additional JSF links.</description>
 415                         <required>false</required>
 416                         <type>org.mxchange.jcontacts.contact.Contact</type>
 417                 </attribute>
 418                 <attribute>
 419                         <name>rendered</name>
 420                         <description>Whether this tag is being rendered by JSF engine.</description>
 421                         <required>false</required>
 422                         <type>java.lang.Boolean</type>
 423                 </attribute>
 424         </tag>
 425         <tag>
 426                 <tag-name>outputAdminMobileLinks</tag-name>
 427                 <description>This tag renders a full h:panelGroup for administrative links for mobile data.</description>
 428                 <source>resources/tags/admin/panel_grids/mobile/admin_mobile_data.tpl</source>
 429                 <attribute>
 430                         <name>isShowPage</name>
 431                         <description>Whether this tag is used to show mobile data (default true).</description>
 432                         <required>false</required>
 433                         <type>java.lang.Boolean</type>
 434                 </attribute>
 435                 <attribute>
 436                         <name>mobileNumber</name>
 437                         <description>The mobile instance that provides the data for this tag.</description>
 438                         <required>true</required>
 439                         <type>org.mxchange.jphone.phonenumbers.mobile.DialableMobileNumber</type>
 440                 </attribute>
 441                 <attribute>
 442                         <name>contact</name>
 443                         <description>The contact instance that provides contact data for additional JSF links.</description>
 444                         <required>false</required>
 445                         <type>org.mxchange.jcontacts.contact.Contact</type>
 446                 </attribute>
 447                 <attribute>
 448                         <name>rendered</name>
 449                         <description>Whether this tag is being rendered by JSF engine.</description>
 450                         <required>false</required>
 451                         <type>java.lang.Boolean</type>
 452                 </attribute>
 453         </tag>
 454 </facelet-taglib>