• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2022-2025 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_TABS_TABS_MODEL_H
17 #define FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERN_TABS_TABS_MODEL_H
18 
19 #include <mutex>
20 
21 #include "base/geometry/axis.h"
22 #include "base/geometry/dimension.h"
23 #include "base/image/pixel_map.h"
24 #include "base/memory/referenced.h"
25 #include "core/components/common/layout/constants.h"
26 #include "core/components/common/properties/decoration.h"
27 #include "core/components/swiper/swiper_controller.h"
28 #include "core/components/tab_bar/tab_controller.h"
29 #include "core/components/tab_bar/tab_theme.h"
30 #include "core/components/tab_bar/tabs_event.h"
31 #include "core/components_ng/pattern/swiper/swiper_model.h"
32 #include "core/components_ng/pattern/tabs/tab_content_transition_proxy.h"
33 #include "core/event/ace_events.h"
34 #include "core/pipeline/pipeline_context.h"
35 #include "ui/view/components/tabs/tabs_data.h"
36 #include "core/common/resource/resource_object.h"
37 
38 namespace OHOS::Ace {
39 
40 enum class TabsCacheMode {
41     CACHE_BOTH_SIDE = 0,
42     CACHE_LATEST_SWITCHED
43 };
44 
45 namespace {
46 enum class TabJsResType {
47     BAR_BACKGROUND_COLOR,
48     BAR_WIDTH,
49     BAR_HEIGHT,
50     BAR_GRID_GUTTER,
51     BAR_GRID_MARGIN,
52     DIVIDER_STROKE_WIDTH,
53     DIVIDER_COLOR,
54     DIVIDER_START_MARGIN,
55     DIVIDER_END_MARGIN,
56     SCROLLABLE_BAR_MARGIN,
57     COLOR,
58     INACTIVE_COLOR,
59     BlurStyle_INACTIVE_COLOR
60 };
61 }
62 
63 struct TabsItemDivider final {
64     Dimension strokeWidth = 0.0_vp;
65     Dimension startMargin = 0.0_vp;
66     Dimension endMargin = 0.0_vp;
67     Color color = Color::BLACK;
68     bool isNull = false;
TabsItemDividerfinal69     TabsItemDivider()
70     {
71         auto pipelineContext = PipelineContext::GetCurrentContextSafelyWithCheck();
72         if (!pipelineContext) {
73             return;
74         }
75         auto tabTheme = pipelineContext->GetTheme<TabTheme>();
76         if (!tabTheme) {
77             return;
78         }
79         color = tabTheme->GetDividerColor();
80     }
81     bool operator==(const TabsItemDivider& itemDivider) const
82     {
83         return (strokeWidth == itemDivider.strokeWidth) && (startMargin == itemDivider.startMargin) &&
84                (endMargin == itemDivider.endMargin) && (color == itemDivider.color) && (isNull == itemDivider.isNull);
85     }
86 };
87 
88 struct BarGridColumnOptions final {
89     int32_t sm = -1;
90     int32_t md = -1;
91     int32_t lg = -1;
92     Dimension gutter = 0.0_vp;
93     Dimension margin = 0.0_vp;
94 
BarGridColumnOptionsfinal95     BarGridColumnOptions()
96     {
97         auto pipelineContext = PipelineContext::GetCurrentContextSafelyWithCheck();
98         if (!pipelineContext) {
99             return;
100         }
101         auto tabTheme = pipelineContext->GetTheme<TabTheme>();
102         if (!tabTheme) {
103             return;
104         }
105         gutter = tabTheme->GetTabBarColumnGutter();
106         margin = tabTheme->GetTabBarColumnMargin();
107     }
108 
109     bool operator==(const BarGridColumnOptions& option) const
110     {
111         return (sm == option.sm) && (md == option.md) && (lg == option.lg) && (margin == option.margin) &&
112                (gutter == option.gutter);
113     }
114 };
115 
116 using TabsCustomAnimationEvent = std::function<TabContentAnimatedTransition(int32_t from, int32_t to)>;
117 
118 class ACE_FORCE_EXPORT TabsModel {
119 public:
120     static TabsModel* GetInstance();
121     virtual ~TabsModel() = default;
122 
123     virtual void Create(BarPosition barPosition, int32_t index, const RefPtr<TabController>& tabController,
124         const RefPtr<SwiperController>& swiperController) = 0;
125     virtual void Pop() = 0;
126     virtual void SetIndex(int32_t index) = 0;
127     virtual void SetTabBarPosition(BarPosition tabBarPosition) = 0;
SetBarBackgroundBlurStyle(const BlurStyleOption & styleOption)128     virtual void SetBarBackgroundBlurStyle(const BlurStyleOption& styleOption) {}
129     virtual void SetTabBarMode(TabBarMode tabBarMode) = 0;
130     virtual void SetTabBarWidth(const Dimension& tabBarWidth) = 0;
131     virtual void SetTabBarHeight(const Dimension& tabBarHeight) = 0;
132     virtual void SetWidthAuto(bool isAuto) = 0;
133     virtual void SetHeightAuto(bool isAuto) = 0;
134     virtual void SetBarAdaptiveHeight(bool barAdaptiveHeight) = 0;
135     virtual void SetNoMinHeightLimit(bool noMinHeightLimit) = 0;
136     virtual void SetIsVertical(bool isVertical) = 0;
137     virtual void SetScrollable(bool scrollable) = 0;
SetAnimationCurve(const RefPtr<Curve> & curve)138     virtual void SetAnimationCurve(const RefPtr<Curve>& curve) {};
139     virtual void SetAnimationDuration(float duration) = 0;
140     virtual void SetOnChange(std::function<void(const BaseEventInfo*)>&& onChange) = 0;
141     virtual void SetOnTabBarClick(std::function<void(const BaseEventInfo*)>&& onTabBarClick) = 0;
SetOnUnselected(std::function<void (const BaseEventInfo *)> && onUnselected)142     virtual void SetOnUnselected(std::function<void(const BaseEventInfo*)>&& onUnselected) {}
SetOnAnimationStart(AnimationStartEvent && onAnimationStart)143     virtual void SetOnAnimationStart(AnimationStartEvent&& onAnimationStart) {}
SetOnAnimationEnd(AnimationEndEvent && onAnimationEnd)144     virtual void SetOnAnimationEnd(AnimationEndEvent&& onAnimationEnd) {}
SetOnGestureSwipe(GestureSwipeEvent && gestureSwipe)145     virtual void SetOnGestureSwipe(GestureSwipeEvent&& gestureSwipe) {}
SetOnSelected(std::function<void (const BaseEventInfo *)> && onSelected)146     virtual void SetOnSelected(std::function<void(const BaseEventInfo*)>&& onSelected) {}
147     virtual void SetDivider(const TabsItemDivider& divider) = 0;
148     virtual void SetDividerColorByUser(bool isByUser) = 0;
149     virtual void SetFadingEdge(bool fadingEdge) = 0;
150     virtual void SetBarOverlap(bool barOverlap) = 0;
151     virtual void SetOnChangeEvent(std::function<void(const BaseEventInfo*)>&& onChangeEvent) = 0;
152     virtual void SetBarBackgroundColor(const Color& backgroundColor) = 0;
153     virtual void SetBarBackgroundColorByUser(bool isByUser) = 0;
154     virtual void SetClipEdge(bool clipEdge) = 0;
155     virtual void SetScrollableBarModeOptions(const ScrollableBarModeOptions& option) = 0;
156     virtual void ResetScrollableBarModeOptions() = 0;
157     virtual void SetBarGridAlign(const BarGridColumnOptions& BarGridColumnOptions) = 0;
SetIsCustomAnimation(bool isCustom)158     virtual void SetIsCustomAnimation(bool isCustom) {}
SetOnCustomAnimation(TabsCustomAnimationEvent && onCustomAnimation)159     virtual void SetOnCustomAnimation(TabsCustomAnimationEvent&& onCustomAnimation) {}
SetOnContentWillChange(std::function<bool (int32_t,int32_t)> && callback)160     virtual void SetOnContentWillChange(std::function<bool(int32_t, int32_t)>&& callback) {}
SetAnimateMode(TabAnimateMode mode)161     virtual void SetAnimateMode(TabAnimateMode mode) {}
SetEdgeEffect(EdgeEffect edgeEffect)162     virtual void SetEdgeEffect(EdgeEffect edgeEffect) {}
SetBarBackgroundEffect(const EffectOption & effectOption)163     virtual void SetBarBackgroundEffect(const EffectOption& effectOption) {}
SetPageFlipMode(int32_t pageFlipMode)164     virtual void SetPageFlipMode(int32_t pageFlipMode) {}
SetBarModifier(std::function<void (WeakPtr<NG::FrameNode>)> && onApply)165     virtual void SetBarModifier(std::function<void(WeakPtr<NG::FrameNode>)>&& onApply) {}
SetCachedMaxCount(std::optional<int32_t> cachedMaxCount,TabsCacheMode cacheMode)166     virtual void SetCachedMaxCount(std::optional<int32_t> cachedMaxCount, TabsCacheMode cacheMode) {}
CreateWithResourceObj(TabJsResType colorType,const RefPtr<ResourceObject> & resObj)167     virtual void CreateWithResourceObj(TabJsResType colorType, const RefPtr<ResourceObject>& resObj) {}
168 
169 private:
170     static std::unique_ptr<TabsModel> instance_;
171     static std::mutex mutex_;
172 };
173 
174 } // namespace OHOS::Ace
175 #endif // FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERN_TABS_TABS_MODEL_H
176