1 /* 2 * Copyright (c) 2023 Huawei Device Co., Ltd. 3 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software 10 * distributed under the License is distributed on an "AS IS" BASIS, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 * See the License for the specific language governing permissions and 13 * limitations under the License. 14 */ 15 16 #ifndef FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERNS_SCROLLABLE_SCROLLABLE_UTILS_H 17 #define FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERNS_SCROLLABLE_SCROLLABLE_UTILS_H 18 19 #include "base/geometry/axis.h" 20 #include "core/components_ng/layout/layout_property.h" 21 22 namespace OHOS::Ace::NG { 23 class LayoutWrapper; 24 25 struct MoveOffsetParam { 26 bool isVertical = false; 27 float contentStartOffset = 0; 28 float contentEndOffset = 0; 29 bool noNeedMargin = false; 30 }; 31 32 struct ScrollableUtils { 33 /** 34 * @brief Disable lazyForEach prebuild cache item. 35 * 36 * @param node The host node. 37 */ 38 static void DisableLazyForEachBuildCache(const RefPtr<UINode>& node); 39 40 /** 41 * @brief Checks if contentHeight needs to expand based on safeArea property. 42 * 43 * @param layoutProps The layout properties to check. 44 * @param axis The scrollable axis. 45 * @return The height expansion amount. 46 */ 47 static float CheckHeightExpansion(const RefPtr<LayoutProperty>& layoutProps, Axis axis); 48 49 /** 50 * @brief Recycle items which are out of boundary. 51 * 52 * @param axis scroll direction 53 * @param offset scroll offset, positive means scroll down, negative means scroll up. 54 * @param start first item index 55 * @param end last item index 56 * @param wrapper layout wrapper 57 */ 58 static void RecycleItemsOutOfBoundary(Axis axis, float offset, int32_t start, int32_t end, LayoutWrapper* wrapper); 59 60 /** 61 * @brief get moveoffset from parentFrameNode when curFrameNode focused. 62 * 63 * @param parentFrameNode parent framenode with scroll function 64 * @param curFrameNode current focused framenode 65 * @param isVertical vertical or not 66 * @param contentStartOffset content start offset from parentFrameNode 67 * @param contentEndOffset content end offset from parentFrameNode 68 */ 69 static float GetMoveOffset( 70 const RefPtr<FrameNode>& parentFrameNode, 71 const RefPtr<FrameNode>& curFrameNode, 72 const MoveOffsetParam& param); 73 }; 74 } // namespace OHOS::Ace::NG 75 76 #endif // FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERNS_SCROLLABLE_SCROLLABLE_UTILS_H 77