[myfaces-tobago] branch tobago-5.x updated: docs(selectManyList): filter description

[hn...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

hnoeth pushed a commit to branch tobago-5.x
in repository https://gitbox.apache.org/repos/asf/myfaces-tobago.git


The following commit(s) were added to refs/heads/tobago-5.x by this push:
     new 0696c42307 docs(selectManyList): filter description
0696c42307 is described below

commit 0696c4230767049ef65940ca83b0477bea46808b
Author: Henning Noeth <hn...@apache.org>
AuthorDate: Wed Jan 18 10:50:02 2023 +0100

    docs(selectManyList): filter description
    
    Add a description for filter.
---
 .../myfaces/tobago/internal/taglib/declaration/HasFilter.java     | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/tobago-core/src/main/java/org/apache/myfaces/tobago/internal/taglib/declaration/HasFilter.java b/tobago-core/src/main/java/org/apache/myfaces/tobago/internal/taglib/declaration/HasFilter.java
index b11db54a21..21dfda3827 100644
--- a/tobago-core/src/main/java/org/apache/myfaces/tobago/internal/taglib/declaration/HasFilter.java
+++ b/tobago-core/src/main/java/org/apache/myfaces/tobago/internal/taglib/declaration/HasFilter.java
@@ -19,11 +19,19 @@
 
 package org.apache.myfaces.tobago.internal.taglib.declaration;
 
+import org.apache.myfaces.tobago.apt.annotation.Preliminary;
 import org.apache.myfaces.tobago.apt.annotation.TagAttribute;
 import org.apache.myfaces.tobago.apt.annotation.UIComponentTagAttribute;
 
 public interface HasFilter {
+
+  /**
+   * The name of the current filter.
+   * There are some predefined filters: contains, startsWith, containsExact, startsWithExact
+   * The TobagoFilterRegistry (tobago-filter-registry.ts) can be used to add a custom filter.
+   */
   @TagAttribute
   @UIComponentTagAttribute
+  @Preliminary
   void setFilter(String filter);
 }