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

All Superinterfaces:

IDesignElement, IReportElement

public interface IRow

extends IReportElement

Represents a row in the scripting environment

Method Summary

java.lang.String	getBookmark() Returns the bookmark of the row.
java.lang.String	getHeight() Gets a handle to deal with the row's height.
void	setBookmark(java.lang.String value) Sets the bookmark of the row.

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

getHeight

public java.lang.String getHeight()

Gets a handle to deal with the row's height.

Returns:

the row's height.

getBookmark

public java.lang.String getBookmark()

Returns the bookmark of the row. The bookmark value is evaluated as an expression.

Returns:

the book mark as a string

setBookmark

public void setBookmark(java.lang.String value)
                 throws ScriptException

Sets the bookmark of the row. The bookmark value is evaluated as an expression. If you want the bookmark to be the string "bookmark", you need to use setBookmark("\"bookmark\""); If bookmark is a JavaScript variable, use setBookmark("bookmark");

Parameters:

value - the bookmark expression

Throws:

ScriptException - if the property is locked.