META-INF.maven-faces-plugin.components.trinidad.html.HtmlBody.xml Maven / Gradle / Ivy
<?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: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[Tag for the HTML body element.]]></description>
<icon>
<small-icon>/org/apache/myfaces/trinidadinternal/metadata/icons/body.gif</small-icon>
</icon>
<component-type>org.apache.myfaces.trinidad.HtmlBody</component-type>
<component-class>org.apache.myfaces.trinidad.component.html.HtmlBody</component-class>
<property>
<description><![CDATA[whether or not Trinidad will allow the first click to go
through in certain instances. When a PPR event occurs, we block
all subsequent user input until it completes. However, there may
be instances where the client wants to receive the very first
click. For example, if the user entered text in an inputText
that fires a PPR request, then the user immediately clicked
a submit button two events will be triggered - an onchange
followed by an onclick. The onchange will trigger the client
action which will immediately start the PPR blocking, so the
onclick will get consumed by the blocking code and no submit will
occur. Setting this value to true will allow the click to go
through.]]>
</description>
<property-name>firstClickPassed</property-name>
<property-class>boolean</property-class>
<default-value>false</default-value>
<property-extension>
<mfp:property-metadata/>
<mfp:unsupported-agents>pda phone voice</mfp:unsupported-agents>
<fmd:property-metadata>
<fmd:expert>true</fmd:expert>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[the short description of the bean. This text
is commonly used by user agents to display tooltip help text.]]>
</description>
<property-name>shortDesc</property-name>
<property-class>java.lang.String</property-class>
<property-extension>
<mfp:property-metadata/>
<fmd:property-metadata>
<fmd:category-id>GENERAL</fmd:category-id>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[the IDs of the components that should trigger a partial update.
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.]]>
</description>
<property-name>partialTriggers</property-name>
<property-class>java.lang.String[]</property-class>
<property-extension>
<mfp:mutable>rarely</mfp:mutable>
<mfp:property-metadata>
<mfp:multi-scoped-id-holder>true</mfp:multi-scoped-id-holder>
</mfp:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[an onclick Javascript handler.]]></description>
<property-name>onclick</property-name>
<property-class>java.lang.String</property-class>
<property-extension>
<mfp:property-metadata/>
<fmd:property-metadata>
<fmd:category-id>EVENTS</fmd:category-id>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[an ondblclick Javascript handler.]]></description>
<property-name>ondblclick</property-name>
<property-class>java.lang.String</property-class>
<property-extension>
<mfp:property-metadata/>
<fmd:property-metadata>
<fmd:category-id>EVENTS</fmd:category-id>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[an onmousedown Javascript handler.]]></description>
<property-name>onmousedown</property-name>
<property-class>java.lang.String</property-class>
<property-extension>
<mfp:property-metadata/>
<fmd:property-metadata>
<fmd:category-id>EVENTS</fmd:category-id>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[an onmouseup Javascript handler.]]></description>
<property-name>onmouseup</property-name>
<property-class>java.lang.String</property-class>
<property-extension>
<mfp:property-metadata/>
<fmd:property-metadata>
<fmd:category-id>EVENTS</fmd:category-id>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[an onmouseover Javascript handler.]]></description>
<property-name>onmouseover</property-name>
<property-class>java.lang.String</property-class>
<property-extension>
<mfp:property-metadata/>
<fmd:property-metadata>
<fmd:category-id>EVENTS</fmd:category-id>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[an onmousemove Javascript handler.]]></description>
<property-name>onmousemove</property-name>
<property-class>java.lang.String</property-class>
<property-extension>
<mfp:property-metadata/>
<fmd:property-metadata>
<fmd:category-id>EVENTS</fmd:category-id>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[an onmouseout Javascript handler.]]></description>
<property-name>onmouseout</property-name>
<property-class>java.lang.String</property-class>
<property-extension>
<mfp:property-metadata/>
<fmd:property-metadata>
<fmd:category-id>EVENTS</fmd:category-id>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[an onkeypress Javascript handler.]]></description>
<property-name>onkeypress</property-name>
<property-class>java.lang.String</property-class>
<property-extension>
<mfp:property-metadata/>
<fmd:property-metadata>
<fmd:category-id>EVENTS</fmd:category-id>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[an onkeydown Javascript handler.]]></description>
<property-name>onkeydown</property-name>
<property-class>java.lang.String</property-class>
<property-extension>
<mfp:property-metadata/>
<fmd:property-metadata>
<fmd:category-id>EVENTS</fmd:category-id>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[an onkeyup Javascript handler.]]></description>
<property-name>onkeyup</property-name>
<property-class>java.lang.String</property-class>
<property-extension>
<mfp:property-metadata/>
<fmd:property-metadata>
<fmd:category-id>EVENTS</fmd:category-id>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[the CSS style class of the bean.]]></description>
<property-name>styleClass</property-name>
<property-class>java.lang.String</property-class>
<property-extension>
<mfp:property-metadata/>
<fmd:property-metadata>
<fmd:category-id>GENERAL</fmd:category-id>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[the inline CSS style for this element]]></description>
<property-name>inlineStyle</property-name>
<property-class>java.lang.String</property-class>
<property-extension>
<mfp:property-metadata/>
<fmd:property-metadata>
<fmd:category-id>GENERAL</fmd:category-id>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[an onload Javascript handler.]]></description>
<property-name>onload</property-name>
<property-class>java.lang.String</property-class>
<property-extension>
<mfp:property-metadata/>
<fmd:property-metadata>
<fmd:category-id>EVENTS</fmd:category-id>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[an onunload Javascript handler.]]></description>
<property-name>onunload</property-name>
<property-class>java.lang.String</property-class>
<property-extension>
<mfp:property-metadata/>
<fmd:property-metadata>
<fmd:category-id>EVENTS</fmd:category-id>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[the id of the component to which you want the
focus to be when the full page renders. The accessibility-mode
must be set to "inaccessible" for this feature to be on.]]>
</description>
<property-name>initialFocusId</property-name>
<property-class>java.lang.String</property-class>
<property-extension>
<mfp:property-metadata>
<mfp:scoped-id-holder>true</mfp:scoped-id-holder>
</mfp:property-metadata>
<mfp:unsupported-agents>pda phone voice</mfp:unsupported-agents>
<fmd:property-metadata>
<fmd:expert>true</fmd:expert>
</fmd:property-metadata>
</property-extension>
</property>
<component-extension>
<mfp:component-family>org.apache.myfaces.trinidad.Body</mfp:component-family>
<mfp:component-supertype>org.apache.myfaces.trinidad.ComponentBase</mfp:component-supertype>
<mfp:renderer-type>org.apache.myfaces.trinidad.Body</mfp:renderer-type>
<mfp:tag-name>trh:body</mfp:tag-name>
<mfp:tag-class>org.apache.myfaces.trinidadinternal.taglib.html.HtmlBodyTag</mfp:tag-class>
<mfp:long-description><![CDATA[<html:p>
Tag for the HTML body element. In addition
to providing support for the standard HTML body functionality,
the Trinidad body component enables partial-page rendering (PPR) support
and assigning initial page focus.
</html:p>
<html:p>
The body component resets the Trinidad EL context when code re-enters the component via
an invoke on component call or a visit tree call. See the
org.apache.myfaces.trinidad.context.ComponentContextManager for more information.
</html:p>]]>
</mfp:long-description>
<mfp:example>
<mfp:source-code>
<![CDATA[
<trh:html>
<trh:body>
<trh:outputText value="Here is some text inside a body element"/>
</trh:body>
</trh:html>
]]>
</mfp:source-code>
</mfp:example>
<mfp:author>Blake Sullivan</mfp:author>
<mfp:component-metadata/>
<mfp:uix2-local-name>body</mfp:uix2-local-name>
<fmd:component-metadata>
<fmd:default-event-name>load</fmd:default-event-name>
<fmd:event-names>click dblclick mousedown mouseup mouseover mousemove mouseout
keypress keydown keyup load unload</fmd:event-names>
<fmd:preferred-child-components>org.apache.myfaces.trinidad.CorePanelPage org.apache.myfaces.trinidad.CoreForm</fmd:preferred-child-components>
<fmd:required-ancestor-contracts>org-apache-myfaces-trinidad-htmlbody-holder</fmd:required-ancestor-contracts>
</fmd:component-metadata>
</component-extension>
</component>
</faces-config>