Hinzufügen von Benutzerdefinierten Attributen Primefaces Autocomplete-Komponente in JSF

Wenn Sie eine bestimmte Komponente verwendet einen anderen renderer als <p:autoComplete> dann kann man wirklich nicht gehen, um das erstellen einer benutzerdefinierten Komponente mit der eigenen Familie und Komponente geben. Sie kann immer noch nur die Erweiterung der PrimeFaces AutoComplete (und dessen renderer) zu speichern, boilerplate-code.

In die benutzerdefinierte Komponente verwenden, müssen Sie die Getter für die Attribute. Sie konnte so gut angeben setter als gut, so können Sie immer setzen die Standardeinstellung der Werte aus der view-Seite. Diese Getter/setter sollte wiederum delegieren zu StateHelper.

Es gibt nur ein kleines problem mit x-webkit-* Attribute. Die - ist eine illegale Zeichen in Java-Bezeichner. So haben Sie zum umbenennen der Getter/setter und ändern Sie den renderer etwas wie der standard-renderer basiert auf dem component name der Eigenschaft wird genau das gleiche wie das tag-Attribut name. Update: ich verstehe, dass x-webkit-speech sollte nur dargestellt werden, wie Sie ist (also keine getter/setter notwendig) und dass x-webkit-grammer ist tatsächlich ein Tippfehler, es sollte x-webkit-grammar.

Hier ist, wie die SiteSearch Komponente kann wie folgt Aussehen:

@FacesComponent(SiteSearch.COMPONENT_TYPE)
public class SiteSearch extends AutoComplete {

    public static final String COMPONENT_FAMILY = "com.example";
    public static final String COMPONENT_TYPE = "com.example.SiteSearch";

    private enum PropertyKeys {
        grammar, onspeechchange, placeholder
    }

    @Override
    public String getFamily() {
        return COMPONENT_FAMILY;
    }

    @Override
    public String getRendererType() {
        return SiteSearchRenderer.RENDERER_TYPE;
    }

    public String getGrammar() {
        return (String) getStateHelper().eval(PropertyKeys.grammar, "builtin:search");
    }

    public void setGrammar(String grammar) {
        getStateHelper().put(PropertyKeys.grammar, grammar);
    }

    public String getOnspeechchange() {
        return (String) getStateHelper().eval(PropertyKeys.onspeechchange, "submit()");
    }

    public void setOnspeechchange(String onspeechchange) {
        getStateHelper().put(PropertyKeys.onspeechchange, onspeechchange);
    }

    public String getPlaceholder() {
        return (String) getStateHelper().eval(PropertyKeys.placeholder, "Enter a Search Term");
    }

    public void setPlaceholder(String placeholder) {
        getStateHelper().put(PropertyKeys.placeholder, placeholder);
    }

}

Bitte beachten Sie, dass die Getter haben alle default-Werte angegeben. Wenn die eval() zurück null, dann wird der default-Wert zurückgegeben, statt. Ich habe auch neutralisiert die Namen der attribute etwas, so dass es wiederverwendet werden kann für eine zukünftige nicht-webkit-Browsern nur durch ändern der renderer entsprechend.

Und hier ist, wie die SiteSearchRenderer renderer Aussehen sollte für die oben genannten Komponente:

@FacesRenderer(
    componentFamily=SiteSearch.COMPONENT_FAMILY,
    rendererType=SiteSearchRenderer.RENDERER_TYPE
)
public class SiteSearchRenderer extends AutoCompleteRenderer {

    public static final String RENDERER_TYPE = "com.example.SiteSearchRenderer";

    @Override
    protected void renderPassThruAttributes(FacesContext facesContext, UIComponent component, String[] attrs) throws IOException {
        ResponseWriter writer = facesContext.getResponseWriter();
        writer.writeAttribute("x-webkit-speech", "x-webkit-speech", null);
        writer.writeAttribute("x-webkit-grammar", component.getAttributes().get("grammar"), "grammar");
        writer.writeAttribute("onwebkitspeechchange", component.getAttributes().get("onspeechchange"), "onspeechchange");
        writer.writeAttribute("placeholder", component.getAttributes().get("placeholder"), "placeholder");
        super.renderPassThruAttributes(facesContext, component, attrs);
    }

}

In der Ansicht, wir brauchen natürlich, um es zu registrieren als ein tag. Erstellen Sie eine /WEB-INF/my.taglib.xml Datei:

<?xml version="1.0" encoding="UTF-8"?>
<facelet-taglib
    xmlns="http://java.sun.com/xml/ns/javaee"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-facelettaglibrary_2_0.xsd"
    version="2.0"
>
    <namespace>http://example.com/ui</namespace>

    <tag>
        <tag-name>siteSearch</tag-name>
        <component>
            <component-type>com.example.SiteSearch</component-type>
            <renderer-type>com.example.SiteSearchRenderer</renderer-type>
        </component>
    </tag>
</facelet-taglib>

Beachten Sie, dass Sie nicht brauchen, ein <renderer> im faces-config.xml für mehr. Die @FacesRenderer annotation kann nur tun, Ihre Arbeit auf echten benutzerdefinierten Komponenten. So entfernen Sie die <renderer> Eintrag in faces-config.xml die Sie erstellt basierend auf Ihrer vorherigen Frage.

Nun sagen, JSF, du hast eine custom-taglib, die von den folgenden context-param in web.xml:

<context-param>
    <param-name>javax.faces.FACELETS_LIBRARIES</param-name>
    <param-value>/WEB-INF/my.taglib.xml</param-value>
</context-param>

Schließlich können Sie es verwenden, wie folgt:

<html ... xmlns:my="http://example.com/ui">
...
<my:siteSearch />

Können Sie auch zusätzliche Attribute angeben, die die Standardeinstellungen außer Kraft setzen in der Komponente festgelegt:

<my:siteSearch grammar="builtin:language" onspeechchange="alert('peek-a-boo')" placeholder="Search" />

Für IDE mit autocomplete auf Attribute, müssten Sie angeben, jedes als separate <attribute> im <tag> Erklärung in der my.taglib.xml.