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>outputAdminUserDataFormFields</tag-name>
 143                 <description>This tag renders a fieldset for administrative purposes of user data.</description>
 144                 <source>resources/tags/admin/form_data/user/admin_form_user_data.tpl</source>
 145                 <attribute>
 146                         <name>mode</name>
 147                         <description>Mode of the form, must be one of "add" or "edit".</description>
 148                         <required>true</required>
 149                         <type>java.lang.String</type>
 150                 </attribute>
 151         </tag>
 152         <tag>
 153                 <tag-name>outputUserProfileLink</tag-name>
 154                 <description>This tag renders a h:link JSF tag for a user profile.</description>
 155                 <source>resources/tags/profile/user/user_profile_link.tpl</source>
 156                 <attribute>
 157                         <name>user</name>
 158                         <description>An instance of a User class.</description>
 159                         <required>true</required>
 160                         <type>org.mxchange.jusercore.model.user.User</type>
 161                 </attribute>
 162         </tag>
 163         <tag>
 164                 <tag-name>outputAdminFaxPanelGrid</tag-name>
 165                 <description>This tag renders a full h:panelGrid for administrative purposes for fax data.</description>
 166                 <source>resources/tags/admin/panel_grids/fax/admin_fax_data.tpl</source>
 167                 <attribute>
 168                         <name>isShowPage</name>
 169                         <description>Whether this tag is used to show mobile data (default true).</description>
 170                         <required>false</required>
 171                         <type>java.lang.Boolean</type>
 172                 </attribute>
 173                 <attribute>
 174                         <name>faxNumber</name>
 175                         <description>The fax instance that provides the data for this tag.</description>
 176                         <required>true</required>
 177                         <type>org.mxchange.jphone.phonenumbers.fax.DialableFaxNumber</type>
 178                 </attribute>
 179                 <attribute>
 180                         <name>rendered</name>
 181                         <description>Whether this tag is being rendered by JSF engine.</description>
 182                         <required>false</required>
 183                         <type>java.lang.Boolean</type>
 184                 </attribute>
 185                 <attribute>
 186                         <name>showAdminLinks</name>
 187                         <description>Whether to show administrative links to other pages (default: true).</description>
 188                         <required>false</required>
 189                         <type>java.lang.Boolean</type>
 190                 </attribute>
 191         </tag>
 192         <tag>
 193                 <tag-name>outputAdminLandLinePanelGrid</tag-name>
 194                 <description>This tag renders a full h:panelGrid for administrative purposes for land-line data.</description>
 195                 <source>resources/tags/admin/panel_grids/landline/admin_landline_data.tpl</source>
 196                 <attribute>
 197                         <name>isShowPage</name>
 198                         <description>Whether this tag is used to show mobile data (default true).</description>
 199                         <required>false</required>
 200                         <type>java.lang.Boolean</type>
 201                 </attribute>
 202                 <attribute>
 203                         <name>landLineNumber</name>
 204                         <description>The fax instance that provides the data for this tag.</description>
 205                         <required>true</required>
 206                         <type>org.mxchange.jphone.phonenumbers.landline.DialableLandLineNumber</type>
 207                 </attribute>
 208                 <attribute>
 209                         <name>rendered</name>
 210                         <description>Whether this tag is being rendered by JSF engine.</description>
 211                         <required>false</required>
 212                         <type>java.lang.Boolean</type>
 213                 </attribute>
 214                 <attribute>
 215                         <name>showAdminLinks</name>
 216                         <description>Whether to show administrative links to other pages (default: true).</description>
 217                         <required>false</required>
 218                         <type>java.lang.Boolean</type>
 219                 </attribute>
 220         </tag>
 221         <tag>
 222                 <tag-name>outputAdminMobilePanelGrid</tag-name>
 223                 <description>This tag renders a full h:panelGrid for administrative purposes for mobile data.</description>
 224                 <source>resources/tags/admin/panel_grids/mobile/admin_mobile_data.tpl</source>
 225                 <attribute>
 226                         <name>isShowPage</name>
 227                         <description>Whether this tag is used to show mobile data (default true).</description>
 228                         <required>false</required>
 229                         <type>java.lang.Boolean</type>
 230                 </attribute>
 231                 <attribute>
 232                         <name>mobileNumber</name>
 233                         <description>The mobile instance that provides the data for this tag.</description>
 234                         <required>true</required>
 235                         <type>org.mxchange.jphone.phonenumbers.mobile.DialableMobileNumber</type>
 236                 </attribute>
 237                 <attribute>
 238                         <name>rendered</name>
 239                         <description>Whether this tag is being rendered by JSF engine.</description>
 240                         <required>false</required>
 241                         <type>java.lang.Boolean</type>
 242                 </attribute>
 243                 <attribute>
 244                         <name>showAdminLinks</name>
 245                         <description>Whether to show administrative links to other pages (default: true).</description>
 246                         <required>false</required>
 247                         <type>java.lang.Boolean</type>
 248                 </attribute>
 249         </tag>
 250         <tag>
 251                 <tag-name>outputFaxInputTableRow</tag-name>
 252                 <description>This tag renders a h:panelGroup with input fields for fax numbers.</description>
 253                 <source>resources/tags/table_rows/fax_input_table_row.tpl</source>
 254                 <attribute>
 255                         <name>targetController</name>
 256                         <description>A target backing bean (EL code resolving into it) extending at least BaseFacesBean where to set the data in.</description>
 257                         <required>true</required>
 258                         <!-- @TODO Find an interface for BaseFacesBean and set it here instead -->
 259                         <type>org.mxchange.jcoreee.bean.faces.BaseFacesBean</type>
 260                 </attribute>
 261                 <attribute>
 262                         <name>labelMessage</name>
 263                         <description>A localized message for the rendered label tag. You should use EL code here to add a label message from your bundle.</description>
 264                         <required>true</required>
 265                         <type>java.lang.String</type>
 266                 </attribute>
 267                 <attribute>
 268                         <name>rendered</name>
 269                         <description>Whether this tag is being rendered by JSF engine.</description>
 270                         <required>false</required>
 271                         <type>java.lang.Boolean</type>
 272                 </attribute>
 273         </tag>
 274         <tag>
 275                 <tag-name>outputLandLineInputTableRow</tag-name>
 276                 <description>This tag renders a h:panelGroup with input fields for land-line numbers.</description>
 277                 <source>resources/tags/table_rows/landline_input_table_row.tpl</source>
 278                 <attribute>
 279                         <name>targetController</name>
 280                         <description>A target backing bean (EL code resolving into it) extending at least BaseFacesBean where to set the data in.</description>
 281                         <required>true</required>
 282                         <!-- @TODO Find an interface for BaseFacesBean and set it here instead -->
 283                         <type>org.mxchange.jcoreee.bean.faces.BaseFacesBean</type>
 284                 </attribute>
 285                 <attribute>
 286                         <name>labelMessage</name>
 287                         <description>A localized message for the rendered label tag. You should use EL code here to add a label message from your bundle.</description>
 288                         <required>true</required>
 289                         <type>java.lang.String</type>
 290                 </attribute>
 291                 <attribute>
 292                         <name>rendered</name>
 293                         <description>Whether this tag is being rendered by JSF engine.</description>
 294                         <required>false</required>
 295                         <type>java.lang.Boolean</type>
 296                 </attribute>
 297         </tag>
 298         <tag>
 299                 <tag-name>outputAdminFaxLinks</tag-name>
 300                 <description>This tag renders a full h:panelGroup for administrative links for fax data.</description>
 301                 <source>resources/tags/admin/links/fax/admin_fax_data.tpl</source>
 302                 <attribute>
 303                         <name>isShowPage</name>
 304                         <description>Whether this tag is used to show mobile data (default true).</description>
 305                         <required>false</required>
 306                         <type>java.lang.Boolean</type>
 307                 </attribute>
 308                 <attribute>
 309                         <name>faxNumber</name>
 310                         <description>The fax instance that provides the data for this tag.</description>
 311                         <required>true</required>
 312                         <type>org.mxchange.jphone.phonenumbers.fax.DialableFaxNumber</type>
 313                 </attribute>
 314                 <attribute>
 315                         <name>rendered</name>
 316                         <description>Whether this tag is being rendered by JSF engine.</description>
 317                         <required>false</required>
 318                         <type>java.lang.Boolean</type>
 319                 </attribute>
 320         </tag>
 321         <tag>
 322                 <tag-name>outputAdminLandLineLinks</tag-name>
 323                 <description>This tag renders a full h:panelGroup for administrative links for land-line data.</description>
 324                 <source>resources/tags/admin/panel_grids/landline/admin_landline_data.tpl</source>
 325                 <attribute>
 326                         <name>isShowPage</name>
 327                         <description>Whether this tag is used to show mobile data (default true).</description>
 328                         <required>false</required>
 329                         <type>java.lang.Boolean</type>
 330                 </attribute>
 331                 <attribute>
 332                         <name>landLineNumber</name>
 333                         <description>The fax instance that provides the data for this tag.</description>
 334                         <required>true</required>
 335                         <type>org.mxchange.jphone.phonenumbers.landline.DialableLandLineNumber</type>
 336                 </attribute>
 337                 <attribute>
 338                         <name>rendered</name>
 339                         <description>Whether this tag is being rendered by JSF engine.</description>
 340                         <required>false</required>
 341                         <type>java.lang.Boolean</type>
 342                 </attribute>
 343         </tag>
 344         <tag>
 345                 <tag-name>outputAdminMobileLinks</tag-name>
 346                 <description>This tag renders a full h:panelGroup for administrative links for mobile data.</description>
 347                 <source>resources/tags/admin/panel_grids/mobile/admin_mobile_data.tpl</source>
 348                 <attribute>
 349                         <name>isShowPage</name>
 350                         <description>Whether this tag is used to show mobile data (default true).</description>
 351                         <required>false</required>
 352                         <type>java.lang.Boolean</type>
 353                 </attribute>
 354                 <attribute>
 355                         <name>mobileNumber</name>
 356                         <description>The mobile instance that provides the data for this tag.</description>
 357                         <required>true</required>
 358                         <type>org.mxchange.jphone.phonenumbers.mobile.DialableMobileNumber</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 </facelet-taglib>