blob: 72c8232f00ac945f40c4e49404f1dfc5395275e8 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
// Copyright 2016 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef THIRD_PARTY_BLINK_RENDERER_CORE_PAGE_SCROLLING_TOP_DOCUMENT_ROOT_SCROLLER_CONTROLLER_H_
#define THIRD_PARTY_BLINK_RENDERER_CORE_PAGE_SCROLLING_TOP_DOCUMENT_ROOT_SCROLLER_CONTROLLER_H_
#include "third_party/blink/renderer/core/core_export.h"
#include "third_party/blink/renderer/core/page/scrolling/root_scroller_controller.h"
#include "third_party/blink/renderer/platform/geometry/int_size.h"
#include "third_party/blink/renderer/platform/heap/handle.h"
namespace blink {
class Element;
class LocalFrameView;
class Page;
class GraphicsLayer;
class PaintLayer;
class RootFrameViewport;
class ScrollStateCallback;
class ScrollableArea;
class ViewportScrollCallback;
// This class manages the the page level aspects of the root scroller. That
// is, given all the iframes on a page and their individual root scrollers,
// this class will determine which ultimate Element should be used as the root
// scroller and ensures that Element is used to scroll browser controls and
// provide overscroll effects. High level details are available in README.md.
// TODO(bokan): This class is currently OOPIF unaware. crbug.com/642378.
class CORE_EXPORT TopDocumentRootScrollerController
: public GarbageCollected<TopDocumentRootScrollerController> {
public:
static TopDocumentRootScrollerController* Create(Page&);
void Trace(blink::Visitor*);
// This class needs to be informed of changes to compositing so that it can
// update the compositor when the effective root scroller changes.
void DidUpdateCompositing(const LocalFrameView&);
// PaintLayerScrollableAreas need to notify this class when they're being
// disposed so that we can remove them as the root scroller.
void DidDisposeScrollableArea(ScrollableArea&);
// This method needs to be called to create a ViewportScrollCallback that
// will be used to apply viewport scrolling actions like browser controls
// movement and overscroll glow.
void InitializeViewportScrollCallback(RootFrameViewport&);
// Returns true if the given ScrollStateCallback is the
// ViewportScrollCallback managed by this class.
// TODO(bokan): Temporarily needed to allow ScrollCustomization to
// differentiate between real custom callback and the built-in viewport
// apply scroll. crbug.com/623079.
bool IsViewportScrollCallback(const ScrollStateCallback*) const;
// Returns the GraphicsLayer for the global root scroller.
GraphicsLayer* RootScrollerLayer() const;
// Returns the GraphicsLayer for the global root scroll container.
GraphicsLayer* RootContainerLayer() const;
PaintLayer* RootScrollerPaintLayer() const;
// Returns the Element that's the global root scroller. See README.md for
// the difference between this and the root scroller types in
// RootScrollerController.
Element* GlobalRootScroller() const;
// Called when the root scroller in any frames on the page has changed.
void DidChangeRootScroller();
void DidResizeViewport();
// Returns the ScrollableArea associated with the globalRootScroller(). Note,
// this isn't necessarily the PLSA belonging to the root scroller Element's
// LayoutBox. If the root scroller is the documentElement then we use the
// LocalFrameView (or LayoutView if root-layer-scrolls).
ScrollableArea* RootScrollerArea() const;
// Returns the size we should use for the root scroller, accounting for top
// controls adjustment and using the root LocalFrameView.
IntSize RootScrollerVisibleArea() const;
private:
TopDocumentRootScrollerController(Page&);
// Calculates the Element that should be the globalRootScroller. On a
// simple page, this will simply the root frame's effectiveRootScroller but
// if the root scroller is set to an iframe, this will then descend into
// the iframe to find its effective root scroller.
Element* FindGlobalRootScrollerElement();
// Should be called to ensure the correct element is currently set as the
// global root scroller and that all appropriate state changes are made if
// it changes.
void RecomputeGlobalRootScroller();
Document* TopDocument() const;
// The apply-scroll callback that moves browser controls and produces
// overscroll effects. This class makes sure this callback is set on the
// appropriate root scroller element.
Member<ViewportScrollCallback> viewport_apply_scroll_;
// The page level root scroller. i.e. The actual element for which
// scrolling should move browser controls and produce overscroll glow. Once an
// m_viewportApplyScroll has been created, it will always be set on this
// Element.
WeakMember<Element> global_root_scroller_;
Member<Page> page_;
};
} // namespace blink
#endif // RootScrollerController_h
|
