1 /* 2 * Copyright (C) 2022 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 package com.android.quicksearchbox 17 18 import android.text.Spannable 19 20 /** 21 * Suggestion formatter interface. This is used to bold (or otherwise highlight) portions of a 22 * suggestion which were not a part of the query. 23 */ 24 abstract class SuggestionFormatter 25 protected constructor(private val mSpanFactory: TextAppearanceFactory) { 26 /** 27 * Formats a suggestion for display in the UI. 28 * 29 * @param query the query as entered by the user 30 * @param suggestion the suggestion 31 * @return Formatted suggestion text. 32 */ formatSuggestionnull33 abstract fun formatSuggestion(query: String?, suggestion: String?): CharSequence? 34 protected fun applyQueryTextStyle(text: Spannable, start: Int, end: Int) { 35 if (start == end) return 36 setSpans(text, start, end, mSpanFactory.createSuggestionQueryTextAppearance()) 37 } 38 applySuggestedTextStylenull39 protected fun applySuggestedTextStyle(text: Spannable, start: Int, end: Int) { 40 if (start == end) return 41 setSpans(text, start, end, mSpanFactory.createSuggestionSuggestedTextAppearance()) 42 } 43 setSpansnull44 private fun setSpans(text: Spannable, start: Int, end: Int, spans: Array<Any>) { 45 for (span in spans) { 46 text.setSpan(span, start, end, 0) 47 } 48 } 49 } 50