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 #include "core/components_ng/pattern/side_bar/side_bar_container_layout_algorithm.h"
17
18 #include "base/geometry/dimension.h"
19 #include "base/geometry/ng/offset_t.h"
20 #include "core/components/common/layout/constants.h"
21 #include "core/components_ng/base/frame_node.h"
22 #include "core/components_ng/property/calc_length.h"
23 #include "core/components_ng/property/measure_utils.h"
24
25 namespace OHOS::Ace::NG {
26
27 namespace {
28 constexpr int32_t DEFAULT_MIN_CHILDREN_SIZE = 3;
29 constexpr Dimension DEFAULT_CONTROL_BUTTON_WIDTH = 32.0_vp;
30 constexpr Dimension DEFAULT_CONTROL_BUTTON_HEIGHT = 32.0_vp;
31 constexpr Dimension DEFAULT_CONTROL_BUTTON_LEFT = 16.0_vp;
32 constexpr Dimension DEFAULT_CONTROL_BUTTON_TOP = 48.0_vp;
33 constexpr Dimension DEFAULT_SIDE_BAR_WIDTH = 200.0_vp;
34 constexpr Dimension DEFAULT_MIN_SIDE_BAR_WIDTH = 200.0_vp;
35 constexpr Dimension DEFAULT_MAX_SIDE_BAR_WIDTH = 280.0_vp;
36 } // namespace
37
Measure(LayoutWrapper * layoutWrapper)38 void SideBarContainerLayoutAlgorithm::Measure(LayoutWrapper* layoutWrapper)
39 {
40 const auto& children = layoutWrapper->GetAllChildrenWithBuild();
41 if (children.empty() || children.size() < DEFAULT_MIN_CHILDREN_SIZE) {
42 LOGE("SideBarContainerLayoutAlgorithm::Measure, children is empty or less than 3.");
43 return;
44 }
45
46 auto layoutProperty = AceType::DynamicCast<SideBarContainerLayoutProperty>(layoutWrapper->GetLayoutProperty());
47 CHECK_NULL_VOID(layoutProperty);
48
49 auto constraint = layoutProperty->GetLayoutConstraint();
50 auto idealSize = CreateIdealSize(
51 constraint.value(), Axis::HORIZONTAL, layoutProperty->GetMeasureType(MeasureType::MATCH_PARENT), true);
52 layoutWrapper->GetGeometryNode()->SetFrameSize(idealSize);
53
54 auto parentWidth = idealSize.Width();
55 if (needInitRealSideBarWidth_) {
56 InitRealSideBarWidth(layoutWrapper, parentWidth);
57 }
58
59 auto begin = children.begin();
60 auto sideBarLayoutWrapper = *(++begin);
61 MeasureSideBar(layoutProperty, sideBarLayoutWrapper);
62
63 auto contentLayoutWrapper = children.front();
64 MeasureSideBarContent(layoutProperty, contentLayoutWrapper, parentWidth);
65
66 auto imgLayoutWrapper = children.back();
67 MeasureControlButton(layoutProperty, imgLayoutWrapper, parentWidth);
68 }
69
InitRealSideBarWidth(LayoutWrapper * layoutWrapper,float parentWidth)70 void SideBarContainerLayoutAlgorithm::InitRealSideBarWidth(LayoutWrapper* layoutWrapper, float parentWidth)
71 {
72 auto layoutProperty = AceType::DynamicCast<SideBarContainerLayoutProperty>(layoutWrapper->GetLayoutProperty());
73 CHECK_NULL_VOID(layoutProperty);
74
75 auto constraint = layoutProperty->GetLayoutConstraint();
76 auto scaleProperty = constraint->scaleProperty;
77 auto sideBarWidth = layoutProperty->GetSideBarWidth().value_or(DEFAULT_SIDE_BAR_WIDTH);
78 auto minSideBarWidth = layoutProperty->GetMinSideBarWidth().value_or(DEFAULT_MIN_SIDE_BAR_WIDTH);
79 auto maxSideBarWidth = layoutProperty->GetMaxSideBarWidth().value_or(DEFAULT_MAX_SIDE_BAR_WIDTH);
80
81 auto sideBarWidthPx = ConvertToPx(sideBarWidth, scaleProperty, parentWidth).value_or(0);
82 auto minSideBarWidthPx = ConvertToPx(minSideBarWidth, scaleProperty, parentWidth).value_or(0);
83 auto maxSideBarWidthPx = ConvertToPx(maxSideBarWidth, scaleProperty, parentWidth).value_or(0);
84 if (minSideBarWidthPx > maxSideBarWidthPx) {
85 minSideBarWidthPx = ConvertToPx(DEFAULT_MIN_SIDE_BAR_WIDTH, scaleProperty, parentWidth).value_or(0);
86 maxSideBarWidthPx = ConvertToPx(DEFAULT_MAX_SIDE_BAR_WIDTH, scaleProperty, parentWidth).value_or(0);
87 }
88
89 if (sideBarWidthPx <= minSideBarWidthPx) {
90 realSideBarWidth_ = minSideBarWidthPx;
91 } else if (sideBarWidthPx >= maxSideBarWidthPx) {
92 realSideBarWidth_ = maxSideBarWidthPx;
93 } else {
94 realSideBarWidth_ = sideBarWidthPx;
95 }
96 }
97
MeasureSideBar(const RefPtr<SideBarContainerLayoutProperty> & layoutProperty,const RefPtr<LayoutWrapper> & sideBarLayoutWrapper)98 void SideBarContainerLayoutAlgorithm::MeasureSideBar(
99 const RefPtr<SideBarContainerLayoutProperty>& layoutProperty, const RefPtr<LayoutWrapper>& sideBarLayoutWrapper)
100 {
101 auto constraint = layoutProperty->GetLayoutConstraint();
102 auto sideBarIdealSize = CreateIdealSize(
103 constraint.value(), Axis::HORIZONTAL, layoutProperty->GetMeasureType(MeasureType::MATCH_PARENT), true);
104 sideBarIdealSize.SetWidth(realSideBarWidth_);
105 auto sideBarConstraint = layoutProperty->CreateChildConstraint();
106 sideBarConstraint.selfIdealSize = OptionalSizeF(sideBarIdealSize);
107
108 realSideBarHeight_ = sideBarIdealSize.Height();
109 sideBarLayoutWrapper->Measure(sideBarConstraint);
110 }
111
MeasureSideBarContent(const RefPtr<SideBarContainerLayoutProperty> & layoutProperty,const RefPtr<LayoutWrapper> & contentLayoutWrapper,float parentWidth)112 void SideBarContainerLayoutAlgorithm::MeasureSideBarContent(
113 const RefPtr<SideBarContainerLayoutProperty>& layoutProperty, const RefPtr<LayoutWrapper>& contentLayoutWrapper,
114 float parentWidth)
115 {
116 auto type = layoutProperty->GetSideBarContainerType().value_or(SideBarContainerType::EMBED);
117 auto sideBarPosition = layoutProperty->GetSideBarPosition().value_or(SideBarPosition::START);
118 auto constraint = layoutProperty->GetLayoutConstraint();
119 auto contentWidth = parentWidth;
120
121 if (type == SideBarContainerType::EMBED) {
122 if (sideBarStatus_ == SideBarStatus::SHOW) {
123 contentWidth -= realSideBarWidth_;
124 } else if (sideBarStatus_ == SideBarStatus::CHANGING) {
125 contentWidth = (sideBarPosition == SideBarPosition::START)
126 ? (parentWidth - realSideBarWidth_ - currentOffset_)
127 : (parentWidth + currentOffset_);
128 }
129 }
130
131 auto contentIdealSize = CreateIdealSize(
132 constraint.value(), Axis::HORIZONTAL, layoutProperty->GetMeasureType(MeasureType::MATCH_PARENT), true);
133 contentIdealSize.SetWidth(contentWidth);
134 auto contentConstraint = layoutProperty->CreateChildConstraint();
135 contentConstraint.selfIdealSize = OptionalSizeF(contentIdealSize);
136 contentLayoutWrapper->Measure(contentConstraint);
137 }
138
MeasureControlButton(const RefPtr<SideBarContainerLayoutProperty> & layoutProperty,const RefPtr<LayoutWrapper> & buttonLayoutWrapper,float parentWidth)139 void SideBarContainerLayoutAlgorithm::MeasureControlButton(const RefPtr<SideBarContainerLayoutProperty>& layoutProperty,
140 const RefPtr<LayoutWrapper>& buttonLayoutWrapper, float parentWidth)
141 {
142 auto constraint = layoutProperty->GetLayoutConstraint();
143 auto scaleProperty = constraint->scaleProperty;
144
145 auto controlButtonWidth = layoutProperty->GetControlButtonWidth().value_or(DEFAULT_CONTROL_BUTTON_WIDTH);
146 auto controlButtonHeight = layoutProperty->GetControlButtonHeight().value_or(DEFAULT_CONTROL_BUTTON_HEIGHT);
147 auto controlButtonWidthPx = ConvertToPx(controlButtonWidth, scaleProperty, parentWidth).value_or(0);
148 auto controlButtonHeightPx = ConvertToPx(controlButtonHeight, scaleProperty, parentWidth).value_or(0);
149
150 auto controlButtonLayoutConstraint = layoutProperty->CreateChildConstraint();
151 controlButtonLayoutConstraint.selfIdealSize.SetWidth(controlButtonWidthPx);
152 controlButtonLayoutConstraint.selfIdealSize.SetHeight(controlButtonHeightPx);
153 buttonLayoutWrapper->Measure(controlButtonLayoutConstraint);
154 }
155
Layout(LayoutWrapper * layoutWrapper)156 void SideBarContainerLayoutAlgorithm::Layout(LayoutWrapper* layoutWrapper)
157 {
158 const auto& children = layoutWrapper->GetAllChildrenWithBuild();
159 if (children.empty() || children.size() < DEFAULT_MIN_CHILDREN_SIZE) {
160 LOGE("SideBarContainerLayoutAlgorithm::Measure, children is empty or less than 3.");
161 return;
162 }
163
164 auto controlButtonLayoutWrapper = children.back();
165 auto begin = children.begin();
166 auto sideBarLayoutWrapper = *(++begin);
167 auto contentLayoutWrapper = children.front();
168
169 LayoutControlButton(layoutWrapper, controlButtonLayoutWrapper);
170 LayoutSideBar(layoutWrapper, sideBarLayoutWrapper);
171 LayoutSideBarContent(layoutWrapper, contentLayoutWrapper);
172 }
173
LayoutControlButton(LayoutWrapper * layoutWrapper,const RefPtr<LayoutWrapper> & buttonLayoutWrapper)174 void SideBarContainerLayoutAlgorithm::LayoutControlButton(
175 LayoutWrapper* layoutWrapper, const RefPtr<LayoutWrapper>& buttonLayoutWrapper)
176 {
177 auto layoutProperty = AceType::DynamicCast<SideBarContainerLayoutProperty>(layoutWrapper->GetLayoutProperty());
178 CHECK_NULL_VOID(layoutProperty);
179
180 CHECK_NULL_VOID (layoutWrapper->GetGeometryNode());
181 auto parentWidth = layoutWrapper->GetGeometryNode()->GetFrameSize().Width();
182 auto constraint = layoutProperty->GetLayoutConstraint();
183 auto scaleProperty = constraint->scaleProperty;
184
185 auto controlButtonLeft = layoutProperty->GetControlButtonLeft().value_or(DEFAULT_CONTROL_BUTTON_LEFT);
186 auto controlButtonTop = layoutProperty->GetControlButtonTop().value_or(DEFAULT_CONTROL_BUTTON_TOP);
187 if (LessNotEqual(controlButtonLeft.Value(), 0.0)) {
188 controlButtonLeft = DEFAULT_CONTROL_BUTTON_LEFT;
189 }
190
191 if (LessNotEqual(controlButtonTop.Value(), 0.0)) {
192 controlButtonTop = DEFAULT_CONTROL_BUTTON_TOP;
193 }
194
195 auto controlButtonLeftPx = ConvertToPx(controlButtonLeft, scaleProperty, parentWidth).value_or(0);
196 auto controlButtonTopPx = ConvertToPx(controlButtonTop, scaleProperty, parentWidth).value_or(0);
197
198 auto imgOffset = OffsetF(controlButtonLeftPx, controlButtonTopPx);
199 buttonLayoutWrapper->GetGeometryNode()->SetMarginFrameOffset(imgOffset);
200 buttonLayoutWrapper->Layout();
201 }
202
LayoutSideBar(LayoutWrapper * layoutWrapper,const RefPtr<LayoutWrapper> & sideBarLayoutWrapper)203 void SideBarContainerLayoutAlgorithm::LayoutSideBar(
204 LayoutWrapper* layoutWrapper, const RefPtr<LayoutWrapper>& sideBarLayoutWrapper)
205 {
206 auto layoutProperty = AceType::DynamicCast<SideBarContainerLayoutProperty>(layoutWrapper->GetLayoutProperty());
207 CHECK_NULL_VOID(layoutProperty);
208
209 CHECK_NULL_VOID (layoutWrapper->GetGeometryNode());
210 auto parentWidth = layoutWrapper->GetGeometryNode()->GetFrameSize().Width();
211 auto sideBarPosition = layoutProperty->GetSideBarPosition().value_or(SideBarPosition::START);
212 float sideBarOffsetX = 0.0f;
213
214 switch (sideBarStatus_) {
215 case SideBarStatus::SHOW:
216 if (sideBarPosition == SideBarPosition::END) {
217 sideBarOffsetX = parentWidth - realSideBarWidth_;
218 }
219 break;
220 case SideBarStatus::HIDDEN:
221 if (sideBarPosition == SideBarPosition::START) {
222 sideBarOffsetX = -realSideBarWidth_;
223 } else {
224 sideBarOffsetX = parentWidth;
225 }
226 break;
227 case SideBarStatus::CHANGING:
228 if (sideBarPosition == SideBarPosition::START) {
229 sideBarOffsetX = currentOffset_;
230 } else {
231 sideBarOffsetX = parentWidth + currentOffset_;
232 }
233 break;
234 default:
235 break;
236 }
237
238 sideBarOffset_ = OffsetF(sideBarOffsetX, 0.0f);
239 sideBarLayoutWrapper->GetGeometryNode()->SetMarginFrameOffset(sideBarOffset_);
240 sideBarLayoutWrapper->Layout();
241 }
242
LayoutSideBarContent(LayoutWrapper * layoutWrapper,const RefPtr<LayoutWrapper> & contentLayoutWrapper)243 void SideBarContainerLayoutAlgorithm::LayoutSideBarContent(
244 LayoutWrapper* layoutWrapper, const RefPtr<LayoutWrapper>& contentLayoutWrapper)
245 {
246 auto layoutProperty = AceType::DynamicCast<SideBarContainerLayoutProperty>(layoutWrapper->GetLayoutProperty());
247 CHECK_NULL_VOID(layoutProperty);
248
249 auto type = layoutProperty->GetSideBarContainerType().value_or(SideBarContainerType::EMBED);
250 auto sideBarPosition = layoutProperty->GetSideBarPosition().value_or(SideBarPosition::START);
251
252 float contentOffsetX = 0.0f;
253 if (type == SideBarContainerType::EMBED && sideBarPosition == SideBarPosition::START) {
254 if (sideBarStatus_ == SideBarStatus::SHOW) {
255 contentOffsetX = realSideBarWidth_;
256 } else if (sideBarStatus_ == SideBarStatus::CHANGING) {
257 contentOffsetX = realSideBarWidth_ + currentOffset_;
258 }
259 }
260
261 auto contentOffset = OffsetF(contentOffsetX, 0.0f);
262 contentLayoutWrapper->GetGeometryNode()->SetMarginFrameOffset(contentOffset);
263 contentLayoutWrapper->Layout();
264 }
265
266 } // namespace OHOS::Ace::NG
267