core/com.maxkeppeler.sheets.core/Sheet

Sheet

abstract class Sheet : SheetFragment

This class is the base of all types of sheets. You can implement this class in your own and build your own custom sheet with the already existing features which the base class offers.

Constructors

fun Sheet()

Types

object Companion

Functions

addAddOnComponent

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

fun addAddOnComponent(addOnComponent: AddOnComponent)

addOnCreateViewListener

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

fun addOnCreateViewListener(onCreateViewListeners: OnViewCreatedListener)

fun behavior(behavior: Int)

Set the BottomSheetBehavior state.

fun borderColor(strokeColor: Int)

Set the border stroke color around the sheet. If no color is set, the primary color is used.

fun borderWidth(strokeWidthDp: Float)

fun borderWidth(@DimenRes strokeWidthDpRes: Int)

Set the border stroke width

cancelableOutside

fun cancelableOutside(cancelable: Boolean)

Set if sheet is cancelable outside.

closeIconButton

fun closeIconButton(iconButton: IconButton)

Set the Close Button Drawable.

fun cornerFamily(cornerFamily: Int)

Set the CornerFamily. Overrides the style default.

fun cornerRadius(cornerRadiusInDp: Float)

fun cornerRadius(@DimenRes cornerRadiusInDpRes: Int)

Set the corner radius in dp. Overrides the style default.

customLayoutHeight

fun customLayoutHeight(customLayoutHeight: Int)

Set the height of the custom sheet layout.

open override fun dismiss()

dismissAllowingStateLoss

open fun dismissAllowingStateLoss()

displayCloseButton

fun displayCloseButton(displayCloseButton: Boolean = true)

Display the close button left of the title. Overrides the style default.

fun displayHandle(displayHandle: Boolean = true)

Display the handle. Overrides the style default.

displayNegativeButton

fun displayNegativeButton(displayNegativeButton: Boolean)

Display the negative button.

displayPositiveButton

fun displayPositiveButton(displayPositiveButton: Boolean)

Display the positive button.

fun displayToolbar(displayToolbar: Boolean = true)

Display the toolbar. The toolbar consists of the close icon button, the title, the divider and the optional icon buttons. Overrides the style default.

fun draggable(draggable: Boolean)

Set if bottom-sheet is draggable. Only works with SheetStyle.BOTTOM_SHEET.

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?

getActualCornerFamily

fun getActualCornerFamily(): Int

getActualCornerRadius

fun getActualCornerRadius(): Float

getAllowEnterTransitionOverlap

open fun getAllowEnterTransitionOverlap(): Boolean

getAllowReturnTransitionOverlap

open fun getAllowReturnTransitionOverlap(): Boolean

fun getArguments(): Bundle?

getChildFragmentManager

fun getChildFragmentManager(): FragmentManager

open fun getContext(): Context?

getCoverAnimationView

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

fun <T> getCoverAnimationView(): T?

getDefaultViewModelProviderFactory

open override fun getDefaultViewModelProviderFactory(): ViewModelProvider.Factory

open fun getDialog(): Dialog?

getEnterTransition

open fun getEnterTransition(): Any?

getExitTransition

open fun getExitTransition(): Any?

getFragmentManager

~~fun~~ ~~getFragmentManager~~(): FragmentManager?

fun getHost(): Any?

fun getId(): Int

getLayoutInflater

fun getLayoutInflater(): LayoutInflater

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

~~open~~ ~~fun~~ ~~getLayoutInflater~~(@Nullable p0: Bundle?): LayoutInflater

open override fun getLifecycle(): Lifecycle

getLoaderManager

~~open~~ ~~fun~~ ~~getLoaderManager~~(): LoaderManager

getParentFragment

fun getParentFragment(): Fragment?

getParentFragmentManager

fun getParentFragmentManager(): FragmentManager

getReenterTransition

open fun getReenterTransition(): Any?

fun getResources(): Resources

getRetainInstance

~~fun~~ ~~getRetainInstance~~(): Boolean

getReturnTransition

open fun getReturnTransition(): Any?

getSavedStateRegistry

override fun getSavedStateRegistry(): SavedStateRegistry

getSharedElementEnterTransition

open fun getSharedElementEnterTransition(): Any?

getSharedElementReturnTransition

open fun getSharedElementReturnTransition(): Any?

open fun getShowsDialog(): Boolean

fun getString(@StringRes p0: Int): String

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

fun getTag(): String?

getTargetFragment

~~fun~~ ~~getTargetFragment~~(): Fragment?

getTargetRequestCode

~~fun~~ ~~getTargetRequestCode~~(): Int

fun getText(@StringRes p0: Int): CharSequence

open override fun getTheme(): Int

Override theme to allow auto switch between day & night design.

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

fun getTopStyle(): TopStyle

getUserVisibleHint

~~open~~ ~~fun~~ ~~getUserVisibleHint~~(): Boolean

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

open fun isCancelable(): 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

navigationBarColor

fun navigationBarColor(@ColorInt color: Int)

Set the color of the navigation bar.

navigationBarColorRes

fun navigationBarColorRes(@ColorRes colorRes: Int)

Set the color of the navigation bar.

negativeButtonColor

fun negativeButtonColor(@ColorInt negativeButtonColor: Int)

Set the negative button color.

negativeButtonColorRes

fun negativeButtonColorRes(@ColorRes negativeButtonColor: Int)

Set the negative button color.

negativeButtonStyle

fun negativeButtonStyle(negativeButtonStyle: ButtonStyle)

Set the negative button style.

onActivityCreated

~~open~~ ~~fun~~ ~~onActivityCreated~~(@Nullable p0: Bundle?)

onActivityResult

~~open~~ ~~fun~~ ~~onActivityResult~~( p0: Int, p1: Int, @Nullable p2: Intent?)

open override fun onAttach(@NonNull p0: Context)

~~open~~ ~~fun~~ ~~onAttach~~(@NonNull p0: Activity)

onAttachFragment

~~open~~ ~~fun~~ ~~onAttachFragment~~(@NonNull p0: Fragment)

open override fun onCancel(dialog: DialogInterface)

fun onCancel(cancelListener: CancelListener)

Set a listener that is invoked when the sheet is cancelled.

fun onClose(closeListener: CloseListener)

Set a listener that is invoked when the sheet is closed.

onConfigurationChanged

open override fun onConfigurationChanged(@NonNull p0: Configuration)

onContextItemSelected

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

open override fun onCreate(@Nullable p0: Bundle?)

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 override fun onCreateDialog(savedInstanceState: Bundle?): Dialog

onCreateLayoutView

abstract fun onCreateLayoutView(): View

Create custom view to be added to the base sheet.

onCreateOptionsMenu

open fun onCreateOptionsMenu(@NonNull p0: Menu, @NonNull p1: MenuInflater)

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

Create view of base sheet.

open fun onDestroy()

onDestroyOptionsMenu

open fun onDestroyOptionsMenu()

open override fun onDestroyView()

open override fun onDetach()

open override fun onDismiss(@NonNull p0: DialogInterface)

fun onDismiss(dismissListener: DismissListener)

Set a listener that is invoked when the sheet is dismissed (after negative or positive button click).

onGetLayoutInflater

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

onHiddenChanged

open fun onHiddenChanged(p0: Boolean)

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

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

open override fun onLowMemory()

onMultiWindowModeChanged

open fun onMultiWindowModeChanged(p0: Boolean)

fun onNegative(negativeListener: NegativeListener)

Set a listener.

fun onNegative(@StringRes negativeRes: Int, negativeListener: NegativeListener? = null)

fun onNegative(negativeText: String, negativeListener: NegativeListener? = null)

Set the text of the negative button and optionally a listener.

fun onNegative( @StringRes negativeRes: Int, @DrawableRes drawableRes: Int, negativeListener: NegativeListener? = null)

fun onNegative( negativeText: String, @DrawableRes drawableRes: Int, negativeListener: NegativeListener? = null)

Set the text and drawable of the negative button and optionally a listener.

onOptionsItemSelected

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

onOptionsMenuClosed

open fun onOptionsMenuClosed(@NonNull p0: Menu)

open fun onPause()

onPictureInPictureModeChanged

open fun onPictureInPictureModeChanged(p0: Boolean)

onPrepareOptionsMenu

open fun onPrepareOptionsMenu(@NonNull p0: Menu)

onPrimaryNavigationFragmentChanged

open fun onPrimaryNavigationFragmentChanged(p0: Boolean)

onRequestPermissionsResult

~~open~~ ~~fun~~ ~~onRequestPermissionsResult~~( p0: Int, @NonNull p1: Array<String>, @NonNull p2: IntArray)

open override fun onResume()

onSaveInstanceState

open override fun onSaveInstanceState(@NonNull p0: Bundle)

open override fun onStart()

open override fun onStop()

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

onViewStateRestored

open override fun onViewStateRestored(@Nullable p0: Bundle?)

fun peekHeight(peekHeight: Int)

Set the peek height.

positiveButtonColor

fun positiveButtonColor(@ColorInt positiveButtonColor: Int)

Set the positive button color.

positiveButtonColorRes

fun positiveButtonColorRes(@ColorRes positiveButtonColor: Int)

Set the positive button color.

positiveButtonStyle

fun positiveButtonStyle(positiveButtonStyle: ButtonStyle)

Set the positive button style.

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)

removeAddOnComponent

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

fun removeAddOnComponent(addOnComponent: AddOnComponent)

removeOnCreateViewListener

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

fun removeOnCreateViewListener(onCreateViewListener: OnViewCreatedListener)

requestPermissions

~~fun~~ ~~requestPermissions~~(@NonNull p0: Array<String>, p1: Int)

requireActivity

fun requireActivity(): FragmentActivity

requireArguments

fun requireArguments(): Bundle

fun requireContext(): Context

fun requireDialog(): Dialog

requireFragmentManager

~~fun~~ ~~requireFragmentManager~~(): FragmentManager

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?)

open fun setCancelable(p0: Boolean)

setCoverAnimationView

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

fun setCoverAnimationView(coverAnimationView: Any)

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?)

setHasOptionsMenu

open fun setHasOptionsMenu(p0: Boolean)

setInitialSavedState

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

setMenuVisibility

open fun setMenuVisibility(p0: Boolean)

setReenterTransition

open fun setReenterTransition(@Nullable p0: Any?)

setRetainInstance

~~open~~ ~~fun~~ ~~setRetainInstance~~(p0: Boolean)

setReturnTransition

open fun setReturnTransition(@Nullable p0: Any?)

setSharedElementEnterTransition

open fun setSharedElementEnterTransition(@Nullable p0: Any?)

setSharedElementReturnTransition

open fun setSharedElementReturnTransition(@Nullable p0: Any?)

open fun setShowsDialog(p0: Boolean)

open override fun setStyle(style: Int, theme: Int)

Override style to switch between sheet & dialog style.

setTargetFragment

~~open~~ ~~fun~~ ~~setTargetFragment~~(@Nullable p0: Fragment?, p1: Int)

setupCoverSource

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

fun setupCoverSource(imageSource: ImageSource, imageView: AppCompatImageView)

Setup an image source for the cover view.

open override fun setupDialog(dialog: Dialog, style: Int)

setUserVisibleHint

~~open~~ ~~fun~~ ~~setUserVisibleHint~~(p0: Boolean)

shouldShowRequestPermissionRationale

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

fun show()

Show the sheet.

open fun show(@NonNull p0: FragmentManager, @Nullable p1: String?)

open fun show(@NonNull p0: FragmentTransaction, @Nullable p1: String?): Int

open fun showNow(@NonNull p0: FragmentManager, @Nullable p1: String?)

open fun startActivity(p0: Intent)

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

startActivityForResult

~~open~~ ~~fun~~ ~~startActivityForResult~~(p0: Intent, p1: Int)

~~open~~ ~~fun~~ ~~startActivityForResult~~( p0: Intent, p1: Int, @Nullable p2: Bundle?)

startIntentSenderForResult

~~open~~ ~~fun~~ ~~startIntentSenderForResult~~( p0: IntentSender, p1: Int, @Nullable p2: Intent?, p3: Int, p4: Int, p5: Int, @Nullable p6: Bundle?)

startPostponedEnterTransition

open fun startPostponedEnterTransition()

fun style(style: SheetStyle)

Set sheet style.

fun title(@StringRes titleRes: Int)

fun title(title: String)

fun title(@StringRes titleRes: Int, vararg formatArgs: Any?)

Set the title of the sheet.

fun titleColor(@ColorInt titleColor: Int)

Set the title color of the sheet.

fun titleColorRes(@ColorRes titleColorRes: Int)

Set the title color of the sheet.

fun topStyle(topStyle: TopStyle)

Set the top style.

open override fun toString(): String

unregisterForContextMenu

open fun unregisterForContextMenu(@NonNull p0: View)

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

fun useCover(useCover: Boolean = true)

fun withCoverImage(image: Image)

Set a cover image.

fun withIconButton(iconButton: IconButton, listener: ClickListener? = null)

Add an icon button to the sheet toolbar to the right of the title. The icon buttons will be aligned from the right in the order you call this method. You can only add up to 3 icon buttons.

Properties

open override val dialogTag: String

open lateinit var windowContext: Context