Interface PropertyInspectorCoordinatorLayoutController
-
- All Implemented Interfaces:
public interface PropertyInspectorCoordinatorLayoutController
An interface to be implemented by PropertyInspectorCoordinatorLayout through which other components can control the property inspector coordinator layout.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interface
PropertyInspectorCoordinatorLayoutController.PropertyInspectorLifecycleListener
Listener for the lifecycle of the PropertyInspector as it goes through the .
-
Method Summary
Modifier and Type Method Description abstract boolean
showInspector(@NonNull() PropertyInspector propertyInspector, boolean animate)
Displays property inspector. abstract boolean
hideInspector(boolean animate)
Removes active inspector if visible. abstract boolean
isInspectorVisible(@NonNull() PropertyInspector inspector)
Tests if inspector
is currently active in coordinator.abstract boolean
isInspectorVisible()
Tests if coordinator has any active inspector currently visible. abstract void
setBottomInset(int bottomInset)
Sets bottom inset for displayed PropertyInspectors. abstract void
setDrawUnderBottomInset(boolean showInspectorViewsUnderBottomInset)
Controls whether inspector contents are drawn under bottom insets (system or set via setBottomInset. abstract void
addPropertyInspectorLifecycleListener(@NonNull() PropertyInspectorCoordinatorLayoutController.PropertyInspectorLifecycleListener lifecycleListener)
Adds the listener for lifecycle changes of the PropertyInspector as it goes through the PropertyInspectorCoordinatorLayout - preparing, displaying, removing. abstract void
removePropertyInspectorLifecycleListener(@NonNull() PropertyInspectorCoordinatorLayoutController.PropertyInspectorLifecycleListener lifecycleListener)
Removes previously registered listener for lifecycle changes of the PropertyInspector as it goes through the PropertyInspectorCoordinatorLayout - preparing, displaying, removing. -
-
Method Detail
-
showInspector
@UiThread() abstract boolean showInspector(@NonNull() 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.
-
hideInspector
@UiThread() 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.
-
isInspectorVisible
abstract boolean isInspectorVisible(@NonNull() PropertyInspector inspector)
Tests if
inspector
is currently active in coordinator.- Parameters:
inspector
- Inspector instance.- Returns:
True if
inspector
is currently active in coordinator layout.
-
isInspectorVisible
abstract boolean isInspectorVisible()
Tests if coordinator has any active inspector currently visible.
- Returns:
True if there is inspector visible.
-
setBottomInset
abstract void setBottomInset(int bottomInset)
Sets bottom inset for displayed PropertyInspectors. This will be added on top of standard immersive mode insets.
-
setDrawUnderBottomInset
abstract void setDrawUnderBottomInset(boolean showInspectorViewsUnderBottomInset)
Controls whether inspector contents are drawn under bottom insets (system or set via setBottomInset.
- Parameters:
showInspectorViewsUnderBottomInset
-true
when inspector should be visible under bottom insets.
-
addPropertyInspectorLifecycleListener
abstract void addPropertyInspectorLifecycleListener(@NonNull() 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
- PropertyInspectorLifecycleListener that should be notified.
-
removePropertyInspectorLifecycleListener
abstract void removePropertyInspectorLifecycleListener(@NonNull() 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. Addingnull
is not allowed,and will result in an exception.- Parameters:
lifecycleListener
- PropertyInspectorLifecycleListener that should be removed.
-
-
-
-