META-INF.maven-faces-plugin.components.trinidad.html.HtmlFrame.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[The frame component is used to specify attributes needed by an
HTML frame.]]>
</description>
<icon>
<small-icon>/org/apache/myfaces/trinidadinternal/metadata/icons/frame.gif</small-icon>
</icon>
<component-type>org.apache.myfaces.trinidad.HtmlFrame</component-type>
<component-class>org.apache.myfaces.trinidad.component.html.HtmlFrame</component-class>
<property>
<description><![CDATA[the URI for the source of this frame]]></description>
<property-name>source</property-name>
<property-class>java.lang.String</property-class>
<property-extension>
<mfp:property-metadata/>
<fmd:property-metadata>
<fmd:preferred>true</fmd:preferred>
<fmd:required>true</fmd:required>
</fmd:property-metadata>
</property-extension>
</property>
<property>
<description><![CDATA[<html> This attribute specifies a link to a long description of the
frame. This description should supplement the short description
provided using the <code>shortDesc</code> attribute, and
may be particularly useful for non-visual user agents.</html>]]>
</description>
<property-name>longDescURL</property-name>
<property-class>java.lang.String</property-class>
</property>
<property>
<description><![CDATA[the name used to identify this frame]]></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[the proposed width of this frame
This can be in pixels or percentage. This attribute is used only if this
frame is a left/right facet of a frameBorderLayout component.]]>
</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 frame.
This can be in pixels or percentage. This attribute is used only if this
frame is a top/bottom facet of a frameBorderLayout component.]]>
</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 width of the frame margin. The value must be greater than zero (pixels).]]></description>
<property-name>marginWidth</property-name>
<property-class>int</property-class>
<property-extension/>
</property>
<property>
<description><![CDATA[the width of the frame margin. The value must be greater than zero (pixels).]]></description>
<property-name>marginHeight</property-name>
<property-class>int</property-class>
<property-extension/>
</property>
<property>
<description><![CDATA[<html> whether or not scrollbars are available on this
frame. Valid values for this attribute are the following
constants:<br/>
"yes" specifies that scrollbars are always available. <br/>
"no" specifies that scrollbars are never available. <br/>
"auto" specifies that the browser determines whether to display scroll
bars based on the size of the frame and its content. If
you do not specify a value for scrolling, the default
value is "auto"</html>]]>
</description>
<property-name>scrolling</property-name>
<property-class>java.lang.String</property-class>
<default-value>auto</default-value>
<property-extension>
<mfp:property-metadata/>
<fmd:property-metadata>
<fmd:preferred>true</fmd:preferred>
</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.Frame</mfp:component-family>
<mfp:component-supertype>org.apache.myfaces.trinidad.ComponentBase</mfp:component-supertype>
<mfp:renderer-type>org.apache.myfaces.trinidad.Frame</mfp:renderer-type>
<mfp:tag-name>trh:frame</mfp:tag-name>
<mfp:tag-class>org.apache.myfaces.trinidadinternal.taglib.html.HtmlFrameTag</mfp:tag-class>
<mfp:long-description><![CDATA[The frame is used to specify attributes needed by an
HTML frame. It does not render any child nodes, and should only be used as
a facet on a frameBorderLayout component. The contents of a frame is selected
by using the source attribute.
<html:p>
On mobile devices a list links to each frame is rendered
for a frameBorderLayout, and each frame is brought up
as a separate page.
</html:p>]]>
</mfp:long-description>
<mfp:example>
<mfp:source-code>
<![CDATA[
<trh:frameBorderLayout >
<f:facet name="left">
<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:java-constructor>
<mfp:property-name>source</mfp:property-name>
</mfp:java-constructor>
<mfp:uix2-local-name>frame</mfp:uix2-local-name>
<fmd:component-metadata>
<fmd:allowed-child-components>NONE</fmd:allowed-child-components>
<fmd:default-property>source</fmd:default-property>
<fmd:required-ancestor-contracts>org-apache-myfaces-trinidad-htmlframe-holder</fmd:required-ancestor-contracts>
</fmd:component-metadata>
</component-extension>
</component>
</faces-config>