|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.model.api.elements.table.LayoutTable
public class LayoutTable
The table model for the content layout.
Nested Class Summary | |
---|---|
protected class |
LayoutTable.OverlappedArea
Represents an overlapped area of the cell element in the table. |
Field Summary | |
---|---|
protected int |
nextCellId
The unique index for each cell. |
protected org.eclipse.birt.report.model.elements.TableItem |
table
The table element that the layout belongs to. |
Constructor Summary | |
---|---|
LayoutTable(org.eclipse.birt.report.model.elements.TableItem table,
org.eclipse.birt.report.model.core.Module module)
Constructs a table with the given numbers of rows and columns. |
Method Summary | |
---|---|
protected void |
addOverlappedCell(org.eclipse.birt.report.model.elements.Cell cell,
LayoutSlot slot,
int rowPosn,
int colPosn,
int rowSpanOffset,
int colSpanOffset)
Update an overlapped area of a cell element into the list. |
CellHandle |
getCell(int rowPosn,
int colPosn)
Returns the cell at the given position. |
CellHandle |
getCell(int slotId,
int rowId,
int colId)
Return a cell element with the given poistion. |
CellHandle |
getCell(int groupLevel,
int slotId,
int rowId,
int colId)
Return a cell element with the given poistion. |
int |
getColumnCount()
Returns the column count in the table. |
int |
getColumnPos(int slotId,
int rowId,
org.eclipse.birt.report.model.elements.Cell cell)
Return the column position for a given cell. |
int |
getColumnPos(int groupLevel,
int slotId,
int rowId,
org.eclipse.birt.report.model.elements.Cell cell)
Return the column position for a given cell. |
LayoutSlot |
getDetail()
Returns the detail slot. |
LayoutSlot |
getFooter()
Returns the footer slot. |
protected int |
getGroupCount()
Returns the count of the group in the table. |
protected org.eclipse.birt.report.model.api.elements.table.LayoutGroupBand |
getGroupFooters()
Returns the group footer slot. |
protected org.eclipse.birt.report.model.api.elements.table.LayoutGroupBand |
getGroupHeaders()
Returns the group header slot. |
LayoutSlot |
getHeader()
Returns the header slot. |
LayoutGroup |
getLayoutGroup(int groupLevel)
Returns the layout group with the given group level. |
LayoutSlot |
getLayoutSlot(int slotId)
Returns the slot with the given slot index. |
LayoutSlot |
getLayoutSlot(int groupLevel,
int slotId)
Returns the slot with the given slot index and the group level. |
java.lang.String |
getLayoutString()
Returns the string that shows the layout. |
protected org.eclipse.birt.report.model.core.Module |
getModule()
Returns the module where the table element belongs to. |
protected int |
getNextCellId()
Returns the next available cell index. |
RowHandle |
getRow(int rowPosn)
Return the row handle with the given row position. |
TableHandle |
getTable()
Returns the handle of the table that the layout belongs to. |
protected boolean |
hasOverlappedArea()
Checks whether the table has overlapped areas. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected int nextCellId
protected org.eclipse.birt.report.model.elements.TableItem table
Constructor Detail |
---|
public LayoutTable(org.eclipse.birt.report.model.elements.TableItem table, org.eclipse.birt.report.model.core.Module module)
table
- the table elementmodule
- the moduleMethod Detail |
---|
public TableHandle getTable()
public int getColumnCount()
public CellHandle getCell(int slotId, int rowId, int colId)
slotId
- the slot index,rowId
- the 1-based row indexcolId
- the 1-based column index
null
.public CellHandle getCell(int groupLevel, int slotId, int rowId, int colId)
groupLevel
- the 1-based group levelslotId
- the slot index,rowId
- the 1-based row indexcolId
- the 1-based column index
null
.public RowHandle getRow(int rowPosn)
rowPosn
is regardless of the slot.
rowPosn
- the 1-based row position
public CellHandle getCell(int rowPosn, int colPosn)
CellHandle
is an element that
occupies the given position in the layout rendering.
For example, if a cell occupies the position (1, 1) and (1, 2), return
CellHandle
s with parameters (1, 1) and (1, 2) are same.
rowPosn
- the 1-based row positioncolPosn
- the 1-based column position
public int getColumnPos(int slotId, int rowId, org.eclipse.birt.report.model.elements.Cell cell)
slotId
- the index of the slot where the cell residesrowId
- the 0-based row indexcell
- the cell element to find
public int getColumnPos(int groupLevel, int slotId, int rowId, org.eclipse.birt.report.model.elements.Cell cell)
groupLevel
- the group levelslotId
- the index of the slot where the cell residesrowId
- the 0-based row indexcell
- the cell element to find
public LayoutSlot getLayoutSlot(int slotId)
slotId
- the slot index
public LayoutSlot getLayoutSlot(int groupLevel, int slotId)
groupLevel
- the 1-based group levelslotId
- the slot index
public LayoutSlot getHeader()
public LayoutSlot getDetail()
public LayoutSlot getFooter()
public LayoutGroup getLayoutGroup(int groupLevel)
groupLevel
- the 1-based group level
protected int getGroupCount()
protected org.eclipse.birt.report.model.api.elements.table.LayoutGroupBand getGroupHeaders()
protected org.eclipse.birt.report.model.api.elements.table.LayoutGroupBand getGroupFooters()
public java.lang.String getLayoutString()
protected int getNextCellId()
protected org.eclipse.birt.report.model.core.Module getModule()
protected void addOverlappedCell(org.eclipse.birt.report.model.elements.Cell cell, LayoutSlot slot, int rowPosn, int colPosn, int rowSpanOffset, int colSpanOffset)
LayoutCell
.
cell
- the cell elementslot
- the layout slot where the cell residesrowPosn
- the 1-based row position in the slostcolPosn
- the 1-based column position in the slostrowSpanOffset
- the row span offset of the overlapped areacolSpanOffset
- the column span offset of the overlapped areaprotected boolean hasOverlappedArea()
true
if not have. Otherwise false
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |