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_PATTERN_WATERFLOW_WATER_FLOW_MODEL_H
17 #define FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERN_WATERFLOW_WATER_FLOW_MODEL_H
18 
19 #include <mutex>
20 
21 #include "core/components/common/layout/constants.h"
22 #include "core/components/scroll/scroll_controller_base.h"
23 #include "core/components/scroll_bar/scroll_proxy.h"
24 #include "core/components_ng/pattern/scrollable/scrollable_properties.h"
25 #include "core/components_ng/pattern/waterflow/layout/water_flow_layout_algorithm_base.h"
26 #include "core/components_ng/pattern/waterflow/water_flow_sections.h"
27 
28 namespace OHOS::Ace {
29 class WaterFlowModel {
30 public:
31     static WaterFlowModel* GetInstance();
32     virtual ~WaterFlowModel() = default;
33 
34     virtual void Create() = 0;
35     virtual void SetFooter(std::function<void()>&& footer) = 0;
36     virtual RefPtr<ScrollControllerBase> CreateScrollController() = 0;
37     virtual RefPtr<ScrollProxy> CreateScrollBarProxy() = 0;
38     virtual void SetScroller(RefPtr<ScrollControllerBase> scroller, RefPtr<ScrollProxy> proxy) = 0;
39     virtual void SetLayoutMode(NG::WaterFlowLayoutMode mode) = 0;
40 
41     virtual void SetColumnsTemplate(const std::string& value) = 0;
42     virtual void SetRowsTemplate(const std::string& value) = 0;
43 
44     // itemConstraintSize
45     virtual void SetItemMinWidth(const Dimension& minWidth) = 0;
46     virtual void SetItemMinHeight(const Dimension& minHeight) = 0;
47     virtual void SetItemMaxWidth(const Dimension& maxWidth) = 0;
48     virtual void SetItemMaxHeight(const Dimension& maxHeight) = 0;
49 
50     virtual void SetColumnsGap(const Dimension& value) = 0;
51     virtual void SetRowsGap(const Dimension& value) = 0;
52 
53     virtual void SetLayoutDirection(FlexDirection value) = 0;
54     virtual void SetNestedScroll(const NestedScrollOptions& nestedOpt) = 0;
55     virtual void SetScrollEnabled(bool scrollEnabled) = 0;
56 
57     virtual void SetOnReachStart(OnReachEvent&& onReachStart) = 0;
58     virtual void SetOnReachEnd(OnReachEvent&& onReachEnd) = 0;
59     virtual void SetOnScrollFrameBegin(OnScrollFrameBeginEvent&& ScrollFrameBegin) = 0;
60     virtual void SetOnScroll(std::function<void(Dimension, ScrollState)>&& onScroll) = 0;
61     virtual void SetOnScrollStart(std::function<void()>&& onScrollStart) = 0;
62     virtual void SetOnScrollStop(std::function<void()>&& onScrollStop) = 0;
63     virtual void SetOnScrollIndex(std::function<void(int32_t, int32_t)>&& onScrollIndex) = 0;
64 
65     virtual void SetFriction(double friction) = 0;
66     virtual void SetCachedCount(int32_t value, bool show = false) = 0;
67 
68     virtual void SetEdgeEffect(EdgeEffect edgeEffect, bool alwaysEnabled) = 0;
GetEdgeEffect()69     EdgeEffect GetEdgeEffect() const
70     {
71         return EdgeEffect::NONE;
72     }
GetAlwaysEnableEdgeEffect()73     bool GetAlwaysEnableEdgeEffect() const
74     {
75         return false;
76     }
GetDisplayMode()77     static DisplayMode GetDisplayMode()
78     {
79         return DisplayMode::OFF;
80     }
81     virtual void SetScrollBarMode(DisplayMode value) = 0;
82     virtual void SetScrollBarColor(const std::string& value) = 0;
83     virtual void SetScrollBarWidth(const std::string& value) = 0;
GetOrCreateWaterFlowSections()84     virtual RefPtr<NG::WaterFlowSections> GetOrCreateWaterFlowSections()
85     {
86         return nullptr;
87     }
88 
ResetSections()89     virtual void ResetSections() {}
90 
91 private:
92     static std::unique_ptr<WaterFlowModel> instance_;
93     static std::mutex mutex_;
94 };
95 } // namespace OHOS::Ace
96 #endif // FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERN_WATERFLOW_WATER_FLOW_MODEL_H
97