META-INF.maven-faces-plugin.components.trinidad.ComponentRef.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="2.0" xmlns="http://java.sun.com/xml/ns/javaee"
              xmlns:tr="http://myfaces.apache.org/trinidad"
              xmlns:xi="http://www.w3.org/2001/XInclude"
              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[Inserts a region into the current page.]]></description>
    <icon>
      <small-icon>/org/apache/myfaces/trinidadinternal/metadata/icons/region.gif</small-icon>
    </icon>
    <component-type>org.apache.myfaces.trinidad.ComponentRef</component-type>
    <component-class>org.apache.myfaces.trinidad.component.UIXComponentRef</component-class>
    <property>
      <description><![CDATA[the value of the component.  This value be evaluated during
              all lifecycle processing and
              made available to the componentDef as an EL variable named "bindings".]]>
      </description>
      <property-name>value</property-name>
      <property-class>java.lang.Object</property-class>
    </property>
    <property>
      <description><![CDATA[<html> which componnet to use. This should match a
&lt;component-type&gt; string in a region metadata file.
An example might look like "org.apache.myfaces.trinidaddemo.region.stock".
This attribute can be bound to an EL expression or manually
set, which will change the region definition used the next
time the page renders.</html>]]>
      </description>
      <property-name>componentType</property-name>
      <property-class>java.lang.String</property-class>
    </property>
    <property>
      <description><![CDATA[<html> The name of the EL variable that will be set when encoding the component.
        This attribute is set by the tr:componentDef on behalf of the UIXComponentRef, and not the tr:componentRef.
        For example,
              let's say this "var" attribute is set to the value "attrs";
              if the &lt;tr:componentRef&gt; tag has an attribute called "bar",
              The value of "bar" can be referenced from a child within
              &lt;tr:componentDef&gt; using the expression
              <code>#{attrs.bar}</code>.</html>]]>
      </description>
      <property-name>var</property-name>
      <property-class>java.lang.String</property-class>
      <property-extension>
        <mfp:tag-attribute-excluded>true</mfp:tag-attribute-excluded>
      </property-extension>
    </property>
    <component-extension>
      <mfp:component-family>org.apache.myfaces.trinidad.ComponentRef</mfp:component-family>
      <mfp:component-supertype>org.apache.myfaces.trinidad.ComponentBase</mfp:component-supertype>
      <mfp:tag-class>org.apache.myfaces.trinidadinternal.taglib.UIXComponentRefTag</mfp:tag-class>
      <mfp:long-description><![CDATA[This component inserts a component (defined by a separate page
          that starts with &lt;tr:componentDef&gt;)
          into the current page. The &quot;id&quot; attribute is required on this
          component, which implements NamingContainer.  This component may have
          a value, custom attributes, or both.  The value will be
          made available to within component definition using the &quot;binding&quot;
          EL attribute.  Custom attributes, defined with
          &lt;f:attribute&gt; or &lt;tr:attribute&gt;, will also
          be made available within the component definition - see the
          &lt;tr:componentDef&gt; tag documentation for more information.

          This component may also have facets. Each facet may be referenced
          exactly once from within a &lt;tr:componentDef&gt; tag by
          using a &lt;tr:facetRef&gt; - see the
          &lt;tr:componentRef&gt; tag documentation for more information.]]>
      </mfp:long-description>
      <mfp:example>
        <mfp:source-code>
          <![CDATA[
<tr:componentRef componentType="org.apache.myfaces.trinidaddemo.region.stock" >
   <f:attribute name="symbol" value="ORCL"/>
   <f:attribute name="desc" value="Oracle Corp"/>
   <f:facet name="actions">
     <tr:commandButton text="Update Stock Quote"/>
   </f:facet>
 </tr:componentRef>
          ]]>
        </mfp:source-code>
      </mfp:example>
      <mfp:author>Arjuna Wijeyekoon</mfp:author>
      <mfp:naming-container>true</mfp:naming-container>
      <mfp:tag-class-modifier>abstract</mfp:tag-class-modifier>
    </component-extension>
  </component>
</faces-config>