search:search-ui/com.tomtom.sdk.search.ui/SearchFragment

SearchFragment

open class SearchFragment : Fragment

Fragment that consists of SearchView, SearchResultsView, SearchSuggestionView and brings features of these separate views into a single fragment.

Important: This is a Public Preview API. It may be changed or removed at any time.

Constructors

Link copied to clipboard

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
fun addSearchInputEmptyPlaceholderView(view: View)

Adds a custom view under either the com.tomtom.sdk.search.ui.SearchSuggestionView or SearchView if a suggestion has been set and is displayed on top of the SearchResultsView. The view is displayed when the SearchView does not contain any text.

Link copied to clipboard
fun clear()

Clears the SearchResultsView and the SearchView.

Link copied to clipboard
open fun dump(@NonNull p0: String, @Nullable p1: FileDescriptor?, @NonNull p2: PrintWriter, @Nullable p3: Array<String>?)
Link copied to clipboard
fun enableSearchBackButton(isEnabled: Boolean)

Allows you to disable the functionality of the search back button. The button is enabled by default and will be visible whenever there is text in the SearchView. Pressing the button clears all data in the SearchFragment.

Link copied to clipboard
operator override fun equals(@Nullable other: Any?): Boolean
Link copied to clipboard
@Nullable
fun getActivity(): FragmentActivity?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@Nullable
fun getArguments(): Bundle?
Link copied to clipboard
@NonNull
fun getChildFragmentManager(): FragmentManager
Link copied to clipboard
@Nullable
open fun getContext(): Context?
Link copied to clipboard
@NonNull
@CallSuper
open override fun getDefaultViewModelCreationExtras(): CreationExtras
Link copied to clipboard
@NonNull
open override fun getDefaultViewModelProviderFactory(): ViewModelProvider.Factory
Link copied to clipboard
@Nullable
open fun getEnterTransition(): Any?
Link copied to clipboard
@Nullable
open fun getExitTransition(): Any?
Link copied to clipboard
@Nullable
fun getHost(): Any?
Link copied to clipboard
fun getId(): Int
Link copied to clipboard
Link copied to clipboard
@NonNull
open override fun getLifecycle(): Lifecycle
Link copied to clipboard
@Nullable
fun getParentFragment(): Fragment?
Link copied to clipboard
@NonNull
fun getParentFragmentManager(): FragmentManager
Link copied to clipboard
@Nullable
open fun getReenterTransition(): Any?
Link copied to clipboard
@NonNull
fun getResources(): Resources
Link copied to clipboard
@Nullable
open fun getReturnTransition(): Any?
Link copied to clipboard
@Nullable
open fun getSharedElementEnterTransition(): Any?
Link copied to clipboard
@Nullable
open fun getSharedElementReturnTransition(): Any?
Link copied to clipboard
@NonNull
fun getString(@StringRes p0: Int): String
@NonNull
fun getString(@StringRes p0: Int, @Nullable vararg p1: Any): String
Link copied to clipboard
@Nullable
fun getTag(): String?
Link copied to clipboard
@NonNull
fun getText(@StringRes p0: Int): CharSequence
Link copied to clipboard
@Nullable
open fun getView(): View?
Link copied to clipboard
@MainThread
@NonNull
open fun getViewLifecycleOwner(): LifecycleOwner
Link copied to clipboard
@NonNull
open fun getViewLifecycleOwnerLiveData(): LiveData<LifecycleOwner>
Link copied to clipboard
@NonNull
open override fun getViewModelStore(): ViewModelStore
Link copied to clipboard
override fun hashCode(): Int
Link copied to clipboard
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])
fun hasOptionsMenu(): Boolean
Link copied to clipboard
fun isAdded(): Boolean
Link copied to clipboard
Link copied to clipboard
fun isHidden(): Boolean
Link copied to clipboard
Link copied to clipboard
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])
fun isMenuVisible(): Boolean
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@MainThread
@CallSuper
open fun onAttach(@NonNull p0: Context)
Link copied to clipboard
@CallSuper
open override fun onConfigurationChanged(@NonNull p0: Configuration)
Link copied to clipboard
@MainThread
open fun onContextItemSelected(@NonNull p0: MenuItem): Boolean
Link copied to clipboard
open override fun onCreate(savedInstanceState: Bundle?)
Link copied to clipboard
@MainThread
@Nullable
open fun onCreateAnimation(p0: Int, p1: Boolean, p2: Int): Animation?
Link copied to clipboard
@MainThread
@Nullable
open fun onCreateAnimator(p0: Int, p1: Boolean, p2: Int): Animator?
Link copied to clipboard
@MainThread
open override fun onCreateContextMenu(@NonNull p0: ContextMenu, @NonNull p1: View, @Nullable p2: ContextMenu.ContextMenuInfo?)
Link copied to clipboard
open override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View?
Link copied to clipboard
@MainThread
@CallSuper
open fun onDestroy()
Link copied to clipboard
open override fun onDestroyView()
Link copied to clipboard
@MainThread
@CallSuper
open fun onDetach()
Link copied to clipboard
@NonNull
open fun onGetLayoutInflater(@Nullable p0: Bundle?): LayoutInflater
Link copied to clipboard
@MainThread
open fun onHiddenChanged(p0: Boolean)
Link copied to clipboard
@UiThread
@CallSuper
open fun onInflate(@NonNull p0: Context, @NonNull p1: AttributeSet, @Nullable p2: Bundle?)
Link copied to clipboard
@MainThread
@CallSuper
open override fun onLowMemory()
Link copied to clipboard
Link copied to clipboard
open override fun onPause()
Link copied to clipboard
Link copied to clipboard
@MainThread
open fun onPrimaryNavigationFragmentChanged(p0: Boolean)
Link copied to clipboard
open override fun onResume()
Link copied to clipboard
@MainThread
open fun onSaveInstanceState(@NonNull p0: Bundle)
Link copied to clipboard
@MainThread
@CallSuper
open fun onStart()
Link copied to clipboard
@MainThread
@CallSuper
open fun onStop()
Link copied to clipboard
open override fun onViewCreated(view: View, savedInstanceState: Bundle?)
Link copied to clipboard
@MainThread
@CallSuper
open fun onViewStateRestored(@Nullable p0: Bundle?)
Link copied to clipboard
open fun postponeEnterTransition()
fun postponeEnterTransition(p0: Long, @NonNull p1: TimeUnit)
Link copied to clipboard
@MainThread
@NonNull
override fun <I : Any, O : Any> registerForActivityResult(@NonNull p0: ActivityResultContract<I, O>, @NonNull p1: ActivityResultCallback<O>): ActivityResultLauncher<I>
@MainThread
@NonNull
override fun <I : Any, O : Any> registerForActivityResult(@NonNull p0: ActivityResultContract<I, O>, @NonNull p1: ActivityResultRegistry, @NonNull p2: ActivityResultCallback<O>): ActivityResultLauncher<I>
Link copied to clipboard
open fun registerForContextMenu(@NonNull p0: View)
Link copied to clipboard
fun removeSearchInputEmptyPlaceholderView(view: View)

Removes the custom view displayed either under the com.tomtom.sdk.search.ui.SearchSuggestionView or under the SearchView, depending if a suggestion is set and over the SearchResultsView. The view is displayed when the SearchView does not contain any text.

Link copied to clipboard
@NonNull
fun requireActivity(): FragmentActivity
Link copied to clipboard
@NonNull
fun requireArguments(): Bundle
Link copied to clipboard
@NonNull
fun requireContext(): Context
Link copied to clipboard
@NonNull
fun requireHost(): Any
Link copied to clipboard
@NonNull
fun requireParentFragment(): Fragment
Link copied to clipboard
@NonNull
fun requireView(): View
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun setArguments(@Nullable p0: Bundle?)
Link copied to clipboard
open fun setEnterSharedElementCallback(@Nullable p0: SharedElementCallback?)
Link copied to clipboard
open fun setEnterTransition(@Nullable p0: Any?)
Link copied to clipboard
open fun setExitSharedElementCallback(@Nullable p0: SharedElementCallback?)
Link copied to clipboard
open fun setExitTransition(@Nullable p0: Any?)
Link copied to clipboard
fun setFragmentListener(fragmentListener: SearchFragmentListener?)

Sets a SearchFragmentListener for this fragment.

Link copied to clipboard
open fun setInitialSavedState(@Nullable p0: Fragment.SavedState?)
Link copied to clipboard
open fun setMenuVisibility(p0: Boolean)
Link copied to clipboard
fun setQuery(query: String)

Sets text on the SearchView and triggers searching if the text is not empty.

Link copied to clipboard
open fun setReenterTransition(@Nullable p0: Any?)
Link copied to clipboard
open fun setReturnTransition(@Nullable p0: Any?)
Link copied to clipboard
fun setSearchApi(searchApi: SearchApi)
Link copied to clipboard
open fun setSharedElementEnterTransition(@Nullable p0: Any?)
Link copied to clipboard
open fun setSharedElementReturnTransition(@Nullable p0: Any?)
Link copied to clipboard
fun setSuggestion(suggestion: SearchSuggestion)

Sets the suggestion that appears under the SearchView.

Link copied to clipboard
fun setupSearch(searchProperties: SearchProperties)

Loads the passed SearchProperties into the SearchView.

Link copied to clipboard
Link copied to clipboard
open fun startActivity(p0: Intent)
open fun startActivity(p0: Intent, @Nullable p1: Bundle?)
Link copied to clipboard
Link copied to clipboard
@NonNull
open override fun toString(): String
Link copied to clipboard
open fun unregisterForContextMenu(@NonNull p0: View)

Properties

Link copied to clipboard
@RestrictTo(value = [RestrictTo.Scope.LIBRARY])
@Nullable
var mPreviousWho: String?
Link copied to clipboard
@get:NonNull
override val savedStateRegistry: SavedStateRegistry