org.eclipse.birt.report.engine.api.script.element
Interface ICell

All Superinterfaces:
IDesignElement, IReportElement

public interface ICell
extends IReportElement

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 setColumnSpan(int span)
          Sets the cell's column span.
 void setDrop(java.lang.String drop)
          Sets the cell's drop property.
 void setRowSpan(int span)
          Sets the cell's row span.
 
Methods inherited from interface org.eclipse.birt.report.engine.api.script.element.IReportElement
getComments, getCustomXml, getDisplayName, getDisplayNameKey, setComments, setCustomXml, setDisplayName, setDisplayNameKey
 
Methods inherited from interface org.eclipse.birt.report.engine.api.script.element.IDesignElement
getName, getNamedExpression, getParent, getQualifiedName, getStyle, getUserProperty, setName, setNamedExpression, setUserProperty, setUserProperty
 

Method Detail

getColumnSpan

public 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

setColumnSpan

public void setColumnSpan(int span)
                   throws ScriptException
Sets the cell's column span. This is the number of table or grid columns occupied by this cell.

Parameters:
span - the column span
Throws:
ScriptException - if this property is locked.

getRowSpan

public 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

setRowSpan

public void setRowSpan(int span)
                throws ScriptException
Sets the cell's row span. This is the number of table or grid rows occupied by this cell.

Parameters:
span - the row span
Throws:
ScriptException - if this property is locked.

getDrop

public 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

public void setDrop(java.lang.String drop)
             throws ScriptException
Sets the cell's drop property. The input value is defined in DesignChoiceConstants and can be one of:

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:
ScriptException - if the property is locked or the input value is not one of the above.
See Also:
getDrop()

getColumn

public 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

public void setColumn(int column)
               throws ScriptException
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:
ScriptException - if this property is locked.

getHeight

public java.lang.String getHeight()
Returns the cell's height.

Returns:
the cell's height

getWidth

public java.lang.String getWidth()
Returns the cell's width.

Returns:
the cell's width


Copyright © 2005 Actuate Corp. All rights reserved.