src/third_party/WebKit/Source/core/rendering/RenderRegion.h

   1 /*
   2  * Copyright (C) 2011 Adobe Systems Incorporated. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *
   8  * 1. Redistributions of source code must retain the above
   9  *    copyright notice, this list of conditions and the following
  10  *    disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above
  12  *    copyright notice, this list of conditions and the following
  13  *    disclaimer in the documentation and/or other materials
  14  *    provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER “AS IS” AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  19  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE
  20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
  21  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  22  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  23  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  25  * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
  26  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  */
  29
  30 #ifndef RenderRegion_h
  31 #define RenderRegion_h
  32
  33 #include "core/rendering/RenderBlockFlow.h"
  34 #include "core/rendering/style/StyleInheritedData.h"
  35
  36 namespace WebCore {
  37
  38 struct LayerFragment;
  39 typedef Vector<LayerFragment, 1> LayerFragments;
  40 class RenderBox;
  41 class RenderFlowThread;
  42
  43 class RenderRegion : public RenderBlockFlow {
  44 public:
  45     explicit RenderRegion(Element*, RenderFlowThread*);
  46
  47     virtual bool isRenderRegion() const OVERRIDE FINAL { return true; }
  48
  49     void setFlowThreadPortionRect(const LayoutRect& rect) { m_flowThreadPortionRect = rect; }
  50     LayoutRect flowThreadPortionRect() const { return m_flowThreadPortionRect; }
  51     LayoutRect flowThreadPortionOverflowRect() const;
  52
  53     void attachRegion();
  54     void detachRegion();
  55
  56     RenderFlowThread* flowThread() const { return m_flowThread; }
  57
  58     // Valid regions do not create circular dependencies with other flows.
  59     bool isValid() const { return m_isValid; }
  60     void setIsValid(bool valid) { m_isValid = valid; }
  61
  62     bool isFirstRegion() const;
  63     bool isLastRegion() const;
  64
  65     // These methods represent the width and height of a "page" and for a RenderRegion they are just the
  66     // content width and content height of a region. For RenderRegionSets, however, they will be the width and
  67     // height of a single column or page in the set.
  68     virtual LayoutUnit pageLogicalWidth() const;
  69     virtual LayoutUnit pageLogicalHeight() const;
  70
  71     LayoutUnit logicalTopOfFlowThreadContentRect(const LayoutRect&) const;
  72     LayoutUnit logicalBottomOfFlowThreadContentRect(const LayoutRect&) const;
  73     LayoutUnit logicalTopForFlowThreadContent() const { return logicalTopOfFlowThreadContentRect(flowThreadPortionRect()); };
  74     LayoutUnit logicalBottomForFlowThreadContent() const { return logicalBottomOfFlowThreadContentRect(flowThreadPortionRect()); };
  75
  76     // This method represents the logical height of the entire flow thread portion used by the region or set.
  77     // For RenderRegions it matches logicalPaginationHeight(), but for sets it is the height of all the pages
  78     // or columns added together.
  79     virtual LayoutUnit logicalHeightOfAllFlowThreadContent() const;
  80
  81     // The top of the nearest page inside the region. For RenderRegions, this is just the logical top of the
  82     // flow thread portion we contain. For sets, we have to figure out the top of the nearest column or
  83     // page.
  84     virtual LayoutUnit pageLogicalTopForOffset(LayoutUnit offset) const;
  85
  86     virtual void expandToEncompassFlowThreadContentsIfNeeded() { };
  87
  88     virtual void repaintFlowThreadContent(const LayoutRect& repaintRect) const;
  89
  90     virtual void collectLayerFragments(LayerFragments&, const LayoutRect&, const LayoutRect&) { }
  91
  92     virtual bool canHaveChildren() const OVERRIDE FINAL { return false; }
  93     virtual bool canHaveGeneratedChildren() const OVERRIDE FINAL { return true; }
  94
  95     virtual const char* renderName() const OVERRIDE { return "RenderRegion"; }
  96
  97 protected:
  98     virtual void computeIntrinsicLogicalWidths(LayoutUnit& minLogicalWidth, LayoutUnit& maxLogicalWidth) const OVERRIDE FINAL;
  99
 100     LayoutRect overflowRectForFlowThreadPortion(const LayoutRect& flowThreadPortionRect, bool isFirstPortion, bool isLastPortion) const;
 101     void repaintFlowThreadContentRectangle(const LayoutRect& repaintRect, const LayoutRect& flowThreadPortionRect,
 102         const LayoutRect& flowThreadPortionOverflowRect, const LayoutPoint& regionLocation) const;
 103
 104 private:
 105     virtual void insertedIntoTree() OVERRIDE FINAL;
 106     virtual void willBeRemovedFromTree() OVERRIDE FINAL;
 107
 108     virtual void layoutBlock(bool relayoutChildren) OVERRIDE FINAL;
 109     virtual bool supportsPartialLayout() const OVERRIDE FINAL { return false; }
 110
 111 protected:
 112     RenderFlowThread* m_flowThread;
 113
 114 private:
 115     LayoutRect m_flowThreadPortionRect;
 116     bool m_isValid : 1;
 117 };
 118
 119 DEFINE_RENDER_OBJECT_TYPE_CASTS(RenderRegion, isRenderRegion());
 120
 121 } // namespace WebCore
 122
 123 #endif // RenderRegion_h