pspdfkit/com.pspdfkit.ui.inspector/PropertyInspector

PropertyInspector

open class PropertyInspector : ViewGroup, BottomSheetContentViewInterface, PropertyInspectorController, View.OnClickListener, PropertyInspectorTitleButtonListener

Top level layout of the generic properties inspector. Contains title and scrollable list of PropertyInspectorView.

Inheritors

Constructors

Link copied to clipboard
constructor(@NonNull context: Context)
Construct inspector layout.

Types

Link copied to clipboard
abstract class ItemDecoration
An ItemDecoration allows the application to add custom drawing to specific inspector views.
Link copied to clipboard
interface OnCancelListener
Listener for inspector cancellation.
Link copied to clipboard
interface OnInspectorTitleButtonClickListener
Listener for the buttons on the property inspector title

Properties

Link copied to clipboard
open val maximumHeight: Int
Link copied to clipboard
open val minimumHeight: Int
Link copied to clipboard
open val suggestedHeight: Int
Height indicating optimal height of the property inspector.

Functions

Link copied to clipboard
@UiThread
open fun addInspectorView(@NonNull inspectorView: PropertyInspectorView)
@UiThread
open fun addInspectorView(@NonNull inspectorView: PropertyInspectorView, @IntRange(from = 0) location: Int)
Add new view to inspector layout.
Link copied to clipboard
Link copied to clipboard
open fun cancel()
Request cancellation of the inspector.
Link copied to clipboard
open fun dispatchKeyEvent(@NonNull event: KeyEvent): Boolean
Custom back key handling to implement navigation from detail view.
Link copied to clipboard
open fun dispatchTouchEvent(event: MotionEvent): Boolean
Handle touches outside edit text so focus is released.
Link copied to clipboard
open fun ensureFullyVisible(@NonNull inspectorView: PropertyInspectorView)
Scrolls to inspector view when its not fully visible in property inspector.
Link copied to clipboard
@UiThread
@NonNull
open fun getInspectorView(@IntRange(from = 0) location: Int): PropertyInspectorView
Retrieve PropertyInspectorView at specified location.
Link copied to clipboard
@UiThread
open fun getInspectorViewCount(): Int
Returns the number of PropertyInspectorViews inside inspector.
Link copied to clipboard
@Nullable
open fun getVisibleDetailView(): View
Retrieve detail view that is currently visible in the property inspector.
Link copied to clipboard
open fun hideDetailView(animate: Boolean)
Hide view shown in showDetailView.
Link copied to clipboard
@IntRange(from = "-1")
open fun indexOfInspectorView(@NonNull inspectorView: PropertyInspectorView): Int
Find index of specified inspector view.
Link copied to clipboard
open fun isCancelOnTouchOutside(): Boolean
Returns True when the inspector should be cancelled when touched outside of its bounds.
Link copied to clipboard
open fun onBackButtonClicked(): Boolean
Handles the back-button click on the inspector title.
Link copied to clipboard
open fun onClick(view: View)
Link copied to clipboard
open fun onCloseButtonClicked(): Boolean
Handles the close-button click on the inspectore title.
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@UiThread
open fun removeAllInspectorViews()
Removes all inspector views from inspector.
Link copied to clipboard
@UiThread
open fun removeAllItemDecorations()
Removes all ItemDecorations from this inspector.
Link copied to clipboard
@UiThread
open fun removeInspectorView(@NonNull inspectorView: PropertyInspectorView)
Removes inspector view from inspector.
Link copied to clipboard
@UiThread
open fun removeItemDecoration(@NonNull decoration: PropertyInspector.ItemDecoration)
Removes an ItemDecoration from this inspector.
Link copied to clipboard
open fun reset()
Resets inspector to its initial state.
Link copied to clipboard
open fun setCancelListener(@Nullable cancelListener: PropertyInspector.OnCancelListener)
Sets a listener to be notified of a cancellation.
Link copied to clipboard
open fun setCancelOnTouchOutside(cancelOnTouchOutside: Boolean)
Make inspector request PropertyInspectorCoordinatorLayout to be cancelled when touched outside its bounds.
Link copied to clipboard
open fun setInspectorViews(@NonNull inspectorViews: List<PropertyInspectorView>, animate: Boolean)
Sets list of inspector views to be displayed in property inspector.
open fun setInspectorViews(@NonNull inspectorViews: List<PropertyInspectorView>, animate: Boolean, @Nullable titleButtonListener: PropertyInspectorTitleButtonListener, @Nullable titleStyleProvider: PropertyInspectorViewTitleStyleProvider)
Link copied to clipboard
open fun setTitle(@StringRes titleRes: Int)
open fun setTitle(@NonNull title: String)
Sets header title inside inspector view.
Link copied to clipboard
open fun setTitleBarVisible(isTitleEnabled: Boolean)
Controls inspector title bar visibility.
Link copied to clipboard
open fun showDetailView(@NonNull view: View, @Nullable title: String, animate: Boolean)
Replaces inspector contents with specific view.