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 #include "core/components_ng/pattern/rich_editor/rich_editor_overlay_modifier.h"
17
18 #include "base/utils/utils.h"
19 #include "core/components_ng/pattern/progress/progress_modifier.h"
20 #include "core/components_ng/pattern/rich_editor/rich_editor_pattern.h"
21 #include "core/components_ng/pattern/rich_editor/rich_editor_theme.h"
22 #include "core/components_ng/render/drawing.h"
23 #include "core/components_ng/render/drawing_prop_convertor.h"
24
25 namespace OHOS::Ace::NG {
26 namespace {
27 constexpr int32_t LAND_DURATION = 100;
28 const RefPtr<CubicCurve> LAND_CURVE = AceType::MakeRefPtr<CubicCurve>(0.2, 0, 0.2, 1.0f);
29 } // namespace
30
RichEditorOverlayModifier(const WeakPtr<OHOS::Ace::NG::Pattern> & pattern,const WeakPtr<ScrollBarOverlayModifier> & scrollbarOverlayModifier,WeakPtr<ScrollEdgeEffect> && edgeEffect)31 RichEditorOverlayModifier::RichEditorOverlayModifier(const WeakPtr<OHOS::Ace::NG::Pattern>& pattern,
32 const WeakPtr<ScrollBarOverlayModifier>& scrollbarOverlayModifier, WeakPtr<ScrollEdgeEffect>&& edgeEffect)
33 : TextOverlayModifier(), pattern_(pattern), edgeEffect_(edgeEffect),
34 scrollBarOverlayModifier_(scrollbarOverlayModifier)
35 {
36 caretVisible_ = AceType::MakeRefPtr<PropertyBool>(false);
37 AttachProperty(caretVisible_);
38 floatingCaretVisible_ = AceType::MakeRefPtr<PropertyBool>(false);
39 AttachProperty(floatingCaretVisible_);
40 originCaretVisible_ = AceType::MakeRefPtr<PropertyBool>(false);
41 AttachProperty(originCaretVisible_);
42 caretOffset_ = AceType::MakeRefPtr<PropertyOffsetF>(OffsetF());
43 AttachProperty(caretOffset_);
44 floatingCaretOffset_ = AceType::MakeRefPtr<AnimatablePropertyOffsetF>(OffsetF());
45 AttachProperty(floatingCaretOffset_);
46 caretHeight_ = AceType::MakeRefPtr<PropertyFloat>(0.0f);
47 AttachProperty(caretHeight_);
48 caretWidth_ = AceType::MakeRefPtr<PropertyFloat>(0.0f);
49 AttachProperty(caretWidth_);
50 caretColor_ = AceType::MakeRefPtr<PropertyInt>(0);
51 AttachProperty(caretColor_);
52 originCaretColor_ = AceType::MakeRefPtr<PropertyInt>(0);
53 AttachProperty(originCaretColor_);
54 scrollOffset_ = AceType::MakeRefPtr<PropertyFloat>(0.0f);
55 AttachProperty(scrollOffset_);
56 frameSize_ = AceType::MakeRefPtr<PropertySizeF>(SizeF());
57 AttachProperty(frameSize_);
58 scrollBarOpacityType_ = AceType::MakeRefPtr<PropertyInt>(-1);
59 AttachProperty(scrollBarOpacityType_);
60 textHeight_ = AceType::MakeRefPtr<PropertyFloat>(0.0f);
61 AttachProperty(textHeight_);
62 previewTextDecorationColor_ = AceType::MakeRefPtr<PropertyColor>(Color());
63 AttachProperty(previewTextDecorationColor_);
64 previewTextUnderlineWidth_ = AceType::MakeRefPtr<PropertyFloat>(0.0f);
65 AttachProperty(previewTextUnderlineWidth_);
66 showPreviewTextDecoration_ = AceType::MakeRefPtr<PropertyBool>(false);
67 AttachProperty(showPreviewTextDecoration_);
68 }
69
SetPreviewTextDecorationColor(const Color & value)70 void RichEditorOverlayModifier::SetPreviewTextDecorationColor(const Color& value)
71 {
72 previewTextDecorationColor_->Set(value);
73 }
74
SetPreviewTextUnderlineWidth(float value)75 void RichEditorOverlayModifier::SetPreviewTextUnderlineWidth(float value)
76 {
77 previewTextUnderlineWidth_->Set(value);
78 }
79
SetShowPreviewTextDecoration(bool value)80 void RichEditorOverlayModifier::SetShowPreviewTextDecoration(bool value)
81 {
82 showPreviewTextDecoration_->Set(value);
83 }
84
SetPreviewTextStyle(const PreviewTextStyle & value)85 void RichEditorOverlayModifier::SetPreviewTextStyle(const PreviewTextStyle& value)
86 {
87 previewTextStyle_ = value;
88 }
89
SetCaretOffsetAndHeight(const OffsetF & cursorOffset,float height)90 void RichEditorOverlayModifier::SetCaretOffsetAndHeight(const OffsetF& cursorOffset, float height)
91 {
92 caretOffset_->Set(cursorOffset);
93 if (height > 0.0f) {
94 caretHeight_->Set(height);
95 }
96 }
97
SetFloatingCaretOffset(const OffsetF & cursorOffset)98 void RichEditorOverlayModifier::SetFloatingCaretOffset(const OffsetF& cursorOffset)
99 {
100 floatingCaretOffset_->Set(cursorOffset);
101 }
102
SetCaretColor(uint32_t caretColor)103 void RichEditorOverlayModifier::SetCaretColor(uint32_t caretColor)
104 {
105 CHECK_NULL_VOID(caretColor_);
106 caretColor_->Set(static_cast<int32_t>(caretColor));
107 }
108
SetOriginCaretColor(uint32_t caretColor)109 void RichEditorOverlayModifier::SetOriginCaretColor(uint32_t caretColor)
110 {
111 originCaretColor_->Set(static_cast<int32_t>(caretColor));
112 }
113
SetCaretWidth(float width)114 void RichEditorOverlayModifier::SetCaretWidth(float width)
115 {
116 if (width <= 0.0f) {
117 return;
118 }
119 caretWidth_->Set(width);
120 }
121
GetCaretWidth() const122 float RichEditorOverlayModifier::GetCaretWidth() const
123 {
124 return caretWidth_->Get();
125 }
126
SetCaretVisible(bool value)127 void RichEditorOverlayModifier::SetCaretVisible(bool value)
128 {
129 caretVisible_->Set(value);
130 }
131
SetOriginCaretVisible(bool value)132 void RichEditorOverlayModifier::SetOriginCaretVisible(bool value)
133 {
134 originCaretVisible_->Set(value);
135 }
136
SetFloatingCaretVisible(bool value)137 void RichEditorOverlayModifier::SetFloatingCaretVisible(bool value)
138 {
139 floatingCaretVisible_->Set(value);
140 }
141
SetFloatCaretLanding(bool caretLanding)142 void RichEditorOverlayModifier::SetFloatCaretLanding(bool caretLanding)
143 {
144 caretLanding_ = caretLanding;
145 }
146
SetScrollOffset(float value)147 void RichEditorOverlayModifier::SetScrollOffset(float value)
148 {
149 scrollOffset_->Set(value);
150 }
151
SetScrollBarOpacityType(int32_t value)152 void RichEditorOverlayModifier::SetScrollBarOpacityType(int32_t value)
153 {
154 scrollBarOpacityType_->Set(value);
155 }
156
SetTextHeight(float value)157 void RichEditorOverlayModifier::SetTextHeight(float value)
158 {
159 textHeight_->Set(value);
160 }
161
SetFrameSize(const SizeF & value)162 void RichEditorOverlayModifier::SetFrameSize(const SizeF& value)
163 {
164 frameSize_->Set(value);
165 }
166
GetCaretHeight() const167 float RichEditorOverlayModifier::GetCaretHeight() const
168 {
169 return caretHeight_->Get();
170 }
171
GetCaretOffset() const172 OffsetF RichEditorOverlayModifier::GetCaretOffset() const
173 {
174 return caretOffset_->Get();
175 }
176
GetFloatCaretLanding() const177 bool RichEditorOverlayModifier::GetFloatCaretLanding() const
178 {
179 return caretLanding_;
180 }
181
PaintPreviewTextDecoration(DrawingContext & drawingContext) const182 void RichEditorOverlayModifier::PaintPreviewTextDecoration(DrawingContext& drawingContext) const
183 {
184 CHECK_NULL_VOID(showPreviewTextDecoration_->Get());
185 if (previewTextStyle_ != PreviewTextStyle::UNDERLINE) {
186 TAG_LOGW(AceLogTag::ACE_RICH_TEXT, "is not UNDERLINE style");
187 return;
188 }
189 auto pattern = AceType::DynamicCast<RichEditorPattern>(pattern_.Upgrade());
190 CHECK_NULL_VOID(pattern);
191
192 auto previewTextDecorationColor = caretColor_->Get();
193 auto previewTextUnderlineWidth = previewTextUnderlineWidth_->Get();
194 auto roundRectRadius = previewTextUnderlineWidth / 2;
195 auto previewTextRects = pattern->GetPreviewTextRects();
196 drawingContext.canvas.Save();
197 RSBrush brush;
198 brush.SetAntiAlias(true);
199 brush.SetColor(previewTextDecorationColor);
200 drawingContext.canvas.AttachBrush(brush);
201 for (const auto& previewTextRect : previewTextRects) {
202 auto padding = &previewTextRect == &previewTextRects.back() ? 0 : roundRectRadius;
203 RSRect rect(previewTextRect.Left(), previewTextRect.Bottom() - previewTextUnderlineWidth,
204 previewTextRect.Right() + padding, previewTextRect.Bottom());
205 drawingContext.canvas.DrawRoundRect(RSRoundRect(rect, roundRectRadius, roundRectRadius));
206 }
207 drawingContext.canvas.DetachBrush();
208 drawingContext.canvas.Restore();
209 }
210
PaintCaret(DrawingContext & drawingContext) const211 void RichEditorOverlayModifier::PaintCaret(DrawingContext& drawingContext) const
212 {
213 if (!caretVisible_->Get()) {
214 return;
215 }
216 bool isShowOriginCaret = floatingCaretVisible_->Get() && originCaretVisible_->Get();
217 CHECK_NULL_VOID(!floatingCaretVisible_->Get() || isShowOriginCaret);
218 auto& canvas = drawingContext.canvas;
219 auto offset = caretOffset_->Get();
220 canvas.Save();
221 RSPen pen;
222 pen.SetAntiAlias(true);
223 float caretWidth = caretWidth_->Get();
224 float caretHeight = caretHeight_->Get();
225 pen.SetWidth(caretWidth);
226 pen.SetCapStyle(RSPen::CapStyle::ROUND_CAP);
227 pen.SetColor(isShowOriginCaret ? originCaretColor_->Get() : caretColor_->Get());
228 canvas.AttachPen(pen);
229 float midPosX = offset.GetX() + caretWidth / 2;
230 float startPosY = offset.GetY();
231 float endPosY = startPosY + caretHeight;
232 float roundCapRadius = caretWidth / 2;
233 canvas.DrawLine(RSPoint(midPosX, startPosY + roundCapRadius), RSPoint(midPosX, endPosY - roundCapRadius));
234 canvas.DetachPen();
235 canvas.Restore();
236 }
237
PaintFloatingCaret(DrawingContext & drawingContext) const238 void RichEditorOverlayModifier::PaintFloatingCaret(DrawingContext& drawingContext) const
239 {
240 CHECK_NULL_VOID(floatingCaretVisible_->Get());
241 auto& canvas = drawingContext.canvas;
242 auto floatingCaretOffset = floatingCaretOffset_->Get();
243 canvas.Save();
244 RSPen pen;
245 pen.SetAntiAlias(true);
246 float caretWidth = caretWidth_->Get();
247 float caretHeight = caretHeight_->Get();
248 pen.SetWidth(caretWidth);
249 pen.SetCapStyle(RSPen::CapStyle::ROUND_CAP);
250 pen.SetColor(caretColor_->Get());
251 canvas.AttachPen(pen);
252 float midPosX = floatingCaretOffset.GetX() + caretWidth / 2;
253 float startPosY = floatingCaretOffset.GetY();
254 float endPosY = startPosY + caretHeight;
255 float roundCapRadius = caretWidth / 2;
256 canvas.DrawLine(RSPoint(midPosX, startPosY + roundCapRadius), RSPoint(midPosX, endPosY - roundCapRadius));
257 canvas.DetachPen();
258 canvas.Restore();
259 }
260
PaintScrollBar(DrawingContext & context)261 void RichEditorOverlayModifier::PaintScrollBar(DrawingContext& context)
262 {
263 auto scrollBarOverlayModifier = scrollBarOverlayModifier_.Upgrade();
264 CHECK_NULL_VOID(scrollBarOverlayModifier);
265 auto pattern = AceType::DynamicCast<RichEditorPattern>(pattern_.Upgrade());
266 CHECK_NULL_VOID(!pattern || pattern->GetBarDisplayMode() != DisplayMode::OFF);
267 scrollBarOverlayModifier->onDraw(context);
268 }
269
PaintEdgeEffect(const SizeF & frameSize,RSCanvas & canvas)270 void RichEditorOverlayModifier::PaintEdgeEffect(const SizeF& frameSize, RSCanvas& canvas)
271 {
272 auto edgeEffect = edgeEffect_.Upgrade();
273 CHECK_NULL_VOID(edgeEffect);
274 edgeEffect->Paint(canvas, frameSize, { 0.0f, 0.0f });
275 }
276
onDraw(DrawingContext & drawingContext)277 void RichEditorOverlayModifier::onDraw(DrawingContext& drawingContext)
278 {
279 ACE_SCOPED_TRACE("RichEditorOverlayOnDraw");
280 drawingContext.canvas.Save();
281 auto richEditorPattern = AceType::DynamicCast<RichEditorPattern>(pattern_.Upgrade());
282 CHECK_NULL_VOID(richEditorPattern);
283 auto contentRect = richEditorPattern->GetTextContentRect();
284
285 drawingContext.canvas.ClipRect(ToRSRect(contentRect), RSClipOp::INTERSECT);
286 PaintCaret(drawingContext);
287 PaintFloatingCaret(drawingContext);
288 PaintPreviewTextDecoration(drawingContext);
289 SetSelectedColor(richEditorPattern->GetSelectedBackgroundColor().GetValue());
290 TextOverlayModifier::onDraw(drawingContext);
291 drawingContext.canvas.Restore();
292
293 PaintScrollBar(drawingContext);
294 PaintEdgeEffect(frameSize_->Get(), drawingContext.canvas);
295 }
296
UpdateScrollBar(PaintWrapper * paintWrapper)297 void RichEditorOverlayModifier::UpdateScrollBar(PaintWrapper* paintWrapper)
298 {
299 auto richEditorPattern = AceType::DynamicCast<RichEditorPattern>(pattern_.Upgrade());
300 CHECK_NULL_VOID(richEditorPattern);
301 auto scrollBar = richEditorPattern->GetScrollControllerBar();
302 if (!scrollBar || !scrollBar->NeedPaint()) {
303 return;
304 }
305 auto scrollBarOverlayModifier = scrollBarOverlayModifier_.Upgrade();
306 CHECK_NULL_VOID(scrollBarOverlayModifier);
307 if (scrollBar->GetPositionModeUpdate()) {
308 scrollBarOverlayModifier->SetPositionMode(scrollBar->GetPositionMode());
309 }
310 SetScrollBarOpacityType(static_cast<int32_t>(scrollBar->GetOpacityAnimationType()));
311 scrollBarOverlayModifier->StartBarAnimation(scrollBar->GetHoverAnimationType(),
312 scrollBar->GetOpacityAnimationType(), scrollBar->GetNeedAdaptAnimation(), scrollBar->GetActiveRect());
313 scrollBar->SetHoverAnimationType(HoverAnimationType::NONE);
314 scrollBarOverlayModifier->SetBarColor(scrollBar->GetForegroundColor());
315 scrollBar->SetOpacityAnimationType(OpacityAnimationType::NONE);
316 }
317
StartFloatingCaretLand(const OffsetF & originCaretOffset)318 void RichEditorOverlayModifier::StartFloatingCaretLand(const OffsetF& originCaretOffset)
319 {
320 AnimationOption option = AnimationOption();
321 option.SetDuration(LAND_DURATION);
322 option.SetCurve(LAND_CURVE);
323 caretLanding_ = true;
324 AnimationUtils::Animate(
325 option,
326 [weak = WeakClaim(this), originCaretOffset]() {
327 auto modifier = weak.Upgrade();
328 CHECK_NULL_VOID(modifier);
329 modifier->SetFloatingCaretOffset(originCaretOffset);
330 },
331 [weak = WeakClaim(this), pattern = pattern_]() {
332 auto modifier = weak.Upgrade();
333 CHECK_NULL_VOID(modifier);
334 modifier->SetFloatCaretLanding(false);
335 auto richEditorPattern = AceType::DynamicCast<RichEditorPattern>(pattern.Upgrade());
336 CHECK_NULL_VOID(richEditorPattern);
337 richEditorPattern->ResetFloatingCaretState();
338 auto host = richEditorPattern->GetHost();
339 CHECK_NULL_VOID(host);
340 host->MarkDirtyNode(PROPERTY_UPDATE_RENDER);
341 });
342 }
343 } // namespace OHOS::Ace::NG
344