You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@royale.apache.org by ca...@apache.org on 2020/05/06 14:28:17 UTC
[royale-asjs] branch develop updated: jewel-searchforlist: add some
docs for the new changes
This is an automated email from the ASF dual-hosted git repository.
carlosrovira pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/royale-asjs.git
The following commit(s) were added to refs/heads/develop by this push:
new 6a13df9 jewel-searchforlist: add some docs for the new changes
6a13df9 is described below
commit 6a13df9d4bac41bc35e63b356cb97f19b074c57b
Author: Carlos Rovira <ca...@apache.org>
AuthorDate: Wed May 6 16:28:13 2020 +0200
jewel-searchforlist: add some docs for the new changes
---
.../royale/jewel/beads/controls/textinput/SearchFilterForList.as | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/beads/controls/textinput/SearchFilterForList.as b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/beads/controls/textinput/SearchFilterForList.as
index 950be34..c601e6f 100644
--- a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/beads/controls/textinput/SearchFilterForList.as
+++ b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/beads/controls/textinput/SearchFilterForList.as
@@ -192,6 +192,10 @@ package org.apache.royale.jewel.beads.controls.textinput
/**
* the filter function to use to filter entries in the list
+ *
+ * Notice that defaultFilterFunction receive a text string, while a custom filter
+ * function can receive the whole data object from the renderer so the user can make
+ * an kind of process over the data object and its subfields
*/
[Bindable]
public var filterFunction:Function = defaultFilterFunction;
@@ -267,6 +271,9 @@ package org.apache.royale.jewel.beads.controls.textinput
/**
* default filter function just filters substrings
* you can use other advanced methods like levenshtein distance
+ *
+ * notice that defaultFilterFunction receive a text string, while a custom filter
+ * function can receive the whole data object from the renderer.
*
* @param text, the text where perform the seach
* @param filterText, the text to use as Filter