META-INF.maven-faces-plugin.components.trinidad.html.HtmlMeta.xml Maven / Gradle / Ivy

Go to download
<?xml version="1.0" encoding="utf-8"?>
<!--
    Licensed to	the Apache Software Foundation (ASF) under one
    or more contributor	license	agreements.  See the NOTICE file
    distributed	with this work for additional information
    regarding copyright	ownership.  The	ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License");	you may	not use	this file except in compliance
    with the License.  You may obtain a	copy of	the License at

    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed	to in writing,
    software distributed under the License is distributed on an
    "AS	IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied.  See the License for the
    specific language governing	permissions and	limitations
    under the License.

-->
<faces-config version="1.2" xmlns="http://java.sun.com/xml/ns/javaee"
	      xmlns:trh="http://myfaces.apache.org/trinidad/html"
	      xmlns:mfp="http://myfaces.apache.org/maven-faces-plugin"
              xmlns:fmd="http://java.sun.com/xml/ns/javaee/faces/design-time-metadata">
  <component>
    <description><![CDATA[The meta component supports generating an html meta tag for things like reloading the page or configuring viewport characteristics.  It is also important to note that a meta HTML tag cannot have an ID so the component ID will not be seen in the browser source.]]></description>
    <icon>
      <small-icon>/org/apache/myfaces/trinidadinternal/metadata/icons/meta.gif</small-icon>
    </icon>
    <component-type>org.apache.myfaces.trinidad.HtmlMeta</component-type>
    <component-class>org.apache.myfaces.trinidad.component.html.HtmlMeta</component-class>
    <property>
      <description><![CDATA[the	name or the http-equiv attribute for the meta tag (see the type attribute for further configuration)]]></description>
      <property-name>name</property-name>
      <property-class>java.lang.String</property-class>
      <property-extension>
	<mfp:property-metadata/>
        <fmd:property-metadata>
          <fmd:preferred>true</fmd:preferred>
        </fmd:property-metadata>
      </property-extension>
    </property>
    <property>
      <description><![CDATA[<html>how the name attribute is used.  Options are:
              <ul><li>name - for "name" which is the most common use for meta tags
                </li><li>httpEquiv - for "http-equiv" which is the used in some legacy meta tags
                </li></ul>
              </html>]]></description>
      <property-name>type</property-name>
      <property-class>java.lang.String</property-class>
      <default-value>name</default-value>
      <property-extension>
        <fmd:property-metadata>
          <fmd:preferred>true</fmd:preferred>
          <fmd:required>false</fmd:required>
          <fmd:property-values>name httpEquiv</fmd:property-values>
        </fmd:property-metadata>
      </property-extension>
    </property>
    <property>
      <description><![CDATA[the	content for the meta tag]]></description>
      <property-name>content</property-name>
      <property-class>java.lang.String</property-class>
      <property-extension>
	<mfp:property-metadata/>
        <fmd:property-metadata>
          <fmd:preferred>true</fmd:preferred>
        </fmd:property-metadata>
      </property-extension>
    </property>
    <component-extension>
      <mfp:component-family>org.apache.myfaces.trinidad.Meta</mfp:component-family>
      <mfp:component-supertype>org.apache.myfaces.trinidad.ComponentBase</mfp:component-supertype>
      <mfp:renderer-type>org.apache.myfaces.trinidad.Meta</mfp:renderer-type>
      <mfp:tag-name>trh:meta</mfp:tag-name>
      <mfp:tag-class>org.apache.myfaces.trinidadinternal.taglib.html.HtmlMetaTag</mfp:tag-class>
      <mfp:long-description><![CDATA[<html:p>
            The meta component supports generating an html meta tag for things like reloading the page or configuring viewport characteristics like these:
            <html:ul>
              <html:li><html:pre>&lt;meta name="viewport" content="width=device-width, user-scalable=no"&gt;</html:pre></html:li>
              <html:li><html:pre>&lt;meta name="apple-mobile-web-app-capable" content="yes"&gt;</html:pre></html:li>
              <html:li><html:pre>&lt;meta http-equiv="refresh" content="2;url=./test/index.jspx"&gt;</html:pre></html:li>
            </html:ul>
            It is also important to note that a meta HTML tag cannot have an ID so the component ID will not be seen in the browser source.
	  </html:p>]]>
      </mfp:long-description>
      <mfp:example>
	<mfp:source-description>Example	of three meta tags in a tr:document.</mfp:source-description>
	<mfp:source-code>
	  <![CDATA[
<tr:document ...>
  <f:facet name="metaContainer">
    <tr:group id="metaContainer">
      <trh:meta name="viewport" content="width=device-width, user-scalable=no"/>
      <trh:meta name="apple-mobile-web-app-capable" content="yes"/>
      <trh:meta type="httpEquiv" name="refresh" content="2;url=./test/index.jspx"/>
    </tr:group>
  </f:facet>
</tr:document>
	  ]]>
	</mfp:source-code>
      </mfp:example>
      <mfp:author>Apache MyFaces Trinidad</mfp:author>
      <mfp:component-metadata/>
      <fmd:component-metadata>
        <fmd:default-property>name</fmd:default-property>
        <fmd:hidden>false</fmd:hidden>
      </fmd:component-metadata>
    </component-extension>
  </component>
</faces-config>