persistent search view

ПерсистентSearchView

Библиотека Android, предназначенная для упрощения процесса реализации функций, связанных с поиском.

Содержание

• Демо
• Начиная
• Базовая реализация
• Реализация основных последних предложений
• Внедрение основных регулярных предложений
• Расширенное использование
• Разница между недавними и обычными предложениями
• Вклад
• зал славы
• Лицензия

Демо (YouTube)

Начиная

1. Убедитесь, что вы добавили репозиторий mavenCentral() в файл build.gradle верхнего уровня.

buildscript {
    // ...
    repositories {
        // ...
        mavenCentral()
    }
    // ...
}

2. Добавьте зависимость библиотеки в файл build.gradle уровня модуля.

dependencies {
    implementation " com.paulrybitskyi.persistentsearchview:persistentsearchview:1.1.5 "
}

3. Если ваш targetSdk равен 30 и вы хотите использовать функцию голосового поиска, добавьте эти строки в AndroidManifest.xml вашего приложения:

< manifest ...>

    //...
    < queries >
        < intent >
            < action android : name = " android.speech.RecognitionService " />
        </ intent >
    </ queries >
    //...

</ manifest >

4. Приступайте к реализации собственного представления поиска.

Базовая реализация

Реализация PersistentSearchView с базовой функциональностью включает в себя два основных шага: объявление виджета внутри выбранного вами XML-файла и его настройка в одном из классов Java/Kotlin.

Давайте реализуем PersistentSearchView с базовыми функциями, выполнив шаги, перечисленные выше:

1. Объявление виджета внутри XML-файла.

   XML (нажмите, чтобы развернуть)

   <? xml version = " 1.0 " encoding = " utf-8 " ?>
   < RelativeLayout
       xmlns : android = " http://schemas.android.com/apk/res/android "
       xmlns : app = " http://schemas.android.com/apk/res-auto "
       android : layout_width = " match_parent "
       android : layout_height = " match_parent " >
   
       <!-- Other widgets here -->
   
       < com .paulrybitskyi.persistentsearchview.PersistentSearchView
           android : id = " @+id/persistentSearchView "
           android : layout_width = " match_parent "
           android : layout_height = " wrap_content "
           android : paddingTop = " 4dp "
           android : paddingLeft = " 4dp "
           android : paddingStart = " 4dp "
           android : paddingRight = " 4dp "
           android : paddingEnd = " 4dp " />
   
   </ RelativeLayout >

2. Настройка виджета в одном из классов Java/Kotlin.

   Котлин (нажмите, чтобы развернуть)

    override fun onCreate ( savedInstanceState : Bundle ? ) {
       super .onCreate(savedInstanceState)
       setContentView( R .layout.demo_activity_layout)
   
       // ...
   
       with (persistentSearchView) {
           setOnLeftBtnClickListener {
               // Handle the left button click
           }
           setOnClearInputBtnClickListener {
               // Handle the clear input button click
           }
   
           // Setting a delegate for the voice recognition input
           setVoiceRecognitionDelegate( VoiceRecognitionDelegate ( this @DemoActivity))
   
           setOnSearchConfirmedListener { searchView, query ->
               // Handle a search confirmation. This is the place where you'd
               // want to perform a search against your data provider.
           }
   
           // Disabling the suggestions since they are unused in
           // the simple implementation
           setSuggestionsDisabled( true )
       }
   }
   
   
   // ...
   
   
   override fun onActivityResult ( requestCode : Int , resultCode : Int , data : Intent ? ) {
       super .onActivityResult(requestCode, resultCode, data)
   
       // Calling the voice recognition delegate to properly handle voice input results
       VoiceRecognitionDelegate .handleResult(persistentSearchView, requestCode, resultCode, data)
   }

   Java (нажмите, чтобы развернуть)

    @ Override
   protected void onCreate ( Bundle savedInstanceState ) {
       super . onCreate ( savedInstanceState );
       setContentView ( R . layout . demo_activity_layout );
   
       //...
   
       persistentSearchView . setOnLeftBtnClickListener ( new OnClickListener () {
   
           @ Override
           public void onClick ( View view ) {
               // Handle the left button click
           }
   
       });
   
       persistentSearchView . setOnClearInputBtnClickListener ( new OnClickListener () {
   
           @ Override
           public void onClick ( View view ) {
               // Handle the clear input button click
           }
   
       });
   
       // Setting a delegate for the voice recognition input
       persistentSearchView . setVoiceRecognitionDelegate ( new VoiceRecognitionDelegate ( this ));
   
       persistentSearchView . setOnSearchConfirmedListener ( new OnSearchConfirmedListener () {
   
           @ Override
           public void onSearchConfirmed ( PersistentSearchView searchView , String query ) {
               // Handle a search confirmation. This is the place where you'd
               // want to perform a search against your data provider.
           }
   
       });
   
       // Disabling the suggestions since they are unused in
       // the simple implementation
       persistentSearchView . setSuggestionsDisabled ();
   }
   
   
   //...
   
   
   @ Override
   protected fun onActivityResult ( int requestCode , int resultCode , Intent data ) {
       super . onActivityResult ( requestCode , resultCode , data );
   
       // Calling the voice recognition delegate to properly handle voice input results
       VoiceRecognitionDelegate . handleResult ( persistentSearchView , requestCode , resultCode , data );
   }

Реализация основных последних предложений

Реализация PersistentSearchView с последними предложениями во многом аналогична базовой реализации, за одним исключением: конфигурация представления.

В этой реализации вам нужно будет предоставить немного больше настроек для виджета, чтобы показывать последние предложения пользователю, например, предоставить реализацию для нескольких слушателей, а также получить предложения от вашего поставщика данных и настроить их для поиска. вид.

Например, вот конфигурация виджета с функциями последних предложений:

Java (нажмите, чтобы развернуть)

 @ Override
protected void onCreate ( Bundle savedInstanceState ) {
    super . onCreate ( savedInstanceState );
    setContentView ( R . layout . demo_activity_layout );

    //...

    persistentSearchView . setOnLeftBtnClickListener ( new OnClickListener () {
        
        @ Override
        public void onClick ( View view ) {
            // Handle the left button click
        }

    });

    persistentSearchView . setOnClearInputBtnClickListener ( new OnClickListener () {
        
        @ Override
        public void onClick ( View view ) {
            // Handle the clear input button click
        }

    });

    // Setting a delegate for the voice recognition input
    persistentSearchView . setVoiceRecognitionDelegate ( new VoiceRecognitionDelegate ( this ));

    persistentSearchView . setOnSearchConfirmedListener ( new OnSearchConfirmedListener () {

        @ Override
        public void onSearchConfirmed ( PersistentSearchView searchView , String query ) {
            // Handle a search confirmation. This is the place where you'd
            // want to save a new query and perform a search against your
            // data provider.
        }

    });

    persistentSearchView . setOnSearchQueryChangeListener ( new OnSearchQueryChangeListener () {
        
        @ Override
        public void onSearchQueryChanged ( PersistentSearchView searchView , String oldQuery , String newQuery ) {
            // Handle a search query change. This is the place where you'd
            // want load new suggestions based on the newQuery parameter.
        }

    });

    persistentSearchView . setOnSuggestionChangeListener ( new OnSuggestionChangeListener () {

        @ Override
        public void onSuggestionPicked ( SuggestionItem suggestion ) {
            // Handle a suggestion pick event. This is the place where you'd
            // want to perform a search against your data provider.
        }

        @ Override
        public void onSuggestionRemoved ( SuggestionItem suggestion ) {
            // Handle a suggestion remove event. This is the place where
            // you'd want to remove the suggestion from your data provider.
        }

    });
}
	

//...


@ Override
public void onResume () {
    super . onResume ();

    List < String > searchQueries = null ;

    // Fetching the search queries from the data provider
    if ( persistentSearchView . isInputQueryEmpty ) {
        searchQueries = mDataProvider . getInitialSearchQueries ();
    } else {
        searchQueries = mDataProvider . getSuggestionsForQuery ( persistentSearchView . inputQuery );
    }

    // Converting them to recent suggestions and setting them to the widget
    persistentSearchView . setSuggestions ( SuggestionCreationUtil . asRecentSearchSuggestions ( searchQueries ), false );
}

	
//...


@ Override
protected fun onActivityResult ( int requestCode , int resultCode , Intent data ) {
    super . onActivityResult ( requestCode , resultCode , data );

    // Calling the voice recognition delegate to properly handle voice input results
    VoiceRecognitionDelegate . handleResult ( persistentSearchView , requestCode , resultCode , data );
}

Котлин (нажмите, чтобы развернуть)

 override fun onCreate ( savedInstanceState : Bundle ? ) {
    super .onCreate(savedInstanceState)
    setContentView( R .layout.demo_activity_layout)

    // ...

    with (persistentSearchView) {
        setOnLeftBtnClickListener {
            // Handle the left button click
        }
        setOnClearInputBtnClickListener {
            // Handle the clear input button click
        }

        // Setting a delegate for the voice recognition input
        setVoiceRecognitionDelegate( VoiceRecognitionDelegate ( this @DemoActivity))

        setOnSearchConfirmedListener { searchView, query ->
            // Handle a search confirmation. This is the place where you'd
            // want to save a new query and perform a search against your
            // data provider.
        }

        setOnSearchQueryChangeListener { searchView, oldQuery, newQuery ->
            // Handle a search query change. This is the place where you'd
            // want load new suggestions based on the newQuery parameter.
        }

        setOnSuggestionChangeListener( object : OnSuggestionChangeListener {

            override fun onSuggestionPicked ( suggestion : SuggestionItem ) {
                // Handle a suggestion pick event. This is the place where you'd
                // want to perform a search against your data provider.
            }

            override fun onSuggestionRemoved ( suggestion : SuggestionItem ) {
                // Handle a suggestion remove event. This is the place where
                // you'd want to remove the suggestion from your data provider.
            }

        })
    }
}


// ...


override fun onResume () {
    super .onResume()

    // Fetching the search queries from the data provider
    val searchQueries = if (persistentSearchView.isInputQueryEmpty) {
        mDataProvider.getInitialSearchQueries()
    } else {
        mDataProvider.getSuggestionsForQuery(persistentSearchView.inputQuery)
    }

    // Converting them to recent suggestions and setting them to the widget
    persistentSearchView.setSuggestions( SuggestionCreationUtil .asRecentSearchSuggestions(searchQueries), false )
}


// ...


override fun onActivityResult ( requestCode : Int , resultCode : Int , data : Intent ? ) {
    super .onActivityResult(requestCode, resultCode, data)

    // Calling the voice recognition delegate to properly handle voice input results
    VoiceRecognitionDelegate .handleResult(persistentSearchView, requestCode, resultCode, data)
}

Внедрение основных регулярных предложений

Реализация PersistentSearchView с обычными предложениями идентична реализации базовых последних предложений, за одним исключением: метод создания предложений asRecentSearchSuggestions(searchQueries) следует заменить на asRegularSearchSuggestions(searchQueries).

Расширенное использование

См. пример приложения.

Разница между недавними и обычными предложениями

Разница между недавними и обычными предложениями заключается в том, что пользователь может удалить последние предложения из списка, тогда как обычные предложения удалить нельзя (в обычных предложениях нет кнопки удаления).

Например, вот скриншоты последних предложений по сравнению с обычными:

Недавний	Обычный

Вклад

См. файл CONTRIBUTING.md.

зал славы

Сова

Используете PersistentSearchView в своем приложении и хотите, чтобы он был указан здесь? Пишите мне на почту [email protected]!

Лицензия

PersistentSearchView лицензируется по лицензии Apache 2.0.