layout/tables/nsTableOuterFrame.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5 #ifndef nsTableOuterFrame_h__
   6 #define nsTableOuterFrame_h__
   7
   8 #include "mozilla/Attributes.h"
   9 #include "nscore.h"
  10 #include "nsContainerFrame.h"
  11 #include "nsCellMap.h"
  12 #include "nsBlockFrame.h"
  13 #include "nsTableFrame.h"
  14
  15 class nsTableCaptionFrame : public nsBlockFrame
  16 {
  17 public:
  18   NS_DECL_FRAMEARENA_HELPERS
  19
  20   friend nsTableCaptionFrame* NS_NewTableCaptionFrame(nsIPresShell* aPresShell,
  21                                                       nsStyleContext*  aContext);
  22   // nsIFrame
  23   virtual nsIAtom* GetType() const MOZ_OVERRIDE;
  24
  25   virtual mozilla::LogicalSize
  26   ComputeAutoSize(nsRenderingContext *aRenderingContext,
  27                   mozilla::WritingMode aWritingMode,
  28                   const mozilla::LogicalSize& aCBSize,
  29                   nscoord aAvailableISize,
  30                   const mozilla::LogicalSize& aMargin,
  31                   const mozilla::LogicalSize& aBorder,
  32                   const mozilla::LogicalSize& aPadding,
  33                   bool aShrinkWrap) MOZ_OVERRIDE;
  34
  35   virtual nsIFrame* GetParentStyleContextFrame() const MOZ_OVERRIDE;
  36
  37 #ifdef ACCESSIBILITY
  38   virtual mozilla::a11y::AccType AccessibleType() MOZ_OVERRIDE;
  39 #endif
  40
  41 #ifdef DEBUG_FRAME_DUMP
  42   virtual nsresult GetFrameName(nsAString& aResult) const MOZ_OVERRIDE;
  43 #endif
  44
  45 protected:
  46   explicit nsTableCaptionFrame(nsStyleContext*  aContext);
  47   virtual ~nsTableCaptionFrame();
  48 };
  49
  50
  51 /**
  52  * Primary frame for a table element,
  53  * the nsTableOuterFrame contains 0 or one caption frame, and a nsTableFrame
  54  * pseudo-frame (referred to as the "inner frame').
  55  */
  56 class nsTableOuterFrame : public nsContainerFrame
  57 {
  58 public:
  59   NS_DECL_QUERYFRAME
  60   NS_DECL_FRAMEARENA_HELPERS
  61
  62   NS_DECL_QUERYFRAME_TARGET(nsTableOuterFrame)
  63
  64   /** instantiate a new instance of nsTableRowFrame.
  65     * @param aPresShell the pres shell for this frame
  66     *
  67     * @return           the frame that was created
  68     */
  69   friend nsTableOuterFrame* NS_NewTableOuterFrame(nsIPresShell* aPresShell,
  70                                                   nsStyleContext* aContext);
  71
  72   // nsIFrame overrides - see there for a description
  73
  74   virtual void DestroyFrom(nsIFrame* aDestructRoot) MOZ_OVERRIDE;
  75
  76   virtual const nsFrameList& GetChildList(ChildListID aListID) const MOZ_OVERRIDE;
  77   virtual void GetChildLists(nsTArray<ChildList>* aLists) const MOZ_OVERRIDE;
  78
  79   virtual void SetInitialChildList(ChildListID     aListID,
  80                                    nsFrameList&    aChildList) MOZ_OVERRIDE;
  81   virtual void AppendFrames(ChildListID     aListID,
  82                             nsFrameList&    aFrameList) MOZ_OVERRIDE;
  83   virtual void InsertFrames(ChildListID     aListID,
  84                             nsIFrame*       aPrevFrame,
  85                             nsFrameList&    aFrameList) MOZ_OVERRIDE;
  86   virtual void RemoveFrame(ChildListID     aListID,
  87                            nsIFrame*       aOldFrame) MOZ_OVERRIDE;
  88
  89   virtual nsContainerFrame* GetContentInsertionFrame() MOZ_OVERRIDE {
  90     return GetFirstPrincipalChild()->GetContentInsertionFrame();
  91   }
  92
  93 #ifdef ACCESSIBILITY
  94   virtual mozilla::a11y::AccType AccessibleType() MOZ_OVERRIDE;
  95 #endif
  96
  97   virtual void BuildDisplayList(nsDisplayListBuilder*   aBuilder,
  98                                 const nsRect&           aDirtyRect,
  99                                 const nsDisplayListSet& aLists) MOZ_OVERRIDE;
 100
 101   void BuildDisplayListForInnerTable(nsDisplayListBuilder*   aBuilder,
 102                                      const nsRect&           aDirtyRect,
 103                                      const nsDisplayListSet& aLists);
 104
 105   virtual nscoord GetLogicalBaseline(mozilla::WritingMode aWritingMode) const MOZ_OVERRIDE;
 106
 107   virtual nscoord GetMinISize(nsRenderingContext *aRenderingContext) MOZ_OVERRIDE;
 108   virtual nscoord GetPrefISize(nsRenderingContext *aRenderingContext) MOZ_OVERRIDE;
 109
 110   virtual mozilla::LogicalSize
 111   ComputeAutoSize(nsRenderingContext *aRenderingContext,
 112                   mozilla::WritingMode aWritingMode,
 113                   const mozilla::LogicalSize& aCBSize,
 114                   nscoord aAvailableISize,
 115                   const mozilla::LogicalSize& aMargin,
 116                   const mozilla::LogicalSize& aBorder,
 117                   const mozilla::LogicalSize& aPadding,
 118                   bool aShrinkWrap) MOZ_OVERRIDE;
 119
 120   /** process a reflow command for the table.
 121     * This involves reflowing the caption and the inner table.
 122     * @see nsIFrame::Reflow */
 123   virtual void Reflow(nsPresContext*           aPresContext,
 124                       nsHTMLReflowMetrics&     aDesiredSize,
 125                       const nsHTMLReflowState& aReflowState,
 126                       nsReflowStatus&          aStatus) MOZ_OVERRIDE;
 127
 128   /**
 129    * Get the "type" of the frame
 130    *
 131    * @see nsGkAtoms::tableOuterFrame
 132    */
 133   virtual nsIAtom* GetType() const MOZ_OVERRIDE;
 134
 135 #ifdef DEBUG_FRAME_DUMP
 136   virtual nsresult GetFrameName(nsAString& aResult) const MOZ_OVERRIDE;
 137 #endif
 138
 139   virtual nsIFrame* GetParentStyleContextFrame() const MOZ_OVERRIDE;
 140
 141   /**
 142    * Return the content for the cell at the given row and column.
 143    */
 144   nsIContent* GetCellAt(uint32_t aRowIdx, uint32_t aColIdx) const;
 145
 146   /**
 147    * Return the number of rows in the table.
 148    */
 149   int32_t GetRowCount() const
 150   {
 151     return InnerTableFrame()->GetRowCount();
 152   }
 153
 154   /**
 155    * Return the number of columns in the table.
 156    */
 157   int32_t GetColCount() const
 158   {
 159     return InnerTableFrame()->GetColCount();
 160   }
 161
 162   /**
 163    * Return the index of the cell at the given row and column.
 164    */
 165   int32_t GetIndexByRowAndColumn(int32_t aRowIdx, int32_t aColIdx) const
 166   {
 167     nsTableCellMap* cellMap = InnerTableFrame()->GetCellMap();
 168     if (!cellMap)
 169       return -1;
 170
 171     return cellMap->GetIndexByRowAndColumn(aRowIdx, aColIdx);
 172   }
 173
 174   /**
 175    * Get the row and column indices for the cell at the given index.
 176    */
 177   void GetRowAndColumnByIndex(int32_t aCellIdx, int32_t* aRowIdx,
 178                               int32_t* aColIdx) const
 179   {
 180     *aRowIdx = *aColIdx = 0;
 181     nsTableCellMap* cellMap = InnerTableFrame()->GetCellMap();
 182     if (cellMap) {
 183       cellMap->GetRowAndColumnByIndex(aCellIdx, aRowIdx, aColIdx);
 184     }
 185   }
 186
 187   /**
 188    * return the frame for the cell at the given row and column.
 189    */
 190   nsTableCellFrame* GetCellFrameAt(uint32_t aRowIdx, uint32_t aColIdx) const
 191   {
 192     nsTableCellMap* map = InnerTableFrame()->GetCellMap();
 193     if (!map) {
 194       return nullptr;
 195     }
 196
 197     return map->GetCellInfoAt(aRowIdx, aColIdx);
 198   }
 199
 200   /**
 201    * Return the col span of the cell at the given row and column indices.
 202    */
 203   uint32_t GetEffectiveColSpanAt(uint32_t aRowIdx, uint32_t aColIdx) const
 204   {
 205     nsTableCellMap* map = InnerTableFrame()->GetCellMap();
 206     return map->GetEffectiveColSpan(aRowIdx, aColIdx);
 207   }
 208
 209   /**
 210    * Return the effective row span of the cell at the given row and column.
 211    */
 212   uint32_t GetEffectiveRowSpanAt(uint32_t aRowIdx, uint32_t aColIdx) const
 213   {
 214     nsTableCellMap* map = InnerTableFrame()->GetCellMap();
 215     return map->GetEffectiveRowSpan(aRowIdx, aColIdx);
 216   }
 217
 218 protected:
 219
 220
 221   explicit nsTableOuterFrame(nsStyleContext* aContext);
 222   virtual ~nsTableOuterFrame();
 223
 224   void InitChildReflowState(nsPresContext&    aPresContext,
 225                             nsHTMLReflowState& aReflowState);
 226
 227   uint8_t GetCaptionSide(); // NS_STYLE_CAPTION_SIDE_* or NO_SIDE
 228
 229   bool HasSideCaption() {
 230     uint8_t captionSide = GetCaptionSide();
 231     return captionSide == NS_STYLE_CAPTION_SIDE_LEFT ||
 232            captionSide == NS_STYLE_CAPTION_SIDE_RIGHT;
 233   }
 234
 235   uint8_t GetCaptionVerticalAlign();
 236
 237   void SetDesiredSize(uint8_t         aCaptionSide,
 238                       const nsMargin& aInnerMargin,
 239                       const nsMargin& aCaptionMargin,
 240                       nscoord&        aWidth,
 241                       nscoord&        aHeight);
 242
 243   nsresult   GetCaptionOrigin(uint32_t         aCaptionSide,
 244                               const nsSize&    aContainBlockSize,
 245                               const nsSize&    aInnerSize,
 246                               const nsMargin&  aInnerMargin,
 247                               const nsSize&    aCaptionSize,
 248                               nsMargin&        aCaptionMargin,
 249                               nsPoint&         aOrigin);
 250
 251   nsresult   GetInnerOrigin(uint32_t         aCaptionSide,
 252                             const nsSize&    aContainBlockSize,
 253                             const nsSize&    aCaptionSize,
 254                             const nsMargin&  aCaptionMargin,
 255                             const nsSize&    aInnerSize,
 256                             nsMargin&        aInnerMargin,
 257                             nsPoint&         aOrigin);
 258
 259   // reflow the child (caption or innertable frame)
 260   void OuterBeginReflowChild(nsPresContext*           aPresContext,
 261                              nsIFrame*                aChildFrame,
 262                              const nsHTMLReflowState& aOuterRS,
 263                              void*                    aChildRSSpace,
 264                              nscoord                  aAvailISize);
 265
 266   void OuterDoReflowChild(nsPresContext*           aPresContext,
 267                           nsIFrame*                aChildFrame,
 268                           const nsHTMLReflowState& aChildRS,
 269                           nsHTMLReflowMetrics&     aMetrics,
 270                           nsReflowStatus&          aStatus);
 271
 272   // Set the reflow metrics
 273   void UpdateReflowMetrics(uint8_t              aCaptionSide,
 274                            nsHTMLReflowMetrics& aMet,
 275                            const nsMargin&      aInnerMargin,
 276                            const nsMargin&      aCaptionMargin);
 277
 278   // Get the margin.  aMarginNoAuto is aMargin, but with auto
 279   // margins set to 0
 280   void GetChildMargin(nsPresContext*           aPresContext,
 281                       const nsHTMLReflowState& aOuterRS,
 282                       nsIFrame*                aChildFrame,
 283                       nscoord                  aAvailableWidth,
 284                       mozilla::LogicalMargin&  aMargin);
 285
 286   virtual bool IsFrameOfType(uint32_t aFlags) const MOZ_OVERRIDE
 287   {
 288     return nsContainerFrame::IsFrameOfType(aFlags &
 289                                            (~eCanContainOverflowContainers));
 290   }
 291
 292   nsTableFrame* InnerTableFrame() const {
 293     return static_cast<nsTableFrame*>(mFrames.FirstChild());
 294   }
 295
 296 private:
 297   nsFrameList   mCaptionFrames;
 298 };
 299
 300 #endif