Class LayoutCell
java.lang.Object
org.eclipse.birt.report.model.api.elements.table.LayoutCell
The minimal item in the table.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
CELL is emptystatic final int
CELL is used, it contains a CELLstatic final int
CELL is used because of "drop" properties of a cell element.protected static final LayoutCell
The empty cell. -
Method Summary
Modifier and TypeMethodDescriptiongetCell()
Return the corresponding handle of the cell element.protected int
Returns the unique index of the cell element.protected CellHandle
Return the corresponding handle of the cell element regardless of the position where the cell starts.protected int
Returns the column position of the current layout cell.int
Returns the 0-based offset of the column span.protected org.eclipse.birt.report.model.elements.Cell
Returns the corresponding cell element.protected LayoutRow
Returns the layout row that this layout cell resides.Returns the string that shows the layout.int
Returns the row number for the drop span.int
Returns the 0-based offset of the row span.protected boolean
Checks whether the current position is where the cell element begins to span.protected boolean
Checks whether "drop" value is "all" or "detail".boolean
Tests whether the atomic cell is occupied because of "drop" properties of cells.boolean
Checks whether the drop is effectual.protected boolean
Checks whether there is any element in the cell element.boolean
isUsed()
Tests whether the atomic cell is occupied by any cell.protected void
setEffectualDrop
(boolean isEffectualDrop) Sets whether the drop is effectual.protected void
setRowSpanForDrop
(int rowSpanForDrop) Sets the row number for the drop span.
-
Field Details
-
EMPTY_CELL
The empty cell. -
CELL_EMPTY
public static final int CELL_EMPTYCELL is empty- See Also:
-
CELL_USED
public static final int CELL_USEDCELL is used, it contains a CELL- See Also:
-
DROP_SPANNED
public static final int DROP_SPANNEDCELL is used because of "drop" properties of a cell element.- See Also:
-
-
Method Details
-
isUsed
public boolean isUsed()Tests whether the atomic cell is occupied by any cell.- Returns:
true
if the atomic cell is occupied by any cell. Otherwisefalse
.
-
isDropSpanned
public boolean isDropSpanned()Tests whether the atomic cell is occupied because of "drop" properties of cells.- Returns:
true
if the atomic cell is occupied. Otherwisefalse
.
-
getContent
protected org.eclipse.birt.report.model.elements.Cell getContent()Returns the corresponding cell element.- Returns:
- the corresponding cell element
-
getColumnSpanOffset
public int getColumnSpanOffset()Returns the 0-based offset of the column span.- Returns:
- the 0-based offset of the column span
-
getRowSpanOffset
public int getRowSpanOffset()Returns the 0-based offset of the row span.- Returns:
- the 0-based offset of the row span
-
getLayoutString
Returns the string that shows the layout. Mainly for the debug.- Returns:
- the string that shows the layout
-
isEffectualDrop
public boolean isEffectualDrop()Checks whether the drop is effectual.- Returns:
true
if the drop is effectual. Otherwisefalse
.
-
isCellStartPosition
protected boolean isCellStartPosition()Checks whether the current position is where the cell element begins to span.- Returns:
true
if it is. Otherwisefalse
.
-
getCell
Return the corresponding handle of the cell element.- Returns:
- the corresponding handle of the cell element.
-
getCellRegardlessStartPosition
Return the corresponding handle of the cell element regardless of the position where the cell starts.- Returns:
- the corresponding handle of the cell element.
-
getCellId
protected int getCellId()Returns the unique index of the cell element.- Returns:
- the unique index
-
isEmptyContent
protected boolean isEmptyContent()Checks whether there is any element in the cell element.- Returns:
true
if there is one or more element in the cell. Otherwisefalse
.
-
isDropSet
protected boolean isDropSet()Checks whether "drop" value is "all" or "detail".- Returns:
true
if "drop" value is "all" or "detail". Otherwisefalse
.
-
getRowSpanForDrop
public int getRowSpanForDrop()Returns the row number for the drop span.- Returns:
- the row number
-
setRowSpanForDrop
protected void setRowSpanForDrop(int rowSpanForDrop) Sets the row number for the drop span.- Parameters:
rowSpanForDrop
- the row number
-
setEffectualDrop
protected void setEffectualDrop(boolean isEffectualDrop) Sets whether the drop is effectual.- Parameters:
isEffectualDrop
-true
if the drop is effectual. Otherwisefalse
.
-
getColumnPosn
protected int getColumnPosn()Returns the column position of the current layout cell.- Returns:
- 1-based column position
-
getLayoutContainer
Returns the layout row that this layout cell resides.- Returns:
- the layout row
-