• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2022 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_NAVIGATION_NAVIGATION_LAYOUT_PROPERTY_H
17 #define FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERN_NAVIGATION_NAVIGATION_LAYOUT_PROPERTY_H
18 
19 #include "base/geometry/dimension.h"
20 #include "base/utils/macros.h"
21 #include "core/components/common/layout/constants.h"
22 #include "core/components_ng/layout/layout_property.h"
23 #include "core/components_ng/pattern/navigation/navigation_declaration.h"
24 #include "core/components_ng/property/property.h"
25 #include "core/image/image_source_info.h"
26 
27 namespace OHOS::Ace::NG {
28 
29 constexpr Dimension DEFAULT_NAV_BAR_WIDTH = 240.0_vp;
30 
31 class ACE_EXPORT NavigationLayoutProperty : public LayoutProperty {
32     DECLARE_ACE_TYPE(NavigationLayoutProperty, LayoutProperty);
33 
34 public:
35     NavigationLayoutProperty() = default;
36 
37     ~NavigationLayoutProperty() override = default;
38 
Clone()39     RefPtr<LayoutProperty> Clone() const override
40     {
41         auto copy = MakeRefPtr<NavigationLayoutProperty>();
42         copy->LayoutProperty::UpdateLayoutProperty(DynamicCast<LayoutProperty>(this));
43         copy->propNavigationMode_ = CloneNavigationMode();
44         copy->propUsrNavigationMode_ = CloneUsrNavigationMode();
45         copy->propNavBarWidth_ = CloneNavBarWidth();
46         copy->propMinNavBarWidth_ = CloneMinNavBarWidth();
47         copy->propMaxNavBarWidth_ = CloneMaxNavBarWidth();
48         copy->propMinContentWidth_ = CloneMinContentWidth();
49         copy->propNavBarPosition_ = CloneNavBarPosition();
50         copy->propHideNavBar_ = CloneHideNavBar();
51         copy->propNoPixMap_ = CloneNoPixMap();
52         copy->propImageSource_ = CloneImageSource();
53         copy->propPixelMap_ = ClonePixelMap();
54         return copy;
55     }
56 
Reset()57     void Reset() override
58     {
59         LayoutProperty::Reset();
60         ResetNavigationMode();
61         ResetUsrNavigationMode();
62         ResetNavBarWidth();
63         ResetMinNavBarWidth();
64         ResetMaxNavBarWidth();
65         ResetMinContentWidth();
66         ResetNavBarPosition();
67         ResetHideNavBar();
68         ResetNoPixMap();
69         ResetImageSource();
70         ResetPixelMap();
71     }
72 
ToJsonValue(std::unique_ptr<JsonValue> & json)73     void ToJsonValue(std::unique_ptr<JsonValue>& json) const override
74     {
75         LayoutProperty::ToJsonValue(json);
76         std::string navBarWidthRange = GetMinNavBarWidthValue(DEFAULT_MIN_NAV_BAR_WIDTH).ToString() + ", " +
77                                        GetMaxNavBarWidthValue(DEFAULT_MAX_NAV_BAR_WIDTH).ToString();
78         json->Put("navBarWidth", GetNavBarWidthValue(DEFAULT_NAV_BAR_WIDTH).ToString().c_str());
79         json->Put("navBarWidthRange", navBarWidthRange.c_str());
80         json->Put("minContentWidth", GetMinContentWidthValue(DEFAULT_MIN_CONTENT_WIDTH).ToString().c_str());
81         json->Put("navBarPosition", GetNavBarPosition().value_or(NavBarPosition::START) == NavBarPosition::START
82                                         ? "NavBarPosition.Start"
83                                         : "NavBarPosition.End");
84         static const std::array<std::string, 3> NAVIGATION_MODE_TO_STRING = {
85             "NavigationMode.STACK",
86             "NavigationMode.SPLIT",
87             "NavigationMode.AUTO",
88         };
89         json->Put("mode",
90             NAVIGATION_MODE_TO_STRING.at(static_cast<int32_t>(GetUsrNavigationMode().value_or(NavigationMode::AUTO)))
91                 .c_str());
92         json->Put("hideNavBar", GetHideNavBarValue(false));
93         if (HasImageSource()) {
94             json->Put("backButtonIcon", GetImageSourceValue().GetSrc().c_str());
95         }
96     }
97 
98     ACE_DEFINE_PROPERTY_ITEM_WITHOUT_GROUP(NavigationMode, NavigationMode, PROPERTY_UPDATE_MEASURE);
99     ACE_DEFINE_PROPERTY_ITEM_WITHOUT_GROUP(UsrNavigationMode, NavigationMode, PROPERTY_UPDATE_MEASURE);
100     ACE_DEFINE_PROPERTY_ITEM_WITHOUT_GROUP(NavBarWidth, Dimension, PROPERTY_UPDATE_MEASURE);
101     ACE_DEFINE_PROPERTY_ITEM_WITHOUT_GROUP(MinNavBarWidth, Dimension, PROPERTY_UPDATE_MEASURE);
102     ACE_DEFINE_PROPERTY_ITEM_WITHOUT_GROUP(MaxNavBarWidth, Dimension, PROPERTY_UPDATE_MEASURE);
103     ACE_DEFINE_PROPERTY_ITEM_WITHOUT_GROUP(MinContentWidth, Dimension, PROPERTY_UPDATE_MEASURE);
104     ACE_DEFINE_PROPERTY_ITEM_WITHOUT_GROUP(NavBarPosition, NavBarPosition, PROPERTY_UPDATE_MEASURE);
105     ACE_DEFINE_PROPERTY_ITEM_WITHOUT_GROUP(HideNavBar, bool, PROPERTY_UPDATE_MEASURE);
106     // back button icon
107     ACE_DEFINE_PROPERTY_ITEM_WITHOUT_GROUP(NoPixMap, bool, PROPERTY_UPDATE_MEASURE);
108     ACE_DEFINE_PROPERTY_ITEM_WITHOUT_GROUP(ImageSource, ImageSourceInfo, PROPERTY_UPDATE_MEASURE);
109     ACE_DEFINE_PROPERTY_ITEM_WITHOUT_GROUP(PixelMap, RefPtr<PixelMap>, PROPERTY_UPDATE_MEASURE);
110 };
111 
112 } // namespace OHOS::Ace::NG
113 
114 #endif // FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERN_NAVIGATION_NAVIGATION_LAYOUT_PROPERTY_H
115