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 struct ScrollableUtils {
24     /**
25      * @brief Checks if contentHeight needs to expand based on safeArea property.
26      *
27      * @param layoutProps The layout properties to check.
28      * @param axis The scrollable axis.
29      * @return The height expansion amount.
30      */
31     static float CheckHeightExpansion(const RefPtr<LayoutProperty>& layoutProps, Axis axis);
32 
33     /**
34      * @brief Recycle items which are out of boundary.
35      *
36      * @param axis scroll direction
37      * @param offset scroll offset, positive means scroll down, negative means scroll up.
38      * @param start first item index
39      * @param end last item index
40      * @param wrapper layout wrapper
41      */
42     static void RecycleItemsOutOfBoundary(Axis axis, float offset, int32_t start, int32_t end, LayoutWrapper* wrapper);
43 
44     /**
45      * @brief get moveoffset from parentFrameNode when curFrameNode focused.
46      *
47      * @param parentFrameNode parent framenode with scroll function
48      * @param curFrameNode current focused framenode
49      * @param isVertical vertical or not
50      * @param contentStartOffset content start offset from parentFrameNode
51      * @param contentEndOffset content end offset from parentFrameNode
52      */
53     static float GetMoveOffset(
54         const RefPtr<FrameNode>& parentFrameNode,
55         const RefPtr<FrameNode>& curFrameNode,
56         bool isVertical,
57         float contentStartOffset,
58         float contentEndOffset);
59 };
60 } // namespace OHOS::Ace::NG
61 
62 #endif // FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERNS_SCROLLABLE_SCROLLABLE_UTILS_H
63