• 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_SCROLL_SCROLL_LAYOUT_PROPERTY_H
17 #define FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERN_SCROLL_SCROLL_LAYOUT_PROPERTY_H
18 
19 #include <memory>
20 #include <unordered_map>
21 
22 #include "base/geometry/axis.h"
23 #include "base/utils/macros.h"
24 #include "core/components/common/layout/constants.h"
25 #include "core/components_ng/layout/layout_property.h"
26 #include "core/components_ng/pattern/scroll/scroll_edge_effect.h"
27 #include "core/components_ng/property/property.h"
28 
29 namespace OHOS::Ace::NG {
30 class ACE_EXPORT ScrollLayoutProperty : public LayoutProperty {
31     DECLARE_ACE_TYPE(ScrollLayoutProperty, LayoutProperty);
32 
33 public:
34     ScrollLayoutProperty() = default;
35 
Clone()36     RefPtr<LayoutProperty> Clone() const override
37     {
38         auto value = MakeRefPtr<ScrollLayoutProperty>();
39         value->LayoutProperty::UpdateLayoutProperty(DynamicCast<LayoutProperty>(this));
40         value->propAxis_ = CloneAxis();
41         value->propScrollEnabled_ = CloneScrollEnabled();
42         value->propScrollSnapAlign_ = CloneScrollSnapAlign();
43         value->propScrollContentEndOffset_ = CloneScrollContentEndOffset();
44         return value;
45     }
46 
Reset()47     void Reset() override
48     {
49         LayoutProperty::Reset();
50         ResetAxis();
51         ResetScrollEnabled();
52         ResetScrollContentEndOffset();
53     }
54 
ToJsonValue(std::unique_ptr<JsonValue> & json)55     void ToJsonValue(std::unique_ptr<JsonValue>& json) const override
56     {
57         LayoutProperty::ToJsonValue(json);
58         std::unordered_map<Axis, std::string> scrollableMap { { Axis::VERTICAL, "ScrollDirection.Vertical" },
59             { Axis::HORIZONTAL, "ScrollDirection.Horizontal" }, { Axis::FREE, "ScrollDirection.Free" },
60             { Axis::NONE, "ScrollDirection.None" } };
61         Axis axis = GetAxisValue(Axis::VERTICAL);
62         json->Put("scrollable", scrollableMap[axis].c_str());
63         json->Put("enableScrollInteraction", propScrollEnabled_.value_or(true));
64         std::unordered_map<ScrollSnapAlign, std::string> scrollSnapAlignMap {
65             { ScrollSnapAlign::NONE, "ScrollSnapAlign.NONE" }, { ScrollSnapAlign::START, "ScrollSnapAlign.START" },
66             { ScrollSnapAlign::CENTER, "ScrollSnapAlign::CENTER" }, { ScrollSnapAlign::END, "ScrollSnapAlign::END" }
67         };
68         ScrollSnapAlign scrollSnapAlign = propScrollSnapAlign_.value_or(ScrollSnapAlign::NONE);
69         json->Put("scrollSnapAlign", scrollSnapAlignMap[scrollSnapAlign].c_str());
70     }
71 
72     ACE_DEFINE_PROPERTY_ITEM_WITHOUT_GROUP(Axis, Axis, PROPERTY_UPDATE_MEASURE);
73     ACE_DEFINE_PROPERTY_ITEM_WITHOUT_GROUP(ScrollEnabled, bool, PROPERTY_UPDATE_MEASURE);
74     ACE_DEFINE_PROPERTY_ITEM_WITHOUT_GROUP(ScrollSnapAlign, ScrollSnapAlign, PROPERTY_UPDATE_MEASURE);
75     ACE_DEFINE_PROPERTY_ITEM_WITHOUT_GROUP(ScrollWidth, float, PROPERTY_UPDATE_MEASURE);
76     ACE_DEFINE_PROPERTY_ITEM_WITHOUT_GROUP(ScrollContentEndOffset, float, PROPERTY_UPDATE_MEASURE);
77 };
78 
79 } // namespace OHOS::Ace::NG
80 
81 #endif // FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERN_SCROLL_SCROLL_LAYOUT_PROPERTY_H
82