fop 0.94

org.apache.fop.layoutmgr.table
Class PrimaryGridUnit

java.lang.Object
  extended by org.apache.fop.layoutmgr.table.GridUnit
      extended by org.apache.fop.layoutmgr.table.PrimaryGridUnit

public class PrimaryGridUnit
extends GridUnit

This class represents a primary grid unit of a spanned cell. This is the "before-start" (top-left, usually) grid unit of the span.


Field Summary
 
Fields inherited from class org.apache.fop.layoutmgr.table.GridUnit
FIRST_IN_PART, FIRST_IN_TABLE, IN_FIRST_COLUMN, IN_LAST_COLUMN, KEEP_WITH_NEXT_PENDING, KEEP_WITH_PREVIOUS_PENDING, LAST_IN_PART, LAST_IN_TABLE
 
Constructor Summary
PrimaryGridUnit(TableCell cell, TableColumn column, int startCol, int startRow)
          Creates a new primary grid unit.
 
Method Summary
 void addRow(GridUnit[] row)
           
 TableCellLayoutManager getCellLM()
           
 int getContentLength()
           
 java.util.LinkedList getElements()
           
 int getHalfMaxAfterBorderWidth()
           
 int getHalfMaxBeforeBorderWidth()
           
 int getHalfMaxBorderWidth()
           
 java.util.List getRows()
          Returns the grid units belonging to the same span as this one.
 int[] getStartEndBorderWidths()
          Returns the widths of the start- and end-borders of the span this grid unit belongs to.
 int getStartRow()
          Returns the index of the row this grid unit belongs to.
 boolean hasBPD()
           
 boolean hasSpanning()
           
 boolean isPrimary()
          Is this grid unit the before-start grid unit of the cell?
 void setContentLength(int value)
           
 void setElements(java.util.LinkedList elements)
          Sets the Knuth elements for the table cell containing this grid unit.
 java.lang.String toString()
           
 
Methods inherited from class org.apache.fop.layoutmgr.table.GridUnit
assignBorderForSeparateBorderModel, createNextRowSpanningGridUnit, getBody, getBorders, getCell, getColSpanIndex, getColumn, getFlag, getOriginalBorderInfoForCell, getPrimary, getRow, getRowSpanIndex, getStartCol, getTable, hasBorders, isEmpty, isLastGridUnitColSpan, isLastGridUnitRowSpan, resolveBorder, resolveBorder, setFlag, setRow
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PrimaryGridUnit

public PrimaryGridUnit(TableCell cell,
                       TableColumn column,
                       int startCol,
                       int startRow)
Creates a new primary grid unit.

Parameters:
cell - table cell which occupies this grid unit
column - table column this grid unit belongs to
startCol - index of the column this grid unit belongs to, zero-based
startRow - index of the row this grid unit belongs to, zero-based
Method Detail

getCellLM

public TableCellLayoutManager getCellLM()

isPrimary

public boolean isPrimary()
Description copied from class: GridUnit
Is this grid unit the before-start grid unit of the cell?

Overrides:
isPrimary in class GridUnit
Returns:
true if this grid unit is the before-start grid unit of the cell

setElements

public void setElements(java.util.LinkedList elements)
Sets the Knuth elements for the table cell containing this grid unit.

Parameters:
elements - a list of ListElement (?)

getElements

public java.util.LinkedList getElements()

getHalfMaxBeforeBorderWidth

public int getHalfMaxBeforeBorderWidth()
Returns:
half the maximum before border width of this cell.

getHalfMaxAfterBorderWidth

public int getHalfMaxAfterBorderWidth()
Returns:
half the maximum after border width of this cell.

getHalfMaxBorderWidth

public int getHalfMaxBorderWidth()
Returns:
the sum of half the maximum before and after border widths of this cell.

setContentLength

public void setContentLength(int value)
Parameters:
value - The length of the cell content to remember.

getContentLength

public int getContentLength()
Returns:
the length of the cell content.

hasBPD

public boolean hasBPD()
Returns:
true if cell/row has an explicit BPD/height

getRows

public java.util.List getRows()
Returns the grid units belonging to the same span as this one.

Returns:
a list of GridUnit[], each array corresponds to a row

addRow

public void addRow(GridUnit[] row)

getStartRow

public int getStartRow()
Returns the index of the row this grid unit belongs to.

Returns:
the index of the row this grid unit belongs to.

getStartEndBorderWidths

public int[] getStartEndBorderWidths()
Returns the widths of the start- and end-borders of the span this grid unit belongs to.

Returns:
a two-element array containing the widths of the start-border then the end-border

toString

public java.lang.String toString()
Overrides:
toString in class GridUnit
See Also:
Object.toString()

hasSpanning

public boolean hasSpanning()
Returns:
true if this cell spans over more than one grid unit.

fop 0.94

Copyright 1999-2007 The Apache Software Foundation. All Rights Reserved.