mvvmframe/com.king.frame.mvvmframe.base/BaseFragment

BaseFragment

abstract class BaseFragment<VM : BaseViewModel, VDB : ViewDataBinding> : Fragment, IView<VM> , CombinedController

MVVMFrame 框架基于 Google 官方的 JetPack 构建，在使用 MVVMFrame 时，需遵循一些规范：

如果您继承使用了 BaseFragment 或其子类，你需要参照如下方式添加 @AndroidEntryPoint 注解标记，来进行注入

// 示例
@AndroidEntryPoint
class YourFragment: BaseFragment() {

}

Author

Jenly

Follow me

Constructors

BaseFragment

constructor()

Properties

activity

val activity: @Nullable FragmentActivity?

allowEnterTransitionOverlap

open var allowEnterTransitionOverlap: Boolean

allowReturnTransitionOverlap

open var allowReturnTransitionOverlap: Boolean

arguments

var arguments: @Nullable Bundle?

binding

val binding: VDB

childFragmentManager

val childFragmentManager: @NonNull FragmentManager

context

open val context: @Nullable Context?

defaultViewModelCreationExtras

@get:CallSuper

open val defaultViewModelCreationExtras: @NonNull CreationExtras

defaultViewModelProviderFactory

open val defaultViewModelProviderFactory: @NonNull ViewModelProvider.Factory

enterTransition

open var enterTransition: @Nullable Any?

exitTransition

open var exitTransition: @Nullable Any?

fragmentManager

val fragmentManager: @Nullable FragmentManager?

host

val host: @Nullable Any?

val id: Int

isAdded

val isAdded: Boolean

isDetached

val isDetached: Boolean

isHidden

val isHidden: Boolean

isInLayout

val isInLayout: Boolean

isMenuVisible

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

val isMenuVisible: Boolean

isRemoving

val isRemoving: Boolean

isResumed

val isResumed: Boolean

isStateSaved

val isStateSaved: Boolean

isVisible

val isVisible: Boolean

layoutInflater

val layoutInflater: @NonNull LayoutInflater

lifecycle

open val lifecycle: @NonNull Lifecycle

loaderManager

open val loaderManager: @NonNull LoaderManager

mPreviousWho

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

var mPreviousWho: @Nullable String?

parentFragment

val parentFragment: @Nullable Fragment?

parentFragmentManager

val parentFragmentManager: @NonNull FragmentManager

reenterTransition

open var reenterTransition: @Nullable Any?

resources

val resources: @NonNull Resources

retainInstance

var retainInstance: Boolean

returnTransition

open var returnTransition: @Nullable Any?

rootView

var rootView: View?

savedStateRegistry

val savedStateRegistry: @NonNull SavedStateRegistry

sharedElementEnterTransition

open var sharedElementEnterTransition: @Nullable Any?

sharedElementReturnTransition

open var sharedElementReturnTransition: @Nullable Any?

tag

val tag: @Nullable String?

targetFragment

val targetFragment: @Nullable Fragment?

targetRequestCode

val targetRequestCode: Int

userVisibleHint

open var userVisibleHint: Boolean

view

open val view: @Nullable View?

viewDataBinding

var viewDataBinding: VDB?

viewLifecycleOwner

@get:MainThread

open val viewLifecycleOwner: @NonNull LifecycleOwner

viewLifecycleOwnerLiveData

open val viewLifecycleOwnerLiveData: @NonNull LiveData<LifecycleOwner?>

viewModel

lateinit var viewModel: VM

viewModelStore

open val viewModelStore: @NonNull ViewModelStore

Functions

addOnContextAvailableListener

open fun addOnContextAvailableListener(listener: @NonNull OnContextAvailableListener)

createRootView

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

创建 rootView

createViewModel

open override fun createViewModel(): VM

创建ViewModel

dismissDialog

open override fun dismissDialog()

open override fun dismissDialog(dialog: Dialog?)

关闭对话框

dismissProgressDialog

open override fun dismissProgressDialog()

关闭进度对话框

dump

open fun dump(prefix: @NonNull String, fd: @Nullable FileDescriptor?, writer: @NonNull PrintWriter, args: @Nullable Array<out String?>??)

findViewById

fun <T : View> findViewById(@IdRes id: Int): T?

finish

fun finish()

getLayoutId

@LayoutRes

abstract fun getLayoutId(): Int

获取根布局ID

getString

fun getString(@StringRes resId: Int): @NonNull String

fun getString(@StringRes resId: Int, vararg formatArgs: Any?): @NonNull String

getText

fun getText(@StringRes resId: Int): @NonNull CharSequence

hasOptionsMenu

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

fun hasOptionsMenu(): Boolean

hideLoading

open override fun hideLoading()

隐藏加载中

initData

abstract fun initData(savedInstanceState: Bundle?)

初始化数据

isBinding

open override fun isBinding(): Boolean

是否使用 ViewDataBinding；默认为：true

obtainActivityViewModel

fun <T : ViewModel> obtainActivityViewModel(vmClass: Class<T>): T

获取Activity持有的ViewModel

obtainViewModel

fun <T : ViewModel> obtainViewModel(vmClass: Class<T>): T

获取ViewModel

onActivityCreated

@MainThread

@CallSuper

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

onActivityResult

open fun ~~onActivityResult~~(requestCode: Int, resultCode: Int, data: @Nullable Intent?)

onAttach

@MainThread

@CallSuper

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

@MainThread

@CallSuper

open fun onAttach(context: @NonNull Context)

onAttachFragment

@MainThread

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

onConfigurationChanged

@CallSuper

open fun onConfigurationChanged(newConfig: @NonNull Configuration)

onContextItemSelected

@MainThread

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

onCreate

@MainThread

@CallSuper

open fun onCreate(savedInstanceState: @Nullable Bundle?)

onCreateAnimation

@MainThread

open fun onCreateAnimation(transit: Int, enter: Boolean, nextAnim: Int): @Nullable Animation?

onCreateAnimator

@MainThread

open fun onCreateAnimator(transit: Int, enter: Boolean, nextAnim: Int): @Nullable Animator?

onCreateContextMenu

@MainThread

open fun onCreateContextMenu(menu: @NonNull ContextMenu, v: @NonNull View, menuInfo: @Nullable ContextMenu.ContextMenuInfo?)

onCreateOptionsMenu

@MainThread

open fun ~~onCreateOptionsMenu~~(menu: @NonNull Menu, inflater: @NonNull MenuInflater)

onCreateView

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

onDestroy

open override fun onDestroy()

onDestroyOptionsMenu

@MainThread

open fun ~~onDestroyOptionsMenu~~()

onDestroyView

@MainThread

@CallSuper

open fun onDestroyView()

open fun onDetach()

open fun onGetLayoutInflater(savedInstanceState: @Nullable Bundle?): @NonNull LayoutInflater

onHiddenChanged

@MainThread

open fun onHiddenChanged(hidden: Boolean)

onInflate

@UiThread

@CallSuper

open fun ~~onInflate~~(activity: @NonNull Activity, attrs: @NonNull AttributeSet, savedInstanceState: @Nullable Bundle?)

@UiThread

@CallSuper

open fun onInflate(context: @NonNull Context, attrs: @NonNull AttributeSet, savedInstanceState: @Nullable Bundle?)

onLowMemory

@MainThread

@CallSuper

open fun onLowMemory()

onMultiWindowModeChanged

open fun onMultiWindowModeChanged(isInMultiWindowMode: Boolean)

onOptionsItemSelected

@MainThread

open fun ~~onOptionsItemSelected~~(item: @NonNull MenuItem): Boolean

onOptionsMenuClosed

@MainThread

open fun ~~onOptionsMenuClosed~~(menu: @NonNull Menu)

onPause

@MainThread

@CallSuper

open fun onPause()

onPictureInPictureModeChanged

open fun onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean)

onPrepareOptionsMenu

@MainThread

open fun ~~onPrepareOptionsMenu~~(menu: @NonNull Menu)

onPrimaryNavigationFragmentChanged

@MainThread

open fun onPrimaryNavigationFragmentChanged(isPrimaryNavigationFragment: Boolean)

onRequestPermissionsResult

open fun ~~onRequestPermissionsResult~~(requestCode: Int, permissions: @NonNull Array<out String?>, grantResults: @NonNull IntArray)

open fun onResume()

open fun onSaveInstanceState(outState: @NonNull Bundle)

open fun onStart()

open override fun onStateChanged(source: LifecycleOwner, event: Lifecycle.Event)

open fun onStop()

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

onViewStateRestored

@MainThread

@CallSuper

open fun onViewStateRestored(savedInstanceState: @Nullable Bundle?)

peekAvailableContext

open fun peekAvailableContext(): @Nullable Context?

postponeEnterTransition

open fun postponeEnterTransition()

fun postponeEnterTransition(duration: Long, timeUnit: @NonNull TimeUnit)

registerForActivityResult

@MainThread

fun <I : Any?, O : Any?> registerForActivityResult(contract: @NonNull ActivityResultContract<I?, O?>, callback: @NonNull ActivityResultCallback<O?>): @NonNull ActivityResultLauncher<I?>

@MainThread

fun <I : Any?, O : Any?> registerForActivityResult(contract: @NonNull ActivityResultContract<I?, O?>, registry: @NonNull ActivityResultRegistry, callback: @NonNull ActivityResultCallback<O?>): @NonNull ActivityResultLauncher<I?>

registerForContextMenu

open fun registerForContextMenu(view: @NonNull View)

removeOnContextAvailableListener

open fun removeOnContextAvailableListener(listener: @NonNull OnContextAvailableListener)

requestPermissions

fun ~~requestPermissions~~(permissions: @NonNull Array<out String?>, requestCode: Int)

requireActivity

fun requireActivity(): @NonNull FragmentActivity

requireArguments

fun requireArguments(): @NonNull Bundle

requireContext

fun requireContext(): @NonNull Context

requireFragmentManager

fun ~~requireFragmentManager~~(): @NonNull FragmentManager

requireHost

fun requireHost(): @NonNull Any

requireParentFragment

fun requireParentFragment(): @NonNull Fragment

requireView

fun requireView(): @NonNull View

setEnterSharedElementCallback

open fun setEnterSharedElementCallback(callback: @Nullable SharedElementCallback?)

setExitSharedElementCallback

open fun setExitSharedElementCallback(callback: @Nullable SharedElementCallback?)

setHasOptionsMenu

open fun ~~setHasOptionsMenu~~(hasMenu: Boolean)

setInitialSavedState

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

setMenuVisibility

open fun setMenuVisibility(menuVisible: Boolean)

setTargetFragment

open fun ~~setTargetFragment~~(fragment: @Nullable Fragment?, requestCode: Int)

setWindow

open override fun setWindow(window: Window?, gravity: Int = Gravity.NO_GRAVITY, widthRatio: Float = 0.85f, x: Int = 0, y: Int = 0, horizontalMargin: Float = 0.0f, verticalMargin: Float = 0.0f, horizontalWeight: Float = 0.0f, verticalWeight: Float = 0.0f)

设置 Window 布局相关参数

shouldShowRequestPermissionRationale

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

showDialog

open override fun showDialog(contentView: View, styleId: Int = R.style.mvvmframe_dialog, gravity: Int = Gravity.NO_GRAVITY, widthRatio: Float = 0.85f, x: Int = 0, y: Int = 0, horizontalMargin: Float = 0.0f, verticalMargin: Float = 0.0f, horizontalWeight: Float = 0.0f, verticalWeight: Float = 0.0f, backCancel: Boolean = true)

显示对话框

showLoading

open override fun showLoading()

显示加载中

showProgressDialog

open override fun showProgressDialog(layoutId: Int = R.layout.mvvmframe_progress_dialog, cancel: Boolean = false)

显示进度对话框

showToast

open override fun showToast(text: CharSequence)

open override fun showToast(resId: Int)

通过Toast显示提示信息

startActivity

open fun startActivity(intent: @NonNull Intent)

open fun startActivity(intent: @NonNull Intent, options: @Nullable Bundle?)

startActivityForResult

open fun ~~startActivityForResult~~(intent: @NonNull Intent, requestCode: Int)

open override fun ~~startActivityForResult~~(intent: Intent, requestCode: Int, options: Bundle?)

startIntentSenderForResult

open fun ~~startIntentSenderForResult~~(intent: @NonNull IntentSender, requestCode: Int, fillInIntent: @Nullable Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int, options: @Nullable Bundle?)

startPostponedEnterTransition

open fun startPostponedEnterTransition()

unregisterForContextMenu

open fun unregisterForContextMenu(view: @NonNull View)