public interface

PropertyInspectorCoordinatorLayoutController

com.pspdfkit.ui.inspector.PropertyInspectorCoordinatorLayoutController
Known Indirect Subclasses

Class Overview

An interface to be implemented by PropertyInspectorCoordinatorLayout through which other components can control the property inspector coordinator layout.

Summary

Nested Classes
interface PropertyInspectorCoordinatorLayoutController.PropertyInspectorLifecycleListener Listener for the lifecycle of the PropertyInspector as it goes through the PropertyInspectorCoordinatorLayout. 
Public Methods
abstract void addPropertyInspectorLifecycleListener(PropertyInspectorCoordinatorLayoutController.PropertyInspectorLifecycleListener lifecycleListener)
Adds the listener for lifecycle changes of the PropertyInspector as it goes through the PropertyInspectorCoordinatorLayout - preparing, displaying, removing.
abstract boolean hideInspector(boolean animate)
Removes active inspector if visible.
abstract boolean isInspectorVisible(PropertyInspector inspector)
Tests if inspector is currently active in coordinator.
abstract boolean isInspectorVisible()
Tests if coordinator has any active inspector currently visible.
abstract void removePropertyInspectorLifecycleListener(PropertyInspectorCoordinatorLayoutController.PropertyInspectorLifecycleListener lifecycleListener)
Removes previously registered listener for lifecycle changes of the PropertyInspector as it goes through the PropertyInspectorCoordinatorLayout - preparing, displaying, removing.
abstract void setBottomInset(int bottomInset)
Sets bottom inset for displayed PropertyInspectors.
abstract boolean showInspector(PropertyInspector propertyInspector, boolean animate)
Displays property inspector.

Public Methods

public abstract void addPropertyInspectorLifecycleListener (PropertyInspectorCoordinatorLayoutController.PropertyInspectorLifecycleListener lifecycleListener)

Adds the listener for lifecycle changes of the PropertyInspector as it goes through the PropertyInspectorCoordinatorLayout - preparing, displaying, removing. If the listener has already been added previously, this method will be a no-op. Adding null is not allowed, and will result in an exception.

Parameters
lifecycleListener PropertyInspectorCoordinatorLayoutController.PropertyInspectorLifecycleListener that should be notified. Must be non-null.
See Also

public abstract boolean hideInspector (boolean animate)

Removes active inspector if visible.

Parameters
animate Whether to animate the change.
Returns
  • True if inspector was visible and is now hidden, false if it was already hidden.

public abstract boolean isInspectorVisible (PropertyInspector inspector)

Tests if inspector is currently active in coordinator.

Parameters
inspector Inspector instance.
Returns
  • True if inspector is currently active in coordinator layout.

public abstract boolean isInspectorVisible ()

Tests if coordinator has any active inspector currently visible.

Returns
  • True if there is inspector visible.

public abstract void removePropertyInspectorLifecycleListener (PropertyInspectorCoordinatorLayoutController.PropertyInspectorLifecycleListener lifecycleListener)

Removes previously registered listener for lifecycle changes of the PropertyInspector as it goes through the PropertyInspectorCoordinatorLayout - preparing, displaying, removing. Upon calling this method the listener will no longer be notified of any changes. If the listener has not been added, this method will be a no-op. Adding null is not allowed,and will result in an exception.

Parameters
lifecycleListener PropertyInspectorCoordinatorLayoutController.PropertyInspectorLifecycleListener that should be removed. Must be non-null.
See Also

public abstract void setBottomInset (int bottomInset)

Sets bottom inset for displayed PropertyInspectors. This will be added on top of standard immersive mode insets.

public abstract boolean showInspector (PropertyInspector propertyInspector, boolean animate)

Displays property inspector. This replaces previous displayed inspector.

Parameters
propertyInspector Inspector instance to show.
animate Whether to animate the change.
Returns
  • True if inspector was hidden and is now visible, false if it was already visible.