You are viewing a plain text version of this content. The canonical link for it is here.
Posted to fop-commits@xmlgraphics.apache.org by ar...@apache.org on 2001/01/30 03:31:11 UTC

cvs commit: xml-fop/docs/design/contrib/layout/org/apache/fop/layout BodyAreaContainer.html

arved       01/01/29 18:31:11

  Added:       docs/design/contrib/layout/org/apache/fop/layout
                        BodyAreaContainer.html
  Log:
  Layout HTML
  
  Revision  Changes    Path
  1.1                  xml-fop/docs/design/contrib/layout/org/apache/fop/layout/BodyAreaContainer.html
  
  Index: BodyAreaContainer.html
  ===================================================================
  <HTML><HEAD><!-- Generated by Together onThu Jan 25 10:46:24 EST 2001 --><TITLE></TITLE><LINK REL="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"></HEAD><BODY BGCOLOR="white"><!-- ========== START OF NAVBAR ========== --><TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"><TR><TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1"><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"><TR ALIGN="center" VALIGN="top"><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "../../../../overview-summary.html"><FONT ID="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD><TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> &nbsp;<FONT ID="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "class-use/BodyAreaContainer.html"><FONT ID="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "../../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "../../../../help-doc.html"><FONT ID="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD></TR></TABLE><TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM></TD></EM></TD></TR><TR><TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">&nbsp;<A HREF= "../../../../org/apache/fop/layout/BlockArea.html"><B>PREV CLASS</B></A>&nbsp;&nbsp;<A HREF= "../../../../org/apache/fop/layout/BodyRegionArea.html"><B>NEXT CLASS</B></A></FONT></TD><TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">  <A HREF= "../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;&nbsp;<A HREF= "BodyAreaContainer.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD></TR><TR><TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">SUMMARY:&nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF= "#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF= "#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF= "#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF= "#method_detail">METHOD</A></FONT></TD></TR></TABLE><!-- ========== END OF NAVBAR ========== --><HR><H2><FONT SIZE="-1">org.apache.fop.layout</FONT><BR>Class BodyAreaContainer</H2><PRE><A HREF= "../../../../org/apache/fop/layout/Box.html">org.apache.fop.layout.Box</A>
    |
    +--<A HREF= "../../../../org/apache/fop/layout/Area.html">org.apache.fop.layout.Area</A>
          |
          +--<B>org.apache.fop.layout.BodyAreaContainer</B>
  </PRE><HR><DL><DT>public class <B>BodyAreaContainer</B><DT>extends <A HREF= "../../../../org/apache/fop/layout/Area.html">Area</A></DL><P><HR><A NAME= "fields_inherited_from_class_org.apache.fop.layout.Area"></A><TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"><TR BGCOLOR="#EEEEFF" ID="TableSubHeadingColor"><TD><B>Fields inherited from class org.apache.fop.layout.<A HREF= "../../../../org/apache/fop/layout/Area.html">Area</A><B></TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD><CODE><A HREF= "../../../../org/apache/fop/layout/Area.html#borderColorBottom">borderColorBottom</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#borderColorLeft">borderColorLeft</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#borderColorRight">borderColorRight</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#borderColorTop">borderColorTop</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#borderStyleBottom">borderStyleBottom</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#borderStyleLeft">borderStyleLeft</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#borderStyleRight">borderStyleRight</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#borderStyleTop">borderStyleTop</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#borderWidthBottom">borderWidthBottom</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#borderWidthLeft">borderWidthLeft</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#borderWidthRight">borderWidthRight</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#borderWidthTop">borderWidthTop</A></CODE></TD></TR></TABLE><P><!--  =========== CONSTRUCTOR SUMMARY ===========  --><A NAME= "constructor_summary"></A><TABLE BORDER="1"  CELLPADDING="3" CELLSPACING="0" WIDTH="100%"><TR BGCOLOR="#CCCCFF"  ID="TableHeadingColor"> <TD COLSPAN=2><FONT SIZE= "+2"><B>Constructor Summary</B></FONT></TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD><CODE><B><A HREF= "../../../../org/apache/fop/layout/BodyAreaContainer.html#BodyAreaContainer(org.apache.fop.layout.FontState, int, int, int, int, int, int, int)">BodyAreaContainer</A></B>(<A HREF= "../../../../org/apache/fop/layout/FontState.html">FontState</A> fontState, int xPosition, int yPosition, int allocationWidth, int maxHeight, int position, int columnCount, int columnGap)</CODE><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD></TR></TABLE><BR><!--  =========== METHOD SUMMARY ===========  --><A NAME= "method_summary"></A><TABLE BORDER="1"  CELLPADDING="3" CELLSPACING="0" WIDTH="100%"><TR BGCOLOR="#CCCCFF"  ID="TableHeadingColor"> <TD COLSPAN=2><FONT SIZE= "+2"><B>Method Summary</B></FONT></TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE>&nbsp;void</CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/layout/BodyAreaContainer.html#adjustFootnoteArea()">adjustFootnoteArea</A></B>()</CODE><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE>&nbsp;<A HREF= "../../../../org/apache/fop/layout/AreaContainer.html">AreaContainer</A></CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/layout/BodyAreaContainer.html#getBeforeFloatReferenceArea()">getBeforeFloatReferenceArea</A></B>()</CODE><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE>&nbsp;<A HREF= "../../../../org/apache/fop/layout/AreaContainer.html">AreaContainer</A></CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/layout/BodyAreaContainer.html#getCurrentColumnArea()">getCurrentColumnArea</A></B>()</CODE><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE>&nbsp;<A HREF= "../../../../org/apache/fop/layout/AreaContainer.html">AreaContainer</A></CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/layout/BodyAreaContainer.html#getFootnoteReferenceArea()">getFootnoteReferenceArea</A></B>()</CODE><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE>&nbsp;int</CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/layout/BodyAreaContainer.html#getFootnoteState()">getFootnoteState</A></B>()</CODE><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE>&nbsp;IDReferences</CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/layout/BodyAreaContainer.html#getIDReferences()">getIDReferences</A></B>()</CODE><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE>&nbsp;<A HREF= "../../../../org/apache/fop/layout/AreaContainer.html">AreaContainer</A></CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/layout/BodyAreaContainer.html#getMainReferenceArea()">getMainReferenceArea</A></B>()</CODE><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE>&nbsp;<A HREF= "../../../../org/apache/fop/layout/AreaContainer.html">AreaContainer</A></CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/layout/BodyAreaContainer.html#getNextArea(org.apache.fop.fo.FObj)">getNextArea</A></B>(FObj fo)</CODE><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE>&nbsp;int</CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/layout/BodyAreaContainer.html#getPosition()">getPosition</A></B>()</CODE><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE>&nbsp;int</CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/layout/BodyAreaContainer.html#getRemainingHeight()">getRemainingHeight</A></B>()</CODE><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determine remaining height for new span area.</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE>&nbsp;int</CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/layout/BodyAreaContainer.html#getXPosition()">getXPosition</A></B>()</CODE><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE>&nbsp;int</CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/layout/BodyAreaContainer.html#getYPosition()">getYPosition</A></B>()</CODE><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE>&nbsp;boolean</CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/layout/BodyAreaContainer.html#isBalancingRequired(org.apache.fop.fo.FObj)">isBalancingRequired</A></B>(FObj fo)</CODE><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This almost does what getNewArea() does, without actually
  returning an area.</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE>&nbsp;boolean</CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/layout/BodyAreaContainer.html#isLastColumn()">isLastColumn</A></B>()</CODE><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Used in Flow when layout returns incomplete.</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE>&nbsp;boolean</CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/layout/BodyAreaContainer.html#isNewSpanArea()">isNewSpanArea</A></B>()</CODE><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This variable is unset by getNextArea(), is set by addSpanArea(),
  and <i>may</i> be set by resetSpanArea().</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE>&nbsp;boolean</CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/layout/BodyAreaContainer.html#needsFootnoteAdjusting()">needsFootnoteAdjusting</A></B>()</CODE><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE>&nbsp;void</CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/layout/BodyAreaContainer.html#render(org.apache.fop.render.Renderer)">render</A></B>(Renderer renderer)</CODE><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE>&nbsp;void</CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/layout/BodyAreaContainer.html#resetSpanArea()">resetSpanArea</A></B>()</CODE><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This is where the balancing algorithm lives, or gets called.</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE>&nbsp;void</CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/layout/BodyAreaContainer.html#setIDReferences(org.apache.fop.datatypes.IDReferences)">setIDReferences</A></B>(IDReferences idReferences)</CODE><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE>&nbsp;void</CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/layout/BodyAreaContainer.html#setXPosition(int)">setXPosition</A></B>(int value)</CODE><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="20%"><FONT SIZE="-1"><CODE>&nbsp;void</CODE></FONT></TD><TD><CODE><B><A HREF= "../../../../org/apache/fop/layout/BodyAreaContainer.html#setYPosition(int)">setYPosition</A></B>(int value)</CODE><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD></TR></TABLE><BR><A NAME= "methods_inherited_from_class_org.apache.fop.layout.Area"></A><TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"><TR BGCOLOR="#EEEEFF" ID="TableSubHeadingColor"><TD><B>Methods inherited from class org.apache.fop.layout.<A HREF= "../../../../org/apache/fop/layout/Area.html">Area</A><B></TD></TR><TR BGCOLOR="white" ID="TableRowColor"><TD><CODE><A HREF= "../../../../org/apache/fop/layout/Area.html#addChild(org.apache.fop.layout.Box)">addChild</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#addChildAtStart(org.apache.fop.layout.Box)">addChildAtStart</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#addDisplaySpace(int)">addDisplaySpace</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#end()">end</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#getAbsoluteHeight()">getAbsoluteHeight</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#getAllocationWidth()">getAllocationWidth</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#getBackgroundColor()">getBackgroundColor</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#getChildren()">getChildren</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#getContentHeight()">getContentHeight</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#getContentWidth()">getContentWidth</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#getFontInfo()">getFontInfo</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#getFontState()">getFontState</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#getHeight()">getHeight</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#getMaxHeight()">getMaxHeight</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#getPaddingBottom()">getPaddingBottom</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#getPaddingLeft()">getPaddingLeft</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#getPaddingRight()">getPaddingRight</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#getPaddingTop()">getPaddingTop</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#getPage()">getPage</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#getParent()">getParent</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#getTableCellXOffset()">getTableCellXOffset</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#increaseAbsoluteHeight(int)">increaseAbsoluteHeight</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#increaseHeight(int)">increaseHeight</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#remove()">remove</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#removeChild(org.apache.fop.layout.Area)">removeChild</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#removeChild(org.apache.fop.layout.DisplaySpace)">removeChild</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#setAbsoluteHeight(int)">setAbsoluteHeight</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#setAllocationWidth(int)">setAllocationWidth</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#setBackgroundColor(org.apache.fop.datatypes.ColorType)">setBackgroundColor</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#setBorderColor(org.apache.fop.datatypes.ColorType, org.apache.fop.datatypes.ColorType, org.apache.fop.datatypes.ColorType, org.apache.fop.datatypes.ColorType)">setBorderColor</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#setBorderStyle(int, int, int, int)">setBorderStyle</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#setBorderWidth(int, int, int, int)">setBorderWidth</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#setHeight(int)">setHeight</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#setMaxHeight(int)">setMaxHeight</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#setPadding(int, int, int, int)">setPadding</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#setPage(org.apache.fop.layout.Page)">setPage</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#setTableCellXOffset(int)">setTableCellXOffset</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#spaceLeft()">spaceLeft</A>, <A HREF= "../../../../org/apache/fop/layout/Area.html#start()">start</A></CODE></TD></TR></TABLE><P><!--  =========== CONSTRUCTOR DETAIL ===========  --><A NAME= "constructor_detail"></A><TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"><TR BGCOLOR="#CCCCFF" ID="TableHeadingColor"><TD COLSPAN=1><FONT SIZE="+2"><B>Constructor Detail</B></FONT></TD></TR></TABLE><BR><A NAME= "BodyAreaContainer(org.apache.fop.layout.FontState, int, int, int, int, int, int, int)"><H3>BodyAreaContainer</H3></A><PRE>public <B>BodyAreaContainer</B>(<A HREF= "../../../../org/apache/fop/layout/FontState.html">FontState</A> fontState, int xPosition, int yPosition, int allocationWidth, int maxHeight, int position, int columnCount, int columnGap)</PRE><DL><DD></DL><!--  =========== METHOD DETAIL ===========  --><A NAME= "method_detail"></A><TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"><TR BGCOLOR="#CCCCFF" ID="TableHeadingColor"><TD COLSPAN=1><FONT SIZE="+2"><B>Method Detail</B></FONT></TD></TR></TABLE><BR><A NAME= "adjustFootnoteArea()"><H3>adjustFootnoteArea</H3></A><PRE>public void <B>adjustFootnoteArea</B>()</PRE><DL><DD></DL><HR><A NAME= "getBeforeFloatReferenceArea()"><H3>getBeforeFloatReferenceArea</H3></A><PRE>public <A HREF= "../../../../org/apache/fop/layout/AreaContainer.html">AreaContainer</A> <B>getBeforeFloatReferenceArea</B>()</PRE><DL><DD></DL><HR><A NAME= "getCurrentColumnArea()"><H3>getCurrentColumnArea</H3></A><PRE>public <A HREF= "../../../../org/apache/fop/layout/AreaContainer.html">AreaContainer</A> <B>getCurrentColumnArea</B>()</PRE><DL><DD></DL><HR><A NAME= "getFootnoteReferenceArea()"><H3>getFootnoteReferenceArea</H3></A><PRE>public <A HREF= "../../../../org/apache/fop/layout/AreaContainer.html">AreaContainer</A> <B>getFootnoteReferenceArea</B>()</PRE><DL><DD></DL><HR><A NAME= "getFootnoteState()"><H3>getFootnoteState</H3></A><PRE>public int <B>getFootnoteState</B>()</PRE><DL><DD></DL><HR><A NAME= "getIDReferences()"><H3>getIDReferences</H3></A><PRE>public IDReferences <B>getIDReferences</B>()</PRE><DL><DD></DL><HR><A NAME= "getMainReferenceArea()"><H3>getMainReferenceArea</H3></A><PRE>public <A HREF= "../../../../org/apache/fop/layout/AreaContainer.html">AreaContainer</A> <B>getMainReferenceArea</B>()</PRE><DL><DD></DL><HR><A NAME= "getNextArea(org.apache.fop.fo.FObj)"><H3>getNextArea</H3></A><PRE>public <A HREF= "../../../../org/apache/fop/layout/AreaContainer.html">AreaContainer</A> <B>getNextArea</B>(FObj fo)<BR>                           throws org.apache.fop.apps.FOPException</A></PRE><DL><DD></DL><HR><A NAME= "getPosition()"><H3>getPosition</H3></A><PRE>public int <B>getPosition</B>()</PRE><DL><DD></DL><HR><A NAME= "getRemainingHeight()"><H3>getRemainingHeight</H3></A><PRE>public int <B>getRemainingHeight</B>()</PRE><DL><DD>Determine remaining height for new span area. Needs to be
  modified for footnote and before-float reference areas when
  those are supported.<DD><DL><DT><B>returns </B>int The remaining available height in millipoints.</DL></DD></DL><HR><A NAME= "getXPosition()"><H3>getXPosition</H3></A><PRE>public int <B>getXPosition</B>()</PRE><DL><DD></DL><HR><A NAME= "getYPosition()"><H3>getYPosition</H3></A><PRE>public int <B>getYPosition</B>()</PRE><DL><DD></DL><HR><A NAME= "isBalancingRequired(org.apache.fop.fo.FObj)"><H3>isBalancingRequired</H3></A><PRE>public boolean <B>isBalancingRequired</B>(FObj fo)</PRE><DL><DD>This almost does what getNewArea() does, without actually
  returning an area. These 2 methods can be reworked.<DD><DL><DT><B>Parameters:</B><DD>fo - The next formatting object<DT><B>returns </B>boolean True if we need to balance.</DL></DD></DL><HR><A NAME= "isLastColumn()"><H3>isLastColumn</H3></A><PRE>public boolean <B>isLastColumn</B>()</PRE><DL><DD>Used in Flow when layout returns incomplete.<DD><DL><DT><B>returns </B>boolean Is this the last column in this span?</DL></DD></DL><HR><A NAME= "isNewSpanArea()"><H3>isNewSpanArea</H3></A><PRE>public boolean <B>isNewSpanArea</B>()</PRE><DL><DD>This variable is unset by getNextArea(), is set by addSpanArea(),
  and <i>may</i> be set by resetSpanArea().<DD><DL><DT><B>returns </B>boolean Is the span area new or not?</DL></DD></DL><HR><A NAME= "needsFootnoteAdjusting()"><H3>needsFootnoteAdjusting</H3></A><PRE>public boolean <B>needsFootnoteAdjusting</B>()</PRE><DL><DD></DL><HR><A NAME= "render(org.apache.fop.render.Renderer)"><H3>render</H3></A><PRE>public void <B>render</B>(Renderer renderer)</PRE><DL><DD></DL><HR><A NAME= "resetSpanArea()"><H3>resetSpanArea</H3></A><PRE>public void <B>resetSpanArea</B>()</PRE><DL><DD>This is where the balancing algorithm lives, or gets called.
  Right now it's primitive: get the total content height in all
  columns, divide by the column count, and add a heuristic
  safety factor.
  Then the previous (unbalanced) span area is removed, and a new
  one added with the computed max height.</DL><HR><A NAME= "setIDReferences(org.apache.fop.datatypes.IDReferences)"><H3>setIDReferences</H3></A><PRE>public void <B>setIDReferences</B>(IDReferences idReferences)</PRE><DL><DD></DL><HR><A NAME= "setXPosition(int)"><H3>setXPosition</H3></A><PRE>public void <B>setXPosition</B>(int value)</PRE><DL><DD></DL><HR><A NAME= "setYPosition(int)"><H3>setYPosition</H3></A><PRE>public void <B>setYPosition</B>(int value)</PRE><DL><DD></DL><P><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0"><TR BGCOLOR="#CCCCFF" ID="TableHeadingColor"><TD><FONT SIZE= "+0"><B>Association Links</B></FONT></TD></TR></TABLE><BR>to <B>Class </B><A HREF= "../../../../org/apache/fop/layout/AreaContainer.html">org.apache.fop.layout.AreaContainer</A><DL></DL><P>to <B>Class </B><A HREF= "../../../../org/apache/fop/layout/AreaContainer.html">org.apache.fop.layout.AreaContainer</A><DL></DL><P>to <B>Class </B><A HREF= "../../../../org/apache/fop/layout/AreaContainer.html">org.apache.fop.layout.AreaContainer</A><DL></DL><P>to <B>Class </B>org.apache.fop.fo.FObj<DL></DL><HR><!-- ========== START OF NAVBAR ========== --><TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"><TR><TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1"><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"><TR ALIGN="center" VALIGN="top"><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "../../../../overview-summary.html"><FONT ID="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD><TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> &nbsp;<FONT ID="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "class-use/BodyAreaContainer.html"><FONT ID="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "../../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD><TD BGCOLOR="#EEEEFF" ID="NavBarCell1"><A HREF= "../../../../help-doc.html"><FONT ID="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD></TR></TABLE><TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM></TD></EM></TD></TR><TR><TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">&nbsp;<A HREF= "../../../../org/apache/fop/layout/BlockArea.html"><B>PREV CLASS</B></A>&nbsp;&nbsp;<A HREF= "../../../../org/apache/fop/layout/BodyRegionArea.html"><B>NEXT CLASS</B></A></FONT></TD><TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">  <A HREF= "../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;&nbsp;<A HREF= "BodyAreaContainer.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD></TR><TR><TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">SUMMARY:&nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF= "#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF= "#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF= "#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF= "#method_detail">METHOD</A></FONT></TD></TR></TABLE><!-- ========== END OF NAVBAR ========== --><HR></BODY></HTML>