focus.xml 3.13 KB
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE components PUBLIC "-//AJAX4JSF//CDK Generator config/EN"
        "http://labs.jboss.com/jbossrichfaces/component-config.dtd" >
<components>
    <component>
        <name>org.richfaces.Focus</name>
        <family>org.richfaces.Focus</family>
        <classname>org.richfaces.component.html.HtmlFocus</classname>
        <superclass>org.richfaces.component.UIFocus</superclass>
        <description>
            <![CDATA[Puts focus on rendered field. In case of text inputs it's
            content is selected. If you use it with i.e. radio use suffix
            attribute.
             ]]>
        </description>
        <renderer generate="false" override="false">
            <name>org.richfaces.FocusRenderer</name>
            <classname>org.richfaces.renderkit.html.HtmlFocusRenderer</classname>
        </renderer>
        <tag>
            <name>focus</name>
            <classname>org.richfaces.taglib.FocusTag</classname>
            <superclass>
                org.ajax4jsf.webapp.taglib.HtmlComponentTagBase
            </superclass>
            <test>
                <classname>org.richfaces.taglib.HtmlFocusTagTest</classname>
                <superclassname>org.ajax4jsf.tests.AbstractJspTestCase</superclassname>
            </test>

        </tag>
        &ui_component_attributes;
        <property>
            <name>for</name>
            <classname>java.lang.String</classname>
            <description>
                Id of component that should be focused
            </description>
            <defaultvalue>""</defaultvalue>
        </property>
        <property>
            <name>priority</name>
            <classname>java.lang.Integer</classname>
            <description>
                If there are more components requesting focus,
                then component with lowest priority will be focused.
            </description>
        </property>
        <property>
            <name>suffix</name>
            <classname>java.lang.String</classname>
            <description>
                Suffix added to clientId. Useful for focusing radio elements.
                Example : suffix=":0" puts focus on first radio if target is
                radio.
            </description>
            <defaultvalue>""</defaultvalue>
        </property>
        <property>
            <name>timing</name>
            <classname>java.lang.String</classname>
            <description>
                Moment when focus should be put. The possible values are "onJScall" and "onload".
                If "onJScall" is used then you must manually call Richfaces.FocusManager.focus().
                The default value is "onload".
            </description>
            <defaultvalue>"onload"</defaultvalue>
        </property>
        <property>
            <name>name</name>
            <classname>java.lang.String</classname>
            <description>
                Name of JavaScript function generated to trigger focus. This is required if "timing" attribute
                is set to "onJScall".
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
    </component>
</components>