# Uses of Class
org.eclipse.birt.report.engine.api.script.ScriptException

Packages that use ScriptException
Package
Description
org.eclipse.birt.report.engine.api.script
Commonly used interfaces for the BIRT scripting environment.
org.eclipse.birt.report.engine.api.script.element
Report element representations in the BIRT scripting environment.
org.eclipse.birt.report.engine.api.script.eventadapter
This package contains adapters for the event handler interfaces in org.eclipse.birt.report.engine.api.script.eventhandler.
org.eclipse.birt.report.engine.api.script.eventhandler
This package contains event handler interfaces for the BIRT scripting environment.
org.eclipse.birt.report.engine.api.script.instance
Report element representations in the BIRT scripting environment.

## Uses of ScriptException in org.eclipse.birt.report.engine.api.script

Methods in org.eclipse.birt.report.engine.api.script that throw ScriptException
Modifier and Type
Method
Description
`String`
IColumnMetaData.`getColumnAlias(int index)`
Returns the column alias at the specified index.
`String`
IColumnMetaData.`getColumnLabel(int index)`
Gets the label or display name of the column at the specified index.
`String`
IColumnMetaData.`getColumnName(int index)`
Returns the column name at the specified index.
`String`
IColumnMetaData.`getColumnNativeTypeName(int index)`
Returns the data provider specific data type name of the specified column.
`int`
IColumnMetaData.`getColumnType(int index)`
Returns the data type of the column at the specified index.
`String`
IColumnMetaData.`getColumnTypeName(int index)`
Returns the Data Engine data type name of the column at the specified index.
`Object`
IDataSetRow.`getColumnValue(int index)`
Gets the column data by index.
`Object`
IDataSetRow.`getColumnValue(String name)`
Gets the column data by column name.
`Object`
IRowData.`getColumnValue(int index)`
Return the value of the bouding exprssion by id.
`Object`
IRowData.`getColumnValue(String name)`
Return the value of the bouding exprssion.
`Object`
IRowData.`getExpressionValue(int i)`
Deprecated.
Now do not support get expression value by index.
`Object`
IRowData.`getExpressionValue(String expression)`
Deprecated.
Return the value of the provided expression.
`boolean`
IColumnMetaData.`isComputedColumn(int index)`
Indicates whether the specified projected column is defined as a computed column.
`void`
IUpdatableDataSetRow.`setColumnValue(int index, Object value)`
Sets the column data by index.
`void`
IUpdatableDataSetRow.`setColumnValue(String name, Object value)`
Sets the column data by column name.

## Uses of ScriptException in org.eclipse.birt.report.engine.api.script.element

Methods in org.eclipse.birt.report.engine.api.script.element that throw ScriptException
Modifier and Type
Method
Description
`void`
IReportItem.`addDataBinding(IDataBinding binding)`
Add ComputedColumn.name , expression of IDataBinding are required.
`void`
IListing.`addFilterCondition(IFilterCondition condition)`
Adds filter condition.expr of IFilterCondition is required.
`void`
IColumn.`addHideRule(IHideRule rule)`
Add HideRule
`void`
IReportItem.`addHideRule(IHideRule rule)`
Add HideRule
`void`
IRow.`addHideRule(IHideRule rule)`
Add HideRule
`void`
IReportItem.`addHighlightRule(IHighlightRule rule)`
Adds high light rule.
`void`
IRow.`addHighlightRule(IHighlightRule rule)`
Adds high light rule.
`void`
IListing.`addSortCondition(ISortCondition condition)`
Adds sort condition.key of ISortCondition is required.
`String`
IHighlightRule.`getBackGroundColor()`
Returns backgroudcolor
`void`
IReportItem.`removeDataBinding(String bindingName)`
Removes special column binding
`void`
IReportItem.`removeDataBindings()`
Removes all column bindings
`void`
IListing.`removeFilterCondition(IFilterCondition condition)`
Removes filter condition.
`void`
IListing.`removeFilterConditions()`
Removes filter condition.
`void`
IColumn.`removeHideRule(IHideRule rule)`
Removes all hide rules that matches formatType.
`void`
IReportItem.`removeHideRule(IHideRule rule)`
Removes all hide rules that matches formatType.
`void`
IRow.`removeHideRule(IHideRule rule)`
Removes all hide rules that matches formatType.
`void`
IColumn.`removeHideRules()`
Removes all hide rules
`void`
IReportItem.`removeHideRules()`
Removes all hide rules
`void`
IRow.`removeHideRules()`
Removes all hide rules
`void`
IReportItem.`removeHighlightRule(IHighlightRule rule)`
Removes high light rule.
`void`
IRow.`removeHighlightRule(IHighlightRule rule)`
Removes high light rule.
`void`
IReportItem.`removeHighlightRules()`
Removes all high light rules.
`void`
IRow.`removeHighlightRules()`
Removes all high light rules.
`void`
IListing.`removeSortCondition(ISortCondition condition)`
Removes sort condition.
`void`
IListing.`removeSortConditions()`
Removes all sort conditions
`void`
IDataBinding.`setAggregateOn(String on)`
Sets aggregateOn of column binding.
`void`
IImage.`setAltText(String altText)`
Sets the alternate text of this image.
`void`
IImage.`setAltTextKey(String altTextKey)`
Sets the resource key of the alternate text of this image.
`void`
ICell.`setAntidiagonalNumber(int antidiagonalNumber)`
Sets the number of the anti-diagonal lines that are from the top-right to bottom-left.
`void`
ICell.`setAntidiagonalStyle(String antidiagonalStyle)`
Sets the style of the anti-diagonal lines that are from the top-right to bottom-left.
`void`
ICell.`setAntidiagonalThickness(String thickness)`
Sets the the thickness of the anti-diagonal that is from top-right to bottom-left corner using a dimension string with optional unit suffix such as "10" or "10pt".
`void`
IScriptStyleDesign.`setBackgroundAttachment(String value)`
Sets the background attachment.
`void`
IScriptStyleDesign.`setBackgroundColor(String color)`
Set the background color.
`void`
IHighlightRule.`setBackGroundColor(String color)`
Sets backgroudcolor
`void`
IScriptStyleDesign.`setBackgroundHeight(String value)`
Set the background height of the background image.
`void`
IScriptStyleDesign.`setBackgroundImage(String value)`
Sets the address of the background image.
`void`
IScriptStyleDesign.`setBackGroundPositionX(String x)`
Set the x position for the background.
`void`
IScriptStyleDesign.`setBackGroundPositionY(String y)`
Set the y position for the background.
`void`
IScriptStyleDesign.`setBackgroundRepeat(String value)`
Sets the repeat pattern for a background image.
`void`
IScriptStyleDesign.`setBackgroundWidth(String value)`
Set the background width of the background image.
`void`
IReportItem.`setBookmark(String value)`
Sets the bookmark of the report item.
`void`
IRow.`setBookmark(String value)`
Sets the bookmark of the row.
`void`
IScriptStyleDesign.`setBorderBottomColor(String color)`
Set the color of the bottom side of the border.
`void`
IScriptStyleDesign.`setBorderBottomStyle(String value)`
Sets the style of the bottom line of the border.
`void`
IScriptStyleDesign.`setBorderBottomWidth(String width)`
Set the width of the bottom side of the border.
`void`
IScriptStyleDesign.`setBorderLeftColor(String color)`
Set the color of the left side of the border.
`void`
IScriptStyleDesign.`setBorderLeftStyle(String value)`
Sets the style of the left line of the border.
`void`
IScriptStyleDesign.`setBorderLeftWidth(String width)`
Set the width of left side of the border.
`void`
IScriptStyleDesign.`setBorderRightColor(String color)`
Set the color of the right side of the border.
`void`
IScriptStyleDesign.`setBorderRightStyle(String value)`
Sets the style of the right line of the border.
`void`
IScriptStyleDesign.`setBorderRightWidth(String width)`
Set the width of the right side of the border.
`void`
IScriptStyleDesign.`setBorderTopColor(String color)`
Set the color of the top side of the border.
`void`
IScriptStyleDesign.`setBorderTopStyle(String value)`
Sets the style of the top line of the border.
`void`
IScriptStyleDesign.`setBorderTopWidth(String width)`
Set the width of the top side of the border.
`void`
IScriptStyleDesign.`setCanShrink(boolean value)`
Sets whether the section can shrink if the actual content is smaller than the design size.
`void`
IGrid.`setCaption(String caption)`
Sets the caption text of this grid.
`void`
ITable.`setCaption(String caption)`
Sets the caption text of this table.
`void`
IGrid.`setCaptionKey(String captionKey)`
Sets the resource key of the caption.
`void`
ITable.`setCaptionKey(String captionKey)`
Sets the resource key of the caption.
`void`
IHighlightRule.`setColor(String color)`
Sets color
`void`
IScriptStyleDesign.`setColor(String color)`
Set the font color.
`void`
ICell.`setColumn(int column)`
Sets the cell's column property.
`void`
IReportElement.`setComments(String theComments)`
Sets the comments of the report element.
`void`
ITextItem.`setContent(String value)`
Sets the text for the text element.
`void`
ITextItem.`setContentKey(String resourceKey)`
Sets the resource key of the text for the item.
`void`
IDynamicText.`setContentType(String contentType)`
Sets the expression that defines the text type this multi-line data item holds.
`void`
ITextItem.`setContentType(String contentType)`
Sets the content type of this text item.
`void`
IReportItem.`setCurrentView(IDesignElement viewElement)`
Sets the view to be used.
`void`
IReportElement.`setCustomXml(String customXml)`
Sets the custom XML.
`void`
IDataBinding.`setDataType(String dataType)`
Sets data type of column binding
`void`
IHighlightRule.`setDateTimeFormat(String format)`
Sets date time format
`void`
IScriptStyleDesign.`setDateTimeFormat(String pattern)`
Sets the pattern of a date time format for a highlight rule.
`void`
IScriptStyleDesign.`setDateTimeFormatCategory(String pattern)`
Sets the category of a number format.
`void`
ICell.`setDiagonalNumber(int diagonalNumber)`
Sets the number of the diagonal lines that are from top-left to bottom-right corner.
`void`
ICell.`setDiagonalStyle(String lineStyle)`
Sets the style of the diagonal line that is from top-left to bottom-right corner.
`void`
ICell.`setDiagonalThickness(String thickness)`
Sets the the thickness of the diagonal that is from top-left to bottom-right corner using a dimension string with optional unit suffix such as "10" or "10pt".
`void`
ISortCondition.`setDirection(String direction)`
Sets sort direction.
`void`
IScriptStyleDesign.`setDisplay(String value)`
Sets the value that specifies if a top-level element should be a block or in-line element.
`void`
IReportDesign.`setDisplayName(String displayName)`
Sets the display name.
`void`
IReportElement.`setDisplayName(String displayName)`
Sets the display name.
`void`
IReportDesign.`setDisplayNameKey(String displayNameKey)`
Sets the resource key of the display name.
`void`
IReportElement.`setDisplayNameKey(String displayNameKey)`
Sets the resource key of the display name.
`void`
ICell.`setDrop(String drop)`
Sets the cell's drop property.
`void`
IFilterCondition.`setExpr(String expr)`
Sets expr
`void`
IDataBinding.`setExpression(String expression)`
Sets expression of column binding.
`void`
IDataBinding.`setExpressionType(String type)`
Sets the expression type of the column binding.
`void`
IImage.`setFile(String file)`
Sets the image file.
`void`
IScriptStyleDesign.`setFontFamily(String fontFamily)`
Set the font family.
`void`
IScriptStyleDesign.`setFontSize(String fontSize)`
Set the font size.
`void`
IHighlightRule.`setFontStyle(String style)`
Sets font style
`void`
IScriptStyleDesign.`setFontStyle(String fontStyle)`
Sets the style of the font.
`void`
IScriptStyleDesign.`setFontVariant(String fontVariant)`
Sets the variant of the font.
`void`
IHighlightRule.`setFontWeight(String weight)`
Sets font weight.
`void`
IScriptStyleDesign.`setFontWeight(String fontWeight)`
Sets the weight of the font.
`void`
IHideRule.`setFormat(String format)`
Sets format
`void`
IAction.`setFormatType(String type)`
Sets the format type of the action.
`void`
IReportItem.`setHeight(double dimension)`
Sets the item's height to a value in default units.
`void`
IReportItem.`setHeight(String dimension)`
Sets the item's height using a dimension string with optional unit suffix such as "10" or "10pt".
`void`
IDataItem.`setHelpText(String value)`
Sets the help text of this data item.
`void`
IImage.`setHelpText(String helpText)`
Sets the help text of this image item.
`void`
ILabel.`setHelpText(String text)`
Sets the help text of this label item.
`void`
IDataItem.`setHelpTextKey(String value)`
Sets the resource key of the help text of this data item.
`void`
IImage.`setHelpTextKey(String helpTextKey)`
Sets the resource key of help text of this image item.
`void`
ILabel.`setHelpTextKey(String resourceKey)`
Sets the help text key of this label item.
`void`
IGroup.`setHideDetail(boolean hideDetail)`
Sets hide detail
`void`
IImage.`setImageName(String name)`
Sets the embedded image name that this image refers, if the image source type is `IMAGE_REF_TYPE_EMBED`.
`void`
IGroup.`setInterval(String interval)`
Returns the interval of this group.
`void`
IGroup.`setIntervalBase(String intervalBase)`
Sets the base of the interval property of this group.IntervalBase, in conjunction with Interval and IntervalRange, determines how data is divided into groups.
`void`
IGroup.`setIntervalRange(double intervalRange)`
Returns the interval range of this group.
`void`
ISortCondition.`setKey(String key)`
Sets sort key.
`void`
IGroup.`setKeyExpr(String expr)`
Sets the group expression.
`void`
IScriptStyleDesign.`setLetterSpacing(String spacing)`
Set the spacing between individual letters.
`void`
IScriptStyleDesign.`setLineHeight(String height)`
Set the height of a line.
`void`
IAction.`setLinkType(String type)`
Sets the link type of the action.
`void`
IScriptStyleDesign.`setMarginBottom(String margin)`
Set the margin of the bottom side.
`void`
IScriptStyleDesign.`setMarginLeft(String margin)`
Set the margin of the left side.
`void`
IScriptStyleDesign.`setMarginRight(String margin)`
Set the margin of the right side.
`void`
IScriptStyleDesign.`setMarginTop(String margin)`
Set the margin of the top side.
`void`
IScriptStyleDesign.`setMasterPage(String value)`
Sets the master page name on which to start this section.
`void`
IDataBinding.`setName(String name)`
Sets the name of column binding.
`void`
IGroup.`setName(String name)`
Sets the group name.
`void`
IReportElement.`setName(String name)`
Sets the name of this element.
`void`
IDesignElement.`setNamedExpression(String name, String exp)`
Sets name of user property defined in this element.
`void`
IScriptStyleDesign.`setNumberFormat(String pattern)`
Sets the pattern of a number format.
`void`
IScriptStyleDesign.`setNumberFormatCategory(String category)`
Sets the category of a number format for a highlight rule.
`void`
IFilterCondition.`setOperator(String operator)`
Sets operator
`void`
IHighlightRule.`setOperator(String operator)`
Sets Operator
`void`
IScriptStyleDesign.`setOrphans(String value)`
Sets the orphans property.
`void`
IScriptStyleDesign.`setPaddingBottom(String padding)`
Set the padding of the bottom side.
`void`
IScriptStyleDesign.`setPaddingLeft(String padding)`
Set the padding of the left side.
`void`
IScriptStyleDesign.`setPaddingRight(String padding)`
Set the padding of the right side.
`void`
IScriptStyleDesign.`setPaddingTop(String padding)`
Set the padding of the top side.
`void`
IGroup.`setPageBreakAfter(String value)`
Sets the value for break after property.
`void`
IScriptStyleDesign.`setPageBreakAfter(String value)`
Sets the page break after property for block-level elements.
`void`
IGroup.`setPageBreakBefore(String value)`
Sets the value for break before property.
`void`
IScriptStyleDesign.`setPageBreakBefore(String value)`
Sets the page break before property for block-level elements.
`void`
IGroup.`setPageBreakInside(String value)`
Sets the value for the page-break-inside.
`void`
IScriptStyleDesign.`setPageBreakInside(String value)`
Sets the page break inside property for block-level elements.
`void`
IDataSet.`setPrivateDriverProperty(String name, String value)`
Sets a private driver property value with the given name and value.
`void`
IDataSource.`setPrivateDriverProperty(String name, String value)`
Sets a private driver property value with the given name and value.
`void`
IDataSet.`setQueryText(String query)`
Sets the query text.
`void`
ITable.`setRepeatHeader(boolean value)`
Sets whether to repeat the headings at the top of each page.
`void`
IAction.`setReportName(String reportName)`
Sets target report name for a drill-though link.
`void`
IDataItem.`setResultSetColumn(String columnName)`
Sets the value of the column name property.
`void`
IImage.`setScale(double scale)`
Sets the image scale property.
`void`
IScriptStyleDesign.`setShowIfBlank(boolean value)`
Sets whether to show this frame even if it is empty, or all its data elements are empty.
`void`
IImage.`setSize(String size)`
Sets the image size property.
`void`
IGroup.`setSortDirection(String direction)`
Sets the sort direction of this group.
`void`
IGroup.`setSortType(String sortType)`
Sets the sort type, which indicates the way of sorting
`void`
IImage.`setSource(String source)`
Returns the image source type.
`void`
IHighlightRule.`setStringFormat(String format)`
Sets string format
`void`
IScriptStyleDesign.`setStringFormat(String pattern)`
Sets the pattern of a string format.
`void`
IScriptStyleDesign.`setStringFormatCategory(String pattern)`
Sets the category of a string format.
`void`
IGrid.`setSummary(String summary)`
Sets the summary of this grid.
`void`
ITable.`setSummary(String summary)`
Sets the summary of this table.
`void`
IAction.`setTargetBookmark(String bookmark)`
Sets the target bookmark defined within this same report, or another report for a drill-though link.
`void`
IAction.`setTargetWindow(String window)`
Sets the target window of the action.
`void`
IHighlightRule.`setTestExpression(String expression)`
Sets Test Expression
`void`
ILabel.`setText(String text)`
Sets the text of the label.
`void`
IScriptStyleDesign.`setTextAlign(String value)`
Sets the text align for block-level elements.
`void`
IScriptStyleDesign.`setTextIndent(String indent)`
Set the text indent.
`void`
ILabel.`setTextKey(String resourceKey)`
Sets the resource key of the static text of the label.
`void`
IScriptStyleDesign.`setTextLineThrough(String value)`
Sets one 'text-decoration' property to set line-through styles.
`void`
IScriptStyleDesign.`setTextOverline(String value)`
Sets one 'text-decoration' property to set overline styles.
`void`
IScriptStyleDesign.`setTextTransform(String value)`
Sets the value used to transform the text.
`void`
IScriptStyleDesign.`setTextUnderline(String value)`
Sets one 'text-decoration' property to set underline styles.
`void`
IReportDesign.`setTheme(String theme)`
Sets the theme for this report design.
`void`
IGroup.`setTocExpression(String expression)`
Sets a table of contents entry for this item.
`void`
IReportItem.`setTocExpression(String expression)`
Sets a table of contents entry for this item.
`void`
IImage.`setTypeExpression(String value)`
Sets the type expression value.
`void`
IAction.`setURI(String uri)`
Sets the hyperlink of this action.
`void`
IImage.`setURI(String uri)`
Deprecated.
Sets the image uri property.
`void`
IImage.`setURL(String url)`
Sets the image url.
`void`
IDesignElement.`setUserProperty(String name, Object value, String type)`
Sets user property defined in this element.
`void`
IDesignElement.`setUserProperty(String name, String value)`
Sets user property defined in this element.
`void`
IFilterCondition.`setValue1(String value1)`
Sets value1
`void`
IHighlightRule.`setValue1(String value1)`
Sets Value1
`void`
IFilterCondition.`setValue2(String value2)`
Sets value2
`void`
IHighlightRule.`setValue2(String value2)`
Sets Value2
`void`
IDynamicText.`setValueExpr(String expr)`
Sets the expression that gives the text that this multi-line data item displays.
`void`
IHideRule.`setValueExpr(String valueExpr)`
Sets value expression.
`void`
IImage.`setValueExpression(String value)`
Sets the value expression value.
`void`
IScriptStyleDesign.`setVerticalAlign(String value)`
Sets the value of the vertical align property for inline elements.
`void`
IScriptStyleDesign.`setWhiteSpace(String value)`
Sets the white space property for block elements.
`void`
IScriptStyleDesign.`setWidows(String value)`
Sets the widows property.
`void`
IReportItem.`setWidth(double dimension)`
Sets the item's width to a value in default units.
`void`
IReportItem.`setWidth(String dimension)`
Sets the item's width using a dimension string with optional unit suffix such as "10" or "10pt".
`void`
IScriptStyleDesign.`setWordSpacing(String spacing)`
Set the spacing between two words.
`void`
IReportItem.`setX(double dimension)`
Sets the item's x position to a value in default units.
`void`
IReportItem.`setX(String dimension)`
Sets the item's x position using a dimension string with optional unit suffix such as "10" or "10pt".
`void`
IReportItem.`setY(double dimension)`
Sets the item's y position to a value in default units.
`void`
IReportItem.`setY(String dimension)`
Sets the item's y position using a dimension string with optional unit suffix such as "10" or "10pt".

## Uses of ScriptException in org.eclipse.birt.report.engine.api.script.eventadapter

Methods in org.eclipse.birt.report.engine.api.script.eventadapter that throw ScriptException
Modifier and Type
Method
Description
`void`
DataSetEventAdapter.`afterClose(IReportContext reportContext)`
`void`
DataSourceEventAdapter.`afterClose(IReportContext reportContext)`
`void`
ReportEventAdapter.`afterFactory(IReportContext reportContext)`
`void`
DataSetEventAdapter.`afterOpen(IDataSetInstance dataSet, IReportContext reportContext)`
`void`
DataSourceEventAdapter.`afterOpen(IDataSourceInstance dataSource, IReportContext reportContext)`
`void`
ReportEventAdapter.`afterRender(IReportContext reportContext)`
`void`
DataSetEventAdapter.`beforeClose(IDataSetInstance dataSet, IReportContext reportContext)`
`void`
DataSourceEventAdapter.`beforeClose(IDataSourceInstance dataSource, IReportContext reportContext)`
`void`
ReportEventAdapter.`beforeFactory(IReportDesign report, IReportContext reportContext)`
`void`
DataSetEventAdapter.`beforeOpen(IDataSetInstance dataSet, IReportContext reportContext)`
`void`
DataSourceEventAdapter.`beforeOpen(IDataSourceInstance dataSource, IReportContext reportContext)`
`void`
ReportEventAdapter.`beforeRender(IReportContext reportContext)`
`void`
ScriptedDataSetEventAdapter.`close(IDataSetInstance dataSet)`
`void`
ScriptedDataSourceEventAdapter.`close(IDataSourceInstance dataSource)`
`boolean`
ScriptedDataSetEventAdapter.`describe(IDataSetInstance dataSet, IScriptedDataSetMetaData metaData)`
`boolean`
ScriptedDataSetEventAdapter.`fetch(IDataSetInstance dataSet, IUpdatableDataSetRow row)`
`void`
ReportEventAdapter.`initialize(IReportContext reportContext)`
`void`
AutoTextEventAdapter.`onCreate(IAutoTextInstance autoTextInstance, IReportContext reportContext)`
`void`
CellEventAdapter.`onCreate(ICellInstance cellInstance, IReportContext reportContext)`
`void`
DataItemEventAdapter.`onCreate(IDataItemInstance data, IReportContext reportContext)`
`void`
DynamicTextEventAdapter.`onCreate(IDynamicTextInstance text, IReportContext reportContext)`
`void`
GridEventAdapter.`onCreate(IGridInstance grid, IReportContext reportContext)`
`void`
ImageEventAdapter.`onCreate(IImageInstance image, IReportContext reportContext)`
`void`
LabelEventAdapter.`onCreate(ILabelInstance label, IReportContext reportContext)`
`void`
ListEventAdapter.`onCreate(IListInstance list, IReportContext reportContext)`
`void`
ListGroupEventAdapter.`onCreate(IReportElementInstance listGroup, IReportContext context)`
`void`
RowEventAdapter.`onCreate(IRowInstance rowInstance, IReportContext reportContext)`
`void`
TableEventAdapter.`onCreate(ITableInstance table, IReportContext reportContext)`
`void`
TableGroupEventAdapter.`onCreate(IReportElementInstance tableGroup, IReportContext context)`
`void`
TextItemEventAdapter.`onCreate(ITextItemInstance text, IReportContext reportContext)`
`void`
DataSetEventAdapter.`onFetch(IDataSetInstance dataSet, IDataSetRow row, IReportContext reportContext)`
`void`
AutoTextEventAdapter.`onPageBreak(IAutoTextInstance autoTextInstance, IReportContext reportContext)`
`void`
CellEventAdapter.`onPageBreak(ICellInstance cellInstance, IReportContext reportContext)`
`void`
DataItemEventAdapter.`onPageBreak(IDataItemInstance data, IReportContext reportContext)`
`void`
DynamicTextEventAdapter.`onPageBreak(IDynamicTextInstance text, IReportContext reportContext)`
`void`
GridEventAdapter.`onPageBreak(IGridInstance grid, IReportContext reportContext)`
`void`
ImageEventAdapter.`onPageBreak(IImageInstance image, IReportContext reportContext)`
`void`
LabelEventAdapter.`onPageBreak(ILabelInstance label, IReportContext reportContext)`
`void`
ListEventAdapter.`onPageBreak(IListInstance list, IReportContext reportContext)`
`void`
ListGroupEventAdapter.`onPageBreak(IReportElementInstance listGroup, IReportContext context)`
`void`
RowEventAdapter.`onPageBreak(IRowInstance rowInstance, IReportContext reportContext)`
`void`
TableEventAdapter.`onPageBreak(ITableInstance table, IReportContext reportContext)`
`void`
TableGroupEventAdapter.`onPageBreak(IReportElementInstance tableGroup, IReportContext context)`
`void`
TextItemEventAdapter.`onPageBreak(ITextItemInstance text, IReportContext reportContext)`
`void`
MasterPageEventAdapter.`onPageEnd(IPageInstance page, IReportContext reportContext)`
`void`
ReportEventAdapter.`onPageEnd(IPageInstance page, IReportContext reportContext)`
`void`
MasterPageEventAdapter.`onPageStart(IPageInstance page, IReportContext reportContext)`
`void`
ReportEventAdapter.`onPageStart(IPageInstance page, IReportContext reportContext)`
`void`
AutoTextEventAdapter.`onPrepare(IAutoText autoText, IReportContext reportContext)`
`void`
CellEventAdapter.`onPrepare(ICell cell, IReportContext reportContext)`
`void`
DataItemEventAdapter.`onPrepare(IDataItem dataItemHandle, IReportContext reportContext)`
`void`
DynamicTextEventAdapter.`onPrepare(IDynamicText textData, IReportContext reportContext)`
`void`
GridEventAdapter.`onPrepare(IGrid grid, IReportContext reportContext)`
`void`
ImageEventAdapter.`onPrepare(IImage imageHandle, IReportContext reportContext)`
`void`
LabelEventAdapter.`onPrepare(ILabel labelHandle, IReportContext reportContext)`
`void`
ListEventAdapter.`onPrepare(IList listHandle, IReportContext reportContext)`
`void`
ListGroupEventAdapter.`onPrepare(IListGroup listGroup, IReportContext context)`
`void`
ReportEventAdapter.`onPrepare(IReportContext reportContext)`
`void`
RowEventAdapter.`onPrepare(IRow rowHandle, IReportContext reportContext)`
`void`
TableEventAdapter.`onPrepare(ITable tableHandle, IReportContext reportContext)`
`void`
TableGroupEventAdapter.`onPrepare(ITableGroup tableGroup, IReportContext context)`
`void`
TextItemEventAdapter.`onPrepare(ITextItem textItemHandle, IReportContext reportContext)`
`void`
AutoTextEventAdapter.`onRender(IAutoTextInstance autoTextInstance, IReportContext reportContext)`
`void`
CellEventAdapter.`onRender(ICellInstance cellInstance, IReportContext reportContext)`
`void`
DataItemEventAdapter.`onRender(IDataItemInstance data, IReportContext reportContext)`
`void`
DynamicTextEventAdapter.`onRender(IDynamicTextInstance text, IReportContext reportContext)`
`void`
GridEventAdapter.`onRender(IGridInstance grid, IReportContext reportContext)`
`void`
ImageEventAdapter.`onRender(IImageInstance image, IReportContext reportContext)`
`void`
LabelEventAdapter.`onRender(ILabelInstance label, IReportContext reportContext)`
`void`
ListEventAdapter.`onRender(IListInstance list, IReportContext reportContext)`
`void`
ListGroupEventAdapter.`onRender(IReportElementInstance listGroup, IReportContext context)`
`void`
RowEventAdapter.`onRender(IRowInstance rowInstance, IReportContext reportContext)`
`void`
TableEventAdapter.`onRender(ITableInstance table, IReportContext reportContext)`
`void`
TableGroupEventAdapter.`onRender(IReportElementInstance tableGroup, IReportContext context)`
`void`
TextItemEventAdapter.`onRender(ITextItemInstance text, IReportContext reportContext)`
`void`
ScriptedDataSetEventAdapter.`open(IDataSetInstance dataSet)`
`void`
ScriptedDataSourceEventAdapter.`open(IDataSourceInstance dataSource)`

## Uses of ScriptException in org.eclipse.birt.report.engine.api.script.eventhandler

Methods in org.eclipse.birt.report.engine.api.script.eventhandler that throw ScriptException
Modifier and Type
Method
Description
`void`
IDataSetEventHandler.`afterClose(IReportContext reportContext)`
Handle the afterClose event
`void`
IDataSourceEventHandler.`afterClose(IReportContext reportContext)`
Handle the afterClose event
`void`
IReportEventHandler.`afterFactory(IReportContext reportContext)`
Handle the afterFactory event
`void`
IDataSetEventHandler.`afterOpen(IDataSetInstance dataSet, IReportContext reportContext)`
Handle the afterOpen event
`void`
IDataSourceEventHandler.`afterOpen(IDataSourceInstance dataSource, IReportContext reportContext)`
Handle the afterOpen event
`void`
IReportEventHandler.`afterRender(IReportContext reportContext)`
Handle the afterRender event
`void`
IDataSetEventHandler.`beforeClose(IDataSetInstance dataSet, IReportContext reportContext)`
Handle the beforeClose event
`void`
IDataSourceEventHandler.`beforeClose(IDataSourceInstance dataSource, IReportContext reportContext)`
Handle the beforeClose event
`void`
IReportEventHandler.`beforeFactory(IReportDesign report, IReportContext reportContext)`
Handle the beforeFactory event
`void`
IDataSetEventHandler.`beforeOpen(IDataSetInstance dataSet, IReportContext reportContext)`
Handle the beforeOpen event
`void`
IDataSourceEventHandler.`beforeOpen(IDataSourceInstance dataSource, IReportContext reportContext)`
Handle the beforeOpen event
`void`
IReportEventHandler.`beforeRender(IReportContext reportContext)`
Handle the beforeRender event
`void`
IScriptedDataSetEventHandler.`close(IDataSetInstance dataSet)`
Handle the close event
`void`
IScriptedDataSourceEventHandler.`close(IDataSourceInstance dataSource)`
Handle the close event
`boolean`
IScriptedDataSetEventHandler.`describe(IDataSetInstance dataSet, IScriptedDataSetMetaData metaData)`
Method for Script Data Set to return dynamically generated data set metadata.
`boolean`
IScriptedDataSetEventHandler.`fetch(IDataSetInstance dataSet, IUpdatableDataSetRow row)`
Handle the fetch event.
`void`
IReportEventHandler.`initialize(IReportContext reportContext)`
Handle the initialize event
`void`
IAutoTextEventHandler.`onCreate(IAutoTextInstance autoTextInstance, IReportContext reportContext)`
Handle the onCreate event
`void`
ICellEventHandler.`onCreate(ICellInstance cellInstance, IReportContext reportContext)`
Handle the onCreate event
`void`
IDataItemEventHandler.`onCreate(IDataItemInstance data, IReportContext reportContext)`
Handle the onCreate event
`void`
IDynamicTextEventHandler.`onCreate(IDynamicTextInstance text, IReportContext reportContext)`
Handle the onCreate event
`void`
IGridEventHandler.`onCreate(IGridInstance grid, IReportContext reportContext)`
Handle the onCreate event
`void`
IImageEventHandler.`onCreate(IImageInstance image, IReportContext reportContext)`
Handle the onCreate event
`void`
ILabelEventHandler.`onCreate(ILabelInstance label, IReportContext reportContext)`
Handle the onCreate event
`void`
IListEventHandler.`onCreate(IListInstance list, IReportContext reportContext)`
Handle the onCreate event
`void`
IListGroupEventHandler.`onCreate(IReportElementInstance listGroup, IReportContext context)`
`void`
IRowEventHandler.`onCreate(IRowInstance rowInstance, IReportContext reportContext)`
Handle the onCreate event
`void`
ITableEventHandler.`onCreate(ITableInstance table, IReportContext reportContext)`
Handle the onCreate event
`void`
ITableGroupEventHandler.`onCreate(IReportElementInstance tableGroup, IReportContext context)`
`void`
ITextItemEventHandler.`onCreate(ITextItemInstance text, IReportContext reportContext)`
Handle the onCreate event
`void`
IDataSetEventHandler.`onFetch(IDataSetInstance dataSet, IDataSetRow row, IReportContext reportContext)`
Handle the onFetch event
`void`
IAutoTextEventHandler.`onPageBreak(IAutoTextInstance autoTextInstance, IReportContext reportContext)`
Handle the onPageBreak event
`void`
ICellEventHandler.`onPageBreak(ICellInstance cellInstance, IReportContext reportContext)`
Handle the onPageBreak event
`void`
IDataItemEventHandler.`onPageBreak(IDataItemInstance data, IReportContext reportContext)`
Handle the onPageBreak event
`void`
IDynamicTextEventHandler.`onPageBreak(IDynamicTextInstance text, IReportContext reportContext)`
Handle the onPageBreak event
`void`
IGridEventHandler.`onPageBreak(IGridInstance grid, IReportContext reportContext)`
Handle the onPageBreak event
`void`
IImageEventHandler.`onPageBreak(IImageInstance image, IReportContext reportContext)`
Handle the onPageBreak event
`void`
ILabelEventHandler.`onPageBreak(ILabelInstance label, IReportContext reportContext)`
Handle the onPageBreak event
`void`
IListEventHandler.`onPageBreak(IListInstance list, IReportContext reportContext)`
Handle the onPageBreak event
`void`
IListGroupEventHandler.`onPageBreak(IReportElementInstance listGroup, IReportContext context)`
`void`
IRowEventHandler.`onPageBreak(IRowInstance rowInstance, IReportContext reportContext)`
Handle the onPageBreak event
`void`
ITableEventHandler.`onPageBreak(ITableInstance table, IReportContext reportContext)`
Handle the onPageBreak event
`void`
ITableGroupEventHandler.`onPageBreak(IReportElementInstance tableGroup, IReportContext context)`
`void`
ITextItemEventHandler.`onPageBreak(ITextItemInstance text, IReportContext reportContext)`
Handle the onPageBreak event
`void`
IMasterPageEventHandler.`onPageEnd(IPageInstance page, IReportContext reportContext)`
Handle the onPageEnd event
`void`
IReportEventHandler.`onPageEnd(IPageInstance page, IReportContext reportContext)`
Handle the onPageEnd event
`void`
IMasterPageEventHandler.`onPageStart(IPageInstance page, IReportContext reportContext)`
Handle the onPageStart event
`void`
IReportEventHandler.`onPageStart(IPageInstance page, IReportContext reportContext)`
Handle the onPageStart event
`void`
IAutoTextEventHandler.`onPrepare(IAutoText autoText, IReportContext reportContext)`
Handle the onPrepare event
`void`
ICellEventHandler.`onPrepare(ICell cell, IReportContext reportContext)`
Handle the onPrepare event
`void`
IDataItemEventHandler.`onPrepare(IDataItem dataItemHandle, IReportContext reportContext)`
Handle the onPrepare event
`void`
IDynamicTextEventHandler.`onPrepare(IDynamicText textData, IReportContext reportContext)`
Handle the onPrepare event
`void`
IGridEventHandler.`onPrepare(IGrid grid, IReportContext reportContext)`
Handle the onPrepare event
`void`
IImageEventHandler.`onPrepare(IImage imageHandle, IReportContext reportContext)`
Handle the onPrepare event
`void`
ILabelEventHandler.`onPrepare(ILabel labelHandle, IReportContext reportContext)`
Handle the onPrepare event
`void`
IListEventHandler.`onPrepare(IList listHandle, IReportContext reportContext)`
Handle the onPrepare event
`void`
IListGroupEventHandler.`onPrepare(IListGroup listGroup, IReportContext context)`
`void`
IReportEventHandler.`onPrepare(IReportContext reportContext)`
Handle the onPrepare event
`void`
IRowEventHandler.`onPrepare(IRow rowHandle, IReportContext reportContext)`
Handle the onPrepare event
`void`
ITableEventHandler.`onPrepare(ITable tableHandle, IReportContext reportContext)`
Handle the onPrepare event
`void`
ITableGroupEventHandler.`onPrepare(ITableGroup tableGroup, IReportContext context)`
`void`
ITextItemEventHandler.`onPrepare(ITextItem textItemHandle, IReportContext reportContext)`
Handle the onPrepare event
`void`
IAutoTextEventHandler.`onRender(IAutoTextInstance autoTextInstance, IReportContext reportContext)`
Handle the onRender event
`void`
ICellEventHandler.`onRender(ICellInstance cellInstance, IReportContext reportContext)`
Handle the onRender event
`void`
IDataItemEventHandler.`onRender(IDataItemInstance data, IReportContext reportContext)`
Handle the onRender event
`void`
IDynamicTextEventHandler.`onRender(IDynamicTextInstance text, IReportContext reportContext)`
Handle the onRender event
`void`
IGridEventHandler.`onRender(IGridInstance grid, IReportContext reportContext)`
Handle the onRender event
`void`
IImageEventHandler.`onRender(IImageInstance image, IReportContext reportContext)`
Handle the onRender event
`void`
ILabelEventHandler.`onRender(ILabelInstance label, IReportContext reportContext)`
Handle the onRender event
`void`
IListEventHandler.`onRender(IListInstance list, IReportContext reportContext)`
Handle the onRender event
`void`
IListGroupEventHandler.`onRender(IReportElementInstance listGroup, IReportContext context)`
`void`
IRowEventHandler.`onRender(IRowInstance rowInstance, IReportContext reportContext)`
Handle the onRender event
`void`
ITableEventHandler.`onRender(ITableInstance table, IReportContext reportContext)`
Handle the onRender event
`void`
ITableGroupEventHandler.`onRender(IReportElementInstance tableGroup, IReportContext context)`
`void`
ITextItemEventHandler.`onRender(ITextItemInstance text, IReportContext reportContext)`
Handle the onRender event
`void`
IScriptedDataSetEventHandler.`open(IDataSetInstance dataSet)`
Handle the open event
`void`
IScriptedDataSourceEventHandler.`open(IDataSourceInstance dataSource)`
Handle the open event

## Uses of ScriptException in org.eclipse.birt.report.engine.api.script.instance

Methods in org.eclipse.birt.report.engine.api.script.instance that throw ScriptException
Modifier and Type
Method
Description
`IColumnMetaData`
IDataSetInstance.`getColumnMetaData()`
Gets the current data set's column metadata, if available.
`Object`
IDataSetInstance.`getInputParameterValue(String paramName)`
Gets the current value of the named data set input parameter.
`IReportItemInstance[]`
IPageInstance.`getInstancesByElementId(int elementId)`
`IReportItemInstance[]`
IPageInstance.`getInstancesByElementName(String elementName)`
`Object`
IDataSetInstance.`getOutputParameterValue(String paramName)`
Gets the current value of the named data set output parameter.
`IReportElementInstance`
IReportElementInstance.`getParent()`
Get the parent (container) of this element
`String`
IDataSetInstance.`getQueryText()`
Gets the query text of the data set.
`IRowData`
IReportElementInstance.`getRowData()`
Get the row data used to create the instance.
`void`
IScriptStyle.`setBackgroundHeight(String value)`
Set the background height of the background image.
`void`
IScriptStyle.`setBackgroundPositionX(String x)`
Set the X (horizontal) position of the background image
`void`
IScriptStyle.`setBackgroundPositionY(String y)`
Set the Y (vertical) position of the background image
`void`
IScriptStyle.`setBackgroundWidth(String value)`
Set the background width of the background image.
`void`
IDataSetInstance.`setInputParameterValue(String paramName, Object paramValue)`
Sets the value of the named data set input parameter.
`void`
IDataSetInstance.`setOutputParameterValue(String paramName, Object paramValue)`
Sets the value of the named data set output parameter.
`void`
IDataSetInstance.`setQueryText(String queryText)`
Sets the query text of the data set.
`void`
IScriptStyle.`setTextHyperlinkStyle(String hyperlinkStyle)`
Set the text hyperlink style
`void`
IScriptStyle.`setTextLineThrough(String through)`
Set the text line through
`void`
IScriptStyle.`setTextOverline(String overline)`
Set the text overline
`void`
IScriptStyle.`setTextUnderline(String underline)`
Set the text underline
`void`
IReportElementInstance.`setUserPropertyValue(String name, Object value)`
Set the value of a user property