mirror of
https://github.com/flutter/flutter.git
synced 2026-02-20 02:29:02 +08:00
9b654433ea
ScrollableArea only has one subclass now. Make all it's virtual methods be pure virtual and delete any methods that RenderLayerScrollableArea overrides. Eventually we should probably merge the two classes into one, but ScrollableArea is in platform and RenderLayerScrollableArea is in core/rendering, so it's non-trivial figuring out what the end result should look like. Hopefully it will become more clear as we delete more of the scrolling code. R=abarth@chromium.org Review URL: https://codereview.chromium.org/711483003
266 lines
11 KiB
C++
266 lines
11 KiB
C++
/*
|
|
* Copyright (C) 2008, 2011 Apple Inc. All Rights Reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
|
|
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
|
|
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
|
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
|
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
|
|
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
|
|
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
#ifndef ScrollableArea_h
|
|
#define ScrollableArea_h
|
|
|
|
#include "platform/PlatformExport.h"
|
|
#include "platform/scroll/ScrollAnimator.h"
|
|
#include "platform/scroll/Scrollbar.h"
|
|
#include "wtf/Noncopyable.h"
|
|
#include "wtf/Vector.h"
|
|
|
|
namespace blink {
|
|
|
|
class FloatPoint;
|
|
class GraphicsLayer;
|
|
class HostWindow;
|
|
class PlatformWheelEvent;
|
|
class ProgrammaticScrollAnimator;
|
|
class ScrollAnimator;
|
|
|
|
enum ScrollBehavior {
|
|
ScrollBehaviorAuto,
|
|
ScrollBehaviorInstant,
|
|
ScrollBehaviorSmooth,
|
|
};
|
|
|
|
enum IncludeScrollbarsInRect {
|
|
ExcludeScrollbars,
|
|
IncludeScrollbars,
|
|
};
|
|
|
|
class PLATFORM_EXPORT ScrollableArea {
|
|
WTF_MAKE_NONCOPYABLE(ScrollableArea);
|
|
public:
|
|
static int pixelsPerLineStep();
|
|
static float minFractionToStepWhenPaging();
|
|
static int maxOverlapBetweenPages();
|
|
|
|
// The window that hosts the ScrollView. The ScrollView will communicate scrolls and repaints to the
|
|
// host window in the window's coordinate space.
|
|
virtual HostWindow* hostWindow() const = 0;
|
|
|
|
bool scroll(ScrollDirection, ScrollGranularity, float delta = 1);
|
|
void scrollToOffsetWithoutAnimation(const FloatPoint&);
|
|
void scrollToOffsetWithoutAnimation(ScrollbarOrientation, float offset);
|
|
|
|
void programmaticallyScrollSmoothlyToOffset(const FloatPoint&);
|
|
|
|
// Should be called when the scroll position changes externally, for example if the scroll layer position
|
|
// is updated on the scrolling thread and we need to notify the main thread.
|
|
void notifyScrollPositionChanged(const IntPoint&);
|
|
|
|
static bool scrollBehaviorFromString(const String&, ScrollBehavior&);
|
|
|
|
bool handleWheelEvent(const PlatformWheelEvent&);
|
|
|
|
// Functions for controlling if you can scroll past the end of the document.
|
|
bool constrainsScrollingToContentEdge() const { return m_constrainsScrollingToContentEdge; }
|
|
void setConstrainsScrollingToContentEdge(bool constrainsScrollingToContentEdge) { m_constrainsScrollingToContentEdge = constrainsScrollingToContentEdge; }
|
|
|
|
void setVerticalScrollElasticity(ScrollElasticity scrollElasticity) { m_verticalScrollElasticity = scrollElasticity; }
|
|
ScrollElasticity verticalScrollElasticity() const { return static_cast<ScrollElasticity>(m_verticalScrollElasticity); }
|
|
|
|
void setHorizontalScrollElasticity(ScrollElasticity scrollElasticity) { m_horizontalScrollElasticity = scrollElasticity; }
|
|
ScrollElasticity horizontalScrollElasticity() const { return static_cast<ScrollElasticity>(m_horizontalScrollElasticity); }
|
|
|
|
bool inLiveResize() const { return m_inLiveResize; }
|
|
void willStartLiveResize();
|
|
void willEndLiveResize();
|
|
|
|
void mouseEnteredContentArea() const;
|
|
void mouseExitedContentArea() const;
|
|
void mouseMovedInContentArea() const;
|
|
void mouseEnteredScrollbar(Scrollbar*) const;
|
|
void mouseExitedScrollbar(Scrollbar*) const;
|
|
void contentAreaDidShow() const;
|
|
void contentAreaDidHide() const;
|
|
|
|
void finishCurrentScrollAnimations() const;
|
|
|
|
void didAddScrollbar(Scrollbar*, ScrollbarOrientation);
|
|
void willRemoveScrollbar(Scrollbar*, ScrollbarOrientation);
|
|
|
|
void contentsResized();
|
|
|
|
bool hasOverlayScrollbars() const;
|
|
void setScrollbarOverlayStyle(ScrollbarOverlayStyle);
|
|
ScrollbarOverlayStyle scrollbarOverlayStyle() const { return static_cast<ScrollbarOverlayStyle>(m_scrollbarOverlayStyle); }
|
|
|
|
// This getter will create a ScrollAnimator if it doesn't already exist.
|
|
ScrollAnimator* scrollAnimator() const;
|
|
|
|
// This getter will return null if the ScrollAnimator hasn't been created yet.
|
|
ScrollAnimator* existingScrollAnimator() const { return m_animators ? m_animators->scrollAnimator.get() : 0; }
|
|
|
|
ProgrammaticScrollAnimator* programmaticScrollAnimator() const;
|
|
ProgrammaticScrollAnimator* existingProgrammaticScrollAnimator() const
|
|
{
|
|
return m_animators ? m_animators->programmaticScrollAnimator.get() : 0;
|
|
}
|
|
|
|
const IntPoint& scrollOrigin() const { return m_scrollOrigin; }
|
|
bool scrollOriginChanged() const { return m_scrollOriginChanged; }
|
|
|
|
// FIXME(bokan): Meaningless name, rename to isActiveFocus
|
|
virtual bool isActive() const = 0;
|
|
virtual int scrollSize(ScrollbarOrientation) const = 0;
|
|
void invalidateScrollbar(Scrollbar*, const IntRect&);
|
|
|
|
// Convert points and rects between the scrollbar and its containing view.
|
|
// The client needs to implement these in order to be aware of layout effects
|
|
// like CSS transforms.
|
|
virtual IntRect convertFromScrollbarToContainingView(const Scrollbar*, const IntRect&) const = 0;
|
|
virtual IntRect convertFromContainingViewToScrollbar(const Scrollbar*, const IntRect&) const = 0;
|
|
virtual IntPoint convertFromScrollbarToContainingView(const Scrollbar*, const IntPoint&) const = 0;
|
|
virtual IntPoint convertFromContainingViewToScrollbar(const Scrollbar*, const IntPoint&) const = 0;
|
|
|
|
virtual Scrollbar* horizontalScrollbar() const = 0;
|
|
virtual Scrollbar* verticalScrollbar() const = 0;
|
|
|
|
// scrollPosition is relative to the scrollOrigin. i.e. If the page is RTL
|
|
// then scrollPosition will be negative.
|
|
virtual IntPoint scrollPosition() const = 0;
|
|
virtual IntPoint minimumScrollPosition() const = 0;
|
|
virtual IntPoint maximumScrollPosition() const = 0;
|
|
|
|
virtual IntSize contentsSize() const = 0;
|
|
|
|
bool shouldSuspendScrollAnimations() const { return true; }
|
|
|
|
// NOTE: Only called from Internals for testing.
|
|
void setScrollOffsetFromInternals(const IntPoint&);
|
|
|
|
IntPoint clampScrollPosition(const IntPoint&) const;
|
|
|
|
// Let subclasses provide a way of asking for and servicing scroll
|
|
// animations.
|
|
bool scheduleAnimation();
|
|
void serviceScrollAnimations(double monotonicTime);
|
|
|
|
// Returns true if the GraphicsLayer tree needs to be rebuilt.
|
|
virtual bool updateAfterCompositingChange() = 0;
|
|
|
|
virtual bool userInputScrollable(ScrollbarOrientation) const = 0;
|
|
virtual bool shouldPlaceVerticalScrollbarOnLeft() const = 0;
|
|
|
|
int scrollPosition(ScrollbarOrientation orientation) { return orientation == HorizontalScrollbar ? scrollPosition().x() : scrollPosition().y(); }
|
|
int minimumScrollPosition(ScrollbarOrientation orientation) { return orientation == HorizontalScrollbar ? minimumScrollPosition().x() : minimumScrollPosition().y(); }
|
|
int maximumScrollPosition(ScrollbarOrientation orientation) { return orientation == HorizontalScrollbar ? maximumScrollPosition().x() : maximumScrollPosition().y(); }
|
|
int clampScrollPosition(ScrollbarOrientation orientation, int pos) { return std::max(std::min(pos, maximumScrollPosition(orientation)), minimumScrollPosition(orientation)); }
|
|
|
|
bool hasVerticalBarDamage() const { return !m_verticalBarDamage.isEmpty(); }
|
|
bool hasHorizontalBarDamage() const { return !m_horizontalBarDamage.isEmpty(); }
|
|
const IntRect& verticalBarDamage() const { return m_verticalBarDamage; }
|
|
const IntRect& horizontalBarDamage() const { return m_horizontalBarDamage; }
|
|
|
|
void addScrollbarDamage(Scrollbar* scrollbar, const IntRect& rect)
|
|
{
|
|
if (scrollbar == horizontalScrollbar())
|
|
m_horizontalBarDamage.unite(rect);
|
|
else
|
|
m_verticalBarDamage.unite(rect);
|
|
}
|
|
|
|
void resetScrollbarDamage()
|
|
{
|
|
m_verticalBarDamage = IntRect();
|
|
m_horizontalBarDamage = IntRect();
|
|
}
|
|
|
|
GraphicsLayer* layerForContainer() const;
|
|
virtual GraphicsLayer* layerForScrolling() const = 0;
|
|
virtual GraphicsLayer* layerForHorizontalScrollbar() const = 0;
|
|
virtual GraphicsLayer* layerForVerticalScrollbar() const = 0;
|
|
bool hasLayerForHorizontalScrollbar() const;
|
|
bool hasLayerForVerticalScrollbar() const;
|
|
|
|
void cancelProgrammaticScrollAnimation();
|
|
|
|
protected:
|
|
ScrollableArea();
|
|
virtual ~ScrollableArea();
|
|
|
|
void setScrollOrigin(const IntPoint&);
|
|
void resetScrollOriginChanged() { m_scrollOriginChanged = false; }
|
|
|
|
virtual void invalidateScrollbarRect(Scrollbar*, const IntRect&) = 0;
|
|
|
|
private:
|
|
void scrollPositionChanged(const IntPoint&);
|
|
|
|
// NOTE: Only called from the ScrollAnimator.
|
|
friend class ScrollAnimator;
|
|
void setScrollOffsetFromAnimation(const IntPoint&);
|
|
|
|
// This function should be overriden by subclasses to perform the actual
|
|
// scroll of the content.
|
|
virtual void setScrollOffset(const IntPoint&) = 0;
|
|
|
|
int lineStep(ScrollbarOrientation) const;
|
|
int documentStep(ScrollbarOrientation) const;
|
|
virtual int pageStep(ScrollbarOrientation) const = 0;
|
|
float pixelStep(ScrollbarOrientation) const;
|
|
|
|
// Stores the paint invalidations for the scrollbars during layout.
|
|
IntRect m_horizontalBarDamage;
|
|
IntRect m_verticalBarDamage;
|
|
|
|
struct ScrollableAreaAnimators {
|
|
OwnPtr<ScrollAnimator> scrollAnimator;
|
|
OwnPtr<ProgrammaticScrollAnimator> programmaticScrollAnimator;
|
|
};
|
|
|
|
mutable OwnPtr<ScrollableAreaAnimators> m_animators;
|
|
unsigned m_constrainsScrollingToContentEdge : 1;
|
|
|
|
unsigned m_inLiveResize : 1;
|
|
|
|
unsigned m_verticalScrollElasticity : 2; // ScrollElasticity
|
|
unsigned m_horizontalScrollElasticity : 2; // ScrollElasticity
|
|
|
|
unsigned m_scrollbarOverlayStyle : 2; // ScrollbarOverlayStyle
|
|
|
|
unsigned m_scrollOriginChanged : 1;
|
|
|
|
// There are 8 possible combinations of writing mode and direction. Scroll origin will be non-zero in the x or y axis
|
|
// if there is any reversed direction or writing-mode. The combinations are:
|
|
// writing-mode / direction scrollOrigin.x() set scrollOrigin.y() set
|
|
// horizontal-tb / ltr NO NO
|
|
// horizontal-tb / rtl YES NO
|
|
// horizontal-bt / ltr NO YES
|
|
// horizontal-bt / rtl YES YES
|
|
// vertical-lr / ltr NO NO
|
|
// vertical-lr / rtl NO YES
|
|
// vertical-rl / ltr YES NO
|
|
// vertical-rl / rtl YES YES
|
|
IntPoint m_scrollOrigin;
|
|
};
|
|
|
|
} // namespace blink
|
|
|
|
#endif // ScrollableArea_h
|