|
| 1 | +/* |
| 2 | + * Copyright (c) Meta Platforms, Inc. and affiliates. |
| 3 | + * |
| 4 | + * This source code is licensed under the MIT license found in the |
| 5 | + * LICENSE file in the root directory of this source tree. |
| 6 | + */ |
| 7 | + |
| 8 | +package com.facebook.react.uimanager; |
| 9 | + |
| 10 | +import android.graphics.Rect; |
| 11 | +import android.view.View; |
| 12 | + |
| 13 | +/** |
| 14 | + * Interface that should be implemented by {@link View} subclasses that support {@code |
| 15 | + * removeClippedSubviews} property. When this property is set for the {@link ViewGroup} subclass |
| 16 | + * it's responsible for detaching it's child views that are clipped by the view boundaries. Those |
| 17 | + * view boundaries should be determined based on it's parent clipping area and current view's offset |
| 18 | + * in parent and doesn't necessarily reflect the view visible area (in a sense of a value that |
| 19 | + * {@link View#getGlobalVisibleRect} may return). In order to determine the clipping rect for |
| 20 | + * current view helper method {@link ReactClippingViewGroupHelper#calculateClippingRect} can be used |
| 21 | + * that takes into account parent view settings. |
| 22 | + */ |
| 23 | +public interface ReactClippingViewGroup { |
| 24 | + |
| 25 | + /** |
| 26 | + * Notify view that clipping area may have changed and it should recalculate the list of children |
| 27 | + * that should be attached/detached. This method should be called only when property {@code |
| 28 | + * removeClippedSubviews} is set to {@code true} on a view. |
| 29 | + * |
| 30 | + * <p>CAUTION: Views are responsible for calling {@link #updateClippingRect} on it's children. |
| 31 | + * This should happen if child implement {@link ReactClippingViewGroup}, return true from {@link |
| 32 | + * #getRemoveClippedSubviews} and clipping rect change of the current view may affect clipping |
| 33 | + * rect of this child. |
| 34 | + */ |
| 35 | + void updateClippingRect(); |
| 36 | + |
| 37 | + /** |
| 38 | + * Get rectangular bounds to which view is currently clipped to. Called only on views that has set |
| 39 | + * {@code removeCLippedSubviews} property value to {@code true}. |
| 40 | + * |
| 41 | + * @param outClippingRect output clipping rect should be written to this object. |
| 42 | + */ |
| 43 | + void getClippingRect(Rect outClippingRect); |
| 44 | + |
| 45 | + /** |
| 46 | + * Sets property {@code removeClippedSubviews} as a result of property update in JS. Should be |
| 47 | + * called only from @{link ViewManager#updateView} method. |
| 48 | + * |
| 49 | + * <p>Helper method {@link ReactClippingViewGroupHelper#applyRemoveClippedSubviewsProperty} may be |
| 50 | + * used by {@link ViewManager} subclass to apply this property based on property update map {@link |
| 51 | + * ReactStylesDiffMap}. |
| 52 | + */ |
| 53 | + void setRemoveClippedSubviews(boolean removeClippedSubviews); |
| 54 | + |
| 55 | + /** Get the current value of {@code removeClippedSubviews} property. */ |
| 56 | + boolean getRemoveClippedSubviews(); |
| 57 | +} |
0 commit comments