org.eclipse.birt.report.model.api.simpleapi
Interface ICell

All Superinterfaces:

IDesignElement

public interface ICell
extends IDesignElement

Represents a the design of a Cell in the scripting environment

Method Summary

int	getColumn() Returns the cell's column property.
int	getColumnSpan() Returns the cell's column span.
java.lang.String	getDrop() Returns the cell's drop property.
java.lang.String	getHeight() Returns the cell's height.
int	getRowSpan() Returns the cell's row span.
java.lang.String	getWidth() Returns the cell's width.
void	setColumn(int column) Sets the cell's column property.
void	setDrop(java.lang.String drop) Sets the cell's drop property.

Methods inherited from interface org.eclipse.birt.report.model.api.simpleapi.IDesignElement

getNamedExpression, getParent, getQualifiedName, getReport, getStyle, getUserProperty, setNamedExpression, setUserProperty, setUserProperty

Method Detail

getColumnSpan

int getColumnSpan()

Returns the cell's column span. This is the number of table or grid columns occupied by this cell.

Returns:

the column span

getRowSpan

int getRowSpan()

Returns the cell's row span. This is the number of table or grid rows occupied by this cell.

Returns:

the row span

getDrop

java.lang.String getDrop()

Returns the cell's drop property. This is how the cell should expand to fill the entire table or group. This property is valid only for cells within a table; but not for cells within a grid.

Returns:

the string value of the drop property

See Also:

setDrop(String)

setDrop

void setDrop(java.lang.String drop)
             throws SemanticException

Sets the cell's drop property. The input value is defined in DesignChoiceConstants and can be one of:

• DROP_TYPE_NONE
• DROP_TYPE_DETAIL
• DROP_TYPE_ALL

Note that This property is valid only for cells within a table; but not for cells within a grid.

Parameters:

drop - the string value of the drop property

Throws:

SemanticException - if the property is locked or the input value is not one of the above.

See Also:

getDrop()

getColumn

int getColumn()

Returns the cell's column property. The return value gives the column in which the cell starts. Columns are numbered from 1.

Returns:

the column index, starting from 1.

setColumn

void setColumn(int column)
               throws SemanticException

Sets the cell's column property. The input value gives the column in which the cell starts. Columns are numbered from 1.

Parameters:

column - the column index, starting from 1.

Throws:

SemanticException - if this property is locked.

getHeight

java.lang.String getHeight()

Returns the cell's height.

Returns:

the cell's height

getWidth

java.lang.String getWidth()

Returns the cell's width.

Returns:

the cell's width