PrimeFaces Extensions Showcase

MarkText - Wildcard Search

Wildcard search example for pe:markText demonstrating the wildcards attribute.

Search term:
Wildcard Mode:

Searchable Content

The quick brown fox jumps over the lazy dog. Running is essential for fitness. Programming and design go hand in hand.

Backend Data from Mark Event Listener

Last Matched Terms: No data received yet
Last Positions: No data received yet

Source

XHTML page
Managed bean


                <h:panelGrid columns="2" columnClasses="label,value">
        <h:outputText value="Search term:"/>
        <p:inputText id="searchInput" value="#{markTextWildcardController.searchTerm}" placeholder="Enter search term">
            <p:ajax event="keyup" delay="300" update="markText" process="@this"/>
        </p:inputText>

        <h:outputText value="Wildcard Mode:"/>
        <p:selectOneMenu id="wildcards" value="#{markTextWildcardController.wildcards}">
            <f:selectItem itemValue="disabled" itemLabel="Disabled" />
            <f:selectItem itemValue="enabled" itemLabel="Enabled (no spaces)" />
            <f:selectItem itemValue="withSpaces" itemLabel="Enabled (with spaces)" />
            <p:ajax event="change" update="markText" process="@this"/>
        </p:selectOneMenu>
    </h:panelGrid>

    <p:panel id="searchContainer" header="Searchable Content" style="margin-top: 20px">
        <p>#{markTextWildcardController.processedText}</p>
    </p:panel>

    <p:panel id="backendDataPanel" header="Backend Data from Mark Event Listener" style="margin-top: 20px">
        <h:outputText value="Last Matched Terms: #{empty markTextWildcardController.lastMatchedTerms ? 'No data received yet' : markTextWildcardController.lastMatchedTerms}" />
        <br/>
        <h:outputText value="Last Positions: #{empty markTextWildcardController.lastPositions ? 'No data received yet' : markTextWildcardController.lastPositions}" />
    </p:panel>

    <pe:markText id="markText" for="searchContainer" value="#{markTextWildcardController.searchTerm}" 
                 wildcards="#{markTextWildcardController.wildcards}" styleClass="marktext-highlight" caseSensitive="false">
        <p:ajax event="mark" listener="#{markTextWildcardController.onHighlight}" update="backendDataPanel messages" />
    </pe:markText>


                @Named
@ViewScoped
public class MarkTextWildcardController implements Serializable {

    private static final long serialVersionUID = 1L;

    private String searchTerm = "r*n";

    private String wildcards = "enabled"; // disabled | enabled | withSpaces

    private String processedText = "The quick brown fox jumps over the lazy dog. "
                + "Running is essential for fitness. "
                + "Programming and design go hand in hand.";

    private List<String> lastMatchedTerms = new ArrayList<>();

    private List<MarkPosition> lastPositions = new ArrayList<>();

    public String getSearchTerm() {
        return searchTerm;
    }

    public void setSearchTerm(String searchTerm) {
        this.searchTerm = searchTerm;
    }

    public String getWildcards() {
        return wildcards;
    }

    public void setWildcards(String wildcards) {
        this.wildcards = wildcards;
    }

    public String getProcessedText() {
        return processedText;
    }

    public List<String> getLastMatchedTerms() {
        return lastMatchedTerms;
    }

    public List<MarkPosition> getLastPositions() {
        return lastPositions;
    }

    public void onHighlight(MarkEvent event) {
        this.lastMatchedTerms = event.getMatchedTerms();
        this.lastPositions = event.getPositions();

        FacesContext.getCurrentInstance().addMessage(null,
                    new FacesMessage(FacesMessage.SEVERITY_INFO, "Mark Event Triggered",
                                "Found " + lastMatchedTerms.size() + " matched terms and " + lastPositions.size() + " positions."));
    }
}

Use Cases

Documentation pe:markText

Attributes (move mouse over the names to see data types)

Name	Description
accuracy	Search accuracy level: 'partially', 'complementarily', or 'exactly'.Default is partially.
acrossElements	Search across element boundaries.Default is false.
binding	An EL expression referring to a server side UIComponent instance in a backing bean.Default is generated.
caseSensitive	Whether the search should be case sensitive.Default is false.
diacritics	Whether accented and unaccented letters are treated as the same during matching.Default is true.
exclude	Array of exclusion selectors. Matches inside these elements will be ignored.
for	Search expression to resolve the target component to search within.
id	Unique identifier of the component in a namingContainer.Default is generated.
iframes	Whether matching should include same-origin iframe documents.Default is false.
iframesTimeout	Maximum wait time in milliseconds for iframe loading.Default is 5000.
rendered	Boolean value to specify the rendering of the component, when set to false component will not be rendered.Default is true.
separateWordSearch	Whether to match each word separately.Default is true.
style	Inline style of the component.
styleClass	Style class of the component.
synonyms	Map of synonyms for term matching.
value	Search terms to highlight. Can be a string or array of strings.
widgetVar	Name of the client-side widget.
wildcards	Wildcard matching mode: 'disabled'\|'enabled'\|'withSpaces'.Default is disabled.