@eclipse-scout/core/dist/d.ts/src/desktop/outline/pages/SearchFieldTextContributors.d.ts

Eclipse Scout runtime

import { FormField, ObjectRegistry } from '../../..';
export declare class SearchFilterTextContributors extends ObjectRegistry<SearchFilterTextContributor> {
    static get(): SearchFilterTextContributors;
    static all(): SearchFilterTextContributor[];
}
/**
 * Contributes a search text for a field to {@link SearchFilterTextBuilder}.
 *
 * For each field the first non-empty text of a contributor is used.
 * The text should include the label of the field and its display text, typically but not necessarily separated by ': '.
 */
export declare abstract class SearchFilterTextContributor {
    /**
     * Joins the given label and display text separated by ': ' but only if there is a display text.
     */
    protected _join(label: string, displayText: string): string;
    abstract contribute(field: FormField): Promise<string>;
}
/**
 * Default contributor that handles the common fields used in a search form.
 *
 * It has a low priority so other contributors will come first by default.
 */
export declare class DefaultSearchFilterTextContributor extends SearchFilterTextContributor {
    contribute(field: FormField): Promise<string>;
}
//# sourceMappingURL=SearchFieldTextContributors.d.ts.map