com.tomtom.sdk.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

constructor()

Types

object Companion

Inherited properties

@RestrictTo(value = [RestrictTo.Scope.LIBRARY])

var mPreviousWho: String?

savedStateRegistry

override val savedStateRegistry: SavedStateRegistry

Functions

addSearchInputEmptyPlaceholderView

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.

fun clear()

Clears the SearchResultsView and the SearchView.

enableSearchBackButton

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.

open override fun onCreate(savedInstanceState: Bundle?)

open override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View?

open override fun onDestroyView()

open override fun onPause()

open override fun onResume()

open override fun onViewCreated(view: View, savedInstanceState: Bundle?)

removeSearchInputEmptyPlaceholderView

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.

setFragmentListener

fun setFragmentListener(fragmentListener: SearchFragmentListener?)

Sets a SearchFragmentListener for this fragment.

fun setQuery(query: String)

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

fun setSearchApi(search: Search)

fun setSuggestion(suggestion: SearchSuggestion)

Sets the suggestion that appears under the SearchView.

fun setupSearch(searchProperties: SearchProperties)

Loads the passed SearchProperties into the SearchView.

Inherited functions

open fun dump(@NonNull p0: String, @Nullable p1: FileDescriptor?, @NonNull p2: PrintWriter, @Nullable p3: Array<String>?)

operator override fun equals(@Nullable other: Any?): Boolean

fun getActivity(): FragmentActivity?

getAllowEnterTransitionOverlap

open fun getAllowEnterTransitionOverlap(): Boolean

getAllowReturnTransitionOverlap

open fun getAllowReturnTransitionOverlap(): Boolean

fun getArguments(): Bundle?

getChildFragmentManager

fun getChildFragmentManager(): FragmentManager

open fun getContext(): Context?

getDefaultViewModelCreationExtras

open override fun getDefaultViewModelCreationExtras(): CreationExtras

getDefaultViewModelProviderFactory

open override fun getDefaultViewModelProviderFactory(): ViewModelProvider.Factory

getEnterTransition

open fun getEnterTransition(): Any?

getExitTransition

open fun getExitTransition(): Any?

fun getHost(): Any?

fun getId(): Int

getLayoutInflater

fun getLayoutInflater(): LayoutInflater

open override fun getLifecycle(): Lifecycle

getParentFragment

fun getParentFragment(): Fragment?

getParentFragmentManager

fun getParentFragmentManager(): FragmentManager

getReenterTransition

open fun getReenterTransition(): Any?

fun getResources(): Resources

getReturnTransition

open fun getReturnTransition(): Any?

getSharedElementEnterTransition

open fun getSharedElementEnterTransition(): Any?

getSharedElementReturnTransition

open fun getSharedElementReturnTransition(): Any?

fun getString(@StringRes p0: Int): String

fun getString(@StringRes p0: Int, @Nullable vararg p1: Any): String

fun getTag(): String?

fun getText(@StringRes p0: Int): CharSequence

open fun getView(): View?

getViewLifecycleOwner

open fun getViewLifecycleOwner(): LifecycleOwner

getViewLifecycleOwnerLiveData

open fun getViewLifecycleOwnerLiveData(): LiveData<LifecycleOwner>

getViewModelStore

open override fun getViewModelStore(): ViewModelStore

override fun hashCode(): Int

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

fun hasOptionsMenu(): Boolean

fun isAdded(): Boolean

fun isDetached(): Boolean

fun isHidden(): Boolean

fun isInLayout(): Boolean

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

fun isMenuVisible(): Boolean

fun isRemoving(): Boolean

fun isResumed(): Boolean

fun isStateSaved(): Boolean

fun isVisible(): Boolean

open fun onAttach(@NonNull p0: Context)

onConfigurationChanged

open override fun onConfigurationChanged(@NonNull p0: Configuration)

onContextItemSelected

open fun onContextItemSelected(@NonNull p0: MenuItem): Boolean

onCreateAnimation

open fun onCreateAnimation(p0: Int, p1: Boolean, p2: Int): Animation?

onCreateAnimator

open fun onCreateAnimator(p0: Int, p1: Boolean, p2: Int): Animator?

onCreateContextMenu

open override fun onCreateContextMenu(@NonNull p0: ContextMenu, @NonNull p1: View, @Nullable p2: ContextMenu.ContextMenuInfo?)

open fun onDestroy()

open fun onDetach()

onGetLayoutInflater

open fun onGetLayoutInflater(@Nullable p0: Bundle?): LayoutInflater

onHiddenChanged

open fun onHiddenChanged(p0: Boolean)

open fun onInflate(@NonNull p0: Context, @NonNull p1: AttributeSet, @Nullable p2: Bundle?)

open override fun onLowMemory()

onMultiWindowModeChanged

open fun onMultiWindowModeChanged(p0: Boolean)

onPictureInPictureModeChanged

open fun onPictureInPictureModeChanged(p0: Boolean)

onPrimaryNavigationFragmentChanged

open fun onPrimaryNavigationFragmentChanged(p0: Boolean)

onSaveInstanceState

open fun onSaveInstanceState(@NonNull p0: Bundle)

open fun onStart()

open fun onStop()

onViewStateRestored

open fun onViewStateRestored(@Nullable p0: Bundle?)

postponeEnterTransition

open fun postponeEnterTransition()

fun postponeEnterTransition(p0: Long, @NonNull p1: TimeUnit)

registerForActivityResult

override fun <I : Any, O : Any> registerForActivityResult(@NonNull p0: ActivityResultContract<I, O>, @NonNull p1: ActivityResultCallback<O>): ActivityResultLauncher<I>

override fun <I : Any, O : Any> registerForActivityResult(@NonNull p0: ActivityResultContract<I, O>, @NonNull p1: ActivityResultRegistry, @NonNull p2: ActivityResultCallback<O>): ActivityResultLauncher<I>

registerForContextMenu

open fun registerForContextMenu(@NonNull p0: View)

requireActivity

fun requireActivity(): FragmentActivity

requireArguments

fun requireArguments(): Bundle

fun requireContext(): Context

fun requireHost(): Any

requireParentFragment

fun requireParentFragment(): Fragment

fun requireView(): View

setAllowEnterTransitionOverlap

open fun setAllowEnterTransitionOverlap(p0: Boolean)

setAllowReturnTransitionOverlap

open fun setAllowReturnTransitionOverlap(p0: Boolean)

open fun setArguments(@Nullable p0: Bundle?)

setEnterSharedElementCallback

open fun setEnterSharedElementCallback(@Nullable p0: SharedElementCallback?)

setEnterTransition

open fun setEnterTransition(@Nullable p0: Any?)

setExitSharedElementCallback

open fun setExitSharedElementCallback(@Nullable p0: SharedElementCallback?)

setExitTransition

open fun setExitTransition(@Nullable p0: Any?)

setInitialSavedState

open fun setInitialSavedState(@Nullable p0: Fragment.SavedState?)

setMenuVisibility

open fun setMenuVisibility(p0: Boolean)

setReenterTransition

open fun setReenterTransition(@Nullable p0: Any?)

setReturnTransition

open fun setReturnTransition(@Nullable p0: Any?)

setSharedElementEnterTransition

open fun setSharedElementEnterTransition(@Nullable p0: Any?)

setSharedElementReturnTransition

open fun setSharedElementReturnTransition(@Nullable p0: Any?)

shouldShowRequestPermissionRationale

open fun shouldShowRequestPermissionRationale(@NonNull p0: String): Boolean

open fun startActivity(p0: Intent)

open fun startActivity(p0: Intent, @Nullable p1: Bundle?)

startPostponedEnterTransition

open fun startPostponedEnterTransition()

open override fun toString(): String

unregisterForContextMenu

open fun unregisterForContextMenu(@NonNull p0: View)