META-INF.maven-faces-plugin.components.trinidad.html.HtmlFrameBorderLayout.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[frameBorderLayout is a layout bean which can be used to place seven
frames at left, right, top, bottom, innerLeft, innerRight and center
positions.]]>
</description>
<icon>
<small-icon>/org/apache/myfaces/trinidadinternal/metadata/icons/frameBorderLayout.gif</small-icon>
</icon>
<component-type>org.apache.myfaces.trinidad.HtmlFrameBorderLayout</component-type>
<component-class>org.apache.myfaces.trinidad.component.html.HtmlFrameBorderLayout</component-class>
<facet>
<description><![CDATA[The frame to be rendered in the center.]]></description>
<facet-name>center</facet-name>
<facet-extension>
<mfp:facet-metadata/>
<fmd:facet-metadata>
<fmd:preferred>true</fmd:preferred>
<fmd:preferred-child-components>org.apache.myfaces.trinidad.HtmlFrame</fmd:preferred-child-components>
</fmd:facet-metadata>
</facet-extension>
</facet>
<facet>
<description><![CDATA[The frame to be rendered above the center frame.
This frame's height attribute is used to allocate
its height.]]>
</description>
<facet-name>top</facet-name>
<facet-extension>
<mfp:facet-metadata/>
<fmd:facet-metadata>
<fmd:preferred>true</fmd:preferred>
<fmd:preferred-child-components>org.apache.myfaces.trinidad.HtmlFrame org.apache.myfaces.trinidad.HtmlFrameBorderLayout</fmd:preferred-child-components>
</fmd:facet-metadata>
</facet-extension>
</facet>
<facet>
<description><![CDATA[The frame to be rendered below the center frame.
This frame's height attribute is used to allocate
its height.]]>
</description>
<facet-name>bottom</facet-name>
<facet-extension>
<mfp:facet-metadata/>
<fmd:facet-metadata>
<fmd:preferred>true</fmd:preferred>
<fmd:preferred-child-components>org.apache.myfaces.trinidad.HtmlFrame org.apache.myfaces.trinidad.HtmlFrameBorderLayout</fmd:preferred-child-components>
</fmd:facet-metadata>
</facet-extension>
</facet>
<facet>
<description><![CDATA[The frame to be rendered to the left of the center frame.
This frame's width attribute is used to allocate
its width.]]>
</description>
<facet-name>left</facet-name>
<facet-extension>
<mfp:facet-metadata/>
<fmd:facet-metadata>
<fmd:preferred>true</fmd:preferred>
<fmd:preferred-child-components>org.apache.myfaces.trinidad.HtmlFrame org.apache.myfaces.trinidad.HtmlFrameBorderLayout</fmd:preferred-child-components>
</fmd:facet-metadata>
</facet-extension>
</facet>
<facet>
<description><![CDATA[The frame to be rendered to the right of the center frame.
This frame's width attribute is used to allocate
its width.]]>
</description>
<facet-name>right</facet-name>
<facet-extension>
<mfp:facet-metadata/>
<fmd:facet-metadata>
<fmd:preferred>true</fmd:preferred>
<fmd:preferred-child-components>org.apache.myfaces.trinidad.HtmlFrame org.apache.myfaces.trinidad.HtmlFrameBorderLayout</fmd:preferred-child-components>
</fmd:facet-metadata>
</facet-extension>
</facet>
<facet>
<description><![CDATA[The frame to be rendered to the left of the center frame,
if the
reading direction is left-to-right, or right otherwise.
This frame's width attribute is used to allocate
its width.]]>
</description>
<facet-name>start</facet-name>
<facet-extension>
<mfp:facet-metadata/>
<fmd:facet-metadata>
<fmd:preferred-child-components>org.apache.myfaces.trinidad.HtmlFrame org.apache.myfaces.trinidad.HtmlFrameBorderLayout</fmd:preferred-child-components>
</fmd:facet-metadata>
</facet-extension>
</facet>
<facet>
<description><![CDATA[The frame to be rendered to the right of the center frame,
if the
reading direction is left-to-right, or left otherwise.
This frame's width attribute is used to allocate
its width.]]>
</description>
<facet-name>end</facet-name>
<facet-extension>
<mfp:facet-metadata/>
<fmd:facet-metadata>
<fmd:preferred-child-components>org.apache.myfaces.trinidad.HtmlFrame org.apache.myfaces.trinidad.HtmlFrameBorderLayout</fmd:preferred-child-components>
</fmd:facet-metadata>
</facet-extension>
</facet>
<facet>
<description><![CDATA[The frame to be rendered between the left frame and
the center frame.
This frame's width attribute is used to allocate
its width.]]>
</description>
<facet-name>innerLeft</facet-name>
<facet-extension>
<mfp:facet-metadata/>
<fmd:facet-metadata>
<fmd:preferred-child-components>org.apache.myfaces.trinidad.HtmlFrame org.apache.myfaces.trinidad.HtmlFrameBorderLayout</fmd:preferred-child-components>
</fmd:facet-metadata>
</facet-extension>
</facet>
<facet>
<description><![CDATA[The frame to be rendered between the right frame and
the center frame.
This frame's width attribute is used to allocate
its width.]]>
</description>
<facet-name>innerRight</facet-name>
<facet-extension>
<mfp:facet-metadata/>
<fmd:facet-metadata>
<fmd:preferred-child-components>org.apache.myfaces.trinidad.HtmlFrame org.apache.myfaces.trinidad.HtmlFrameBorderLayout</fmd:preferred-child-components>
</fmd:facet-metadata>
</facet-extension>
</facet>
<facet>
<description><![CDATA[The frame to be rendered as the innerLeft frame,
if the reading direction is left-to-right,
or innerRight frame otherwise.
This frame's width attribute is used to allocate
its width.]]>
</description>
<facet-name>innerStart</facet-name>
<facet-extension>
<mfp:facet-metadata/>
<fmd:facet-metadata>
<fmd:preferred-child-components>org.apache.myfaces.trinidad.HtmlFrame org.apache.myfaces.trinidad.HtmlFrameBorderLayout</fmd:preferred-child-components>
</fmd:facet-metadata>
</facet-extension>
</facet>
<facet>
<description><![CDATA[The frame to be rendered as the innerRight frame,
if the reading direction is left-to-right,
or innerLeft frame otherwise.
This frame's width attribute is used to allocate
its width.]]>
</description>
<facet-name>innerEnd</facet-name>
<facet-extension>
<mfp:facet-metadata/>
<fmd:facet-metadata>
<fmd:preferred-child-components>org.apache.myfaces.trinidad.HtmlFrame org.apache.myfaces.trinidad.HtmlFrameBorderLayout</fmd:preferred-child-components>
</fmd:facet-metadata>
</facet-extension>
</facet>
<facet>
<description><![CDATA[These contents will be rendered inside HTML
<code>NOFRAMES</code> tags. Browsers that do not
support frames will render these contents.]]>
</description>
<facet-name>alternateContent</facet-name>
</facet>
<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 proposed width of this frameBorderLayout. This can be in
pixels or percentage. This attribute is used only if this a nested
frameBorderLayout in a left/right facet of a
frameBorderLayout.]]>
</description>
<property-name>width</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[The proposed height of this frameBorderLayout. This can be in
pixels or percentage. This attribute is used only if this a nested
frameBorderLayout in a top/bottom facet of a
frameBorderLayout.]]>
</description>
<property-name>height</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[The size of frame spacing to be rendered.]]>
</description>
<property-name>frameSpacing</property-name>
<property-class>int</property-class>
<property-extension>
<mfp:property-metadata/>
<fmd:property-metadata>
<fmd:property-editor>UNSIGNED_INTEGER</fmd:property-editor>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[The size for the border width to be rendered.]]>
</description>
<property-name>borderWidth</property-name>
<property-class>int</property-class>
<property-extension>
<mfp:property-metadata/>
<fmd:property-metadata>
<fmd:property-editor>UNSIGNED_INTEGER</fmd:property-editor>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[The size for the frame border width to be rendered.]]>
</description>
<property-name>frameBorderWidth</property-name>
<property-class>int</property-class>
<property-extension>
<mfp:property-metadata/>
<fmd:property-metadata>
<fmd:property-editor>UNSIGNED_INTEGER</fmd:property-editor>
</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[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>
<component-extension>
<mfp:component-family>org.apache.myfaces.trinidad.FrameBorderLayout</mfp:component-family>
<mfp:component-supertype>org.apache.myfaces.trinidad.ComponentBase</mfp:component-supertype>
<mfp:renderer-type>org.apache.myfaces.trinidad.FrameBorderLayout</mfp:renderer-type>
<mfp:tag-name>trh:frameBorderLayout</mfp:tag-name>
<mfp:tag-class>org.apache.myfaces.trinidadinternal.taglib.html.HtmlFrameBorderLayoutTag</mfp:tag-class>
<mfp:long-description><![CDATA[frameBorderLayout is a layout bean which can be used to place seven
frames at left, right, top, bottom, innerLeft, innerRight and center
positions. It does not render any children except for the specified
facets which must all be either frames or
frameBorderLayouts. The user may use either left/right or
start/end as facets, but not both. Left/right takes
precedence over start/end.
<html:p>
On mobile devices a list linking to each frame is rendered.
</html:p>]]>
</mfp:long-description>
<mfp:example>
<mfp:source-code>
<![CDATA[
<trh:frameBorderLayout>
<f:facet name="Lleft">
<trh:frame source="frame_leftTest.jspx" name="left" width="30%" />
</f:facet>
<f:facet name="center">
<trh:frame source="frame_centerTest.jspx" name="contents" />
</f:facet>
</trh:frameBorderLayout>
]]>
</mfp:source-code>
</mfp:example>
<mfp:author>Arjuna Wijeyekoon</mfp:author>
<mfp:component-metadata/>
<mfp:uix2-local-name>frameBorderLayout</mfp:uix2-local-name>
<mfp:unsupported-agents>pda phone voice</mfp:unsupported-agents>
<fmd:component-metadata>
<fmd:default-event-name>load</fmd:default-event-name>
<fmd:event-names>load unload</fmd:event-names>
<fmd:preferred-child-components>org.apache.myfaces.trinidad.HtmlFrame</fmd:preferred-child-components>
<fmd:required-ancestor-contracts>org-apache-myfaces-trinidad-htmlframeborderlayout-holder</fmd:required-ancestor-contracts>
<fmd:satisfied-contracts>org-apache-myfaces-trinidad-htmlframe-holder</fmd:satisfied-contracts>
</fmd:component-metadata>
</component-extension>
</component>
</faces-config>