# Uses of Class
org.eclipse.birt.report.model.api.activity.SemanticException

Packages that use SemanticException
Package
Description
org.eclipse.birt.report.model.api
Tool-writer's interface for the BIRT design model (also known as the "Design Engine.")
org.eclipse.birt.report.model.api.command
Provides events when some command operations modify the state of the Design Engine.
org.eclipse.birt.report.model.api.elements
Constants definition for the pre-defined choices and report elements and items.
org.eclipse.birt.report.model.api.elements.structures
Defines the structure types in Model system.
org.eclipse.birt.report.model.api.extension
Defines the fundamental interfaces for those extensions from the reportitem extension point.
org.eclipse.birt.report.model.api.metadata
Defines the elements, properties, types, structures and slots in the Report Object Model.
org.eclipse.birt.report.model.api.olap
org.eclipse.birt.report.model.api.simpleapi
Report element representations in the BIRT simple API environment.
org.eclipse.birt.report.model.api.util
Utility classes.
org.eclipse.birt.report.model.api.validators
Provides the validation classes for semantic check on multiple properties.

## Uses of SemanticException in org.eclipse.birt.report.model.api

Methods in org.eclipse.birt.report.model.api that throw SemanticException
Modifier and Type
Method
Description
`void`
DesignElementHandle.`add(String propName, DesignElementHandle content)`
Adds a report item to the property with the given element handle.
`void`
DesignElementHandle.`add(String propName, DesignElementHandle content, int newPos)`
Adds a report item to this property at the given position.
`void`
PropertyHandleImpl.`add(DesignElementHandle content)`
Adds a report item to the property with the given element handle.
`void`
PropertyHandleImpl.`add(DesignElementHandle content, int newPos)`
Adds a report item to this property at the given position.
`void`
ComputedColumnHandle.`addAggregateOn(String aggreValue)`
Adds an aggregate level to the list.
`AggregationArgumentHandle`
ComputedColumnHandle.`addArgument(AggregationArgument argument)`
Adds an arguments to list.
`CalculationArgumentHandle`
ComputedColumnHandle.`addCalculationArgument(CalculationArgument argument)`
Adds a calculation argument to list.
`ComputedColumnHandle`
GroupHandle.`addColumnBinding(ComputedColumn addColumn, boolean inForce)`
Deprecated.
since BIRT 2.1 RC2
`ComputedColumnHandle`
ReportItemHandleImpl.`addColumnBinding(ComputedColumn addColumn, boolean inForce)`
Adds a bound column to the list.
`ComputedColumnHandle`
ScalarParameterHandle.`addColumnBinding(ComputedColumn addColumn, boolean inForce)`
Adds a bound column to the list.
`void`
ModuleHandleImpl.`addConfigVariable(ConfigVariable configVar)`
Adds a new config variable.
`void`
AbstractThemeHandle.`addCss(String fileName)`
Deprecated.
`void`
AbstractThemeHandle.`addCss(CssStyleSheetHandle sheetHandle)`
(non-Javadoc)
`void`
AbstractThemeHandle.`addCss(IncludedCssStyleSheet cssStruct)`
(non-Javadoc)
`void`
AbstractThemeHandle.`addCssByProerties(String fileName, String externalCssURI, boolean isUseExternalCss)`
Add css based on properties
`void`
JointDataSetHandle.`addDataSet(String dataSetName)`
Adds a data set into this joint data set by name.
`void`
DataSetHandle.`addFilter(FilterCondition fc)`
Adds the filter condition.
`void`
ModuleHandleImpl.`addImage(EmbeddedImage image)`
Adds a new embedded image.
`final void`
ModuleHandleImpl.`addIncludeScript(IncludeScript includeScript)`
Adds include script.
`void`
DerivedDataSetHandle.`addInputDataSets(String dataSetName)`
Inserts a data set with the specified name into this derived data set.
`void`
MemberHandle.`addItem(Object item)`
`void`
PropertyHandleImpl.`addItem(Object item)`
`abstract void`
SimpleValueHandle.`addItem(Object item)`
Adds an item to the end of a list property.
`StructureHandle`
SimpleValueHandle.`addItem(IStructure item)`
Adds an item to the end of a list property or member.
`DimensionJoinConditionHandle`
DimensionConditionHandle.`addJoinCondition(DimensionJoinCondition joinCondition)`
Gets the dimension join condition handle.
`void`
ActionHandle.`addParamBinding(ParamBinding paramBinding)`
Add a new parameter binding to the action.
`void`
AccessControlHandle.`addRole(String role)`
Deprecated.
Adds the given role to the list.
`final void`
ModuleHandleImpl.`addScriptLib(ScriptLib scriptLib)`
Add script lib
`void`
ActionHandle.`addSearch(SearchKey key)`
Add a new search key to the action.
`TOCHandle`
GroupHandle.`addTOC(String expression)`
Adds toc structure.
`TOCHandle`
GroupHandle.`addTOC(TOC toc)`
Adds toc structure.
`TOCHandle`
ReportItemHandleImpl.`addTOC(String expression)`
Adds toc structure.
`TOCHandle`
ReportItemHandleImpl.`addTOC(TOC toc)`
Adds toc structure.
`void`
AccessControlHandle.`addUserName(String userName)`
Deprecated.
Adds the given user name to the list.
`void`
ValueAccessControlHandle.`addValue(String value)`
Deprecated.
Adds the given value to the list.
`void`
MultiViewsHandle.`addView(DesignElementHandle viewElement)`
Adds a new element as the view.
`void`
ReportItemHandleImpl.`addView(DesignElementHandle viewElement)`
Adds a new element as the view.
`void`
FreeFormHandle.`bringForward(ReportItemHandle content)`
Increases the z-index of the given element by 1.
`void`
FreeFormHandle.`bringToFront(ReportItemHandle content)`
Increases the z-index of the given element so that the element will have the maximal z-index value.
`boolean`
AbstractThemeHandle.`canRenameCss(IncludedCssStyleSheetHandle handle, String newFileName)`
Deprecated.
`boolean`
AbstractThemeHandle.`canRenameCssByProperties(IncludedCssStyleSheetHandle handle, String newFileName, String externalCssURI, boolean useExternalCss)`
Verify if the css could be renamed by property
`void`
ComputedColumnHandle.`clearAggregateOnList()`
Clears the aggregate on list.
`void`
DesignElementHandle.`clearAllProperties()`
Clears values of all properties.
`void`
ComputedColumnHandle.`clearArgumentList()`
Clears the argument list.
`void`
DesignElementHandle.`clearContents(int slotId)`
Clears all the content within the given slot.
`void`
EmptyGroupElementHandle.`clearLocalProperties()`
`abstract void`
GroupElementHandle.`clearLocalProperties()`
Clears values of all common properties(except the extends property) for the given collection of elements.
`void`
SimpleGroupElementHandle.`clearLocalProperties()`
`void`
EmptyGroupElementHandle.`clearLocalPropertiesIncludeSubElement()`
`abstract void`
GroupElementHandle.`clearLocalPropertiesIncludeSubElement()`
Clears values of all common properties(except the extends property) for the given collection of elements.
`void`
SimpleGroupElementHandle.`clearLocalPropertiesIncludeSubElement()`
`void`
DesignElementHandle.`clearProperty(String propName)`
Clears the value of a property.
`final void`
GroupElementHandle.`clearProperty(String propName)`
Clears the value of a property on the given collection of elements if the property is a common property shared by each element.
`void`
GroupPropertyHandle.`clearValue()`
Clears the value of the property on every element.
`void`
SimpleValueHandle.`clearValue()`
Clears the value of the property or member.
`void`
ColumnHandle.`convertWidthToAbsoluteValue()`
Converts width of the column to an absolute value if possible.
`ColumnBandData`
GridHandle.`copyColumn(int columnIndex)`
Copies a column and cells under it with the given column number.
`ColumnBandData`
TableHandle.`copyColumn(int columnIndex)`
Copies a column and cells under it with the given column number.
`void`
DesignElementHandle.`copyPropertyTo(String propName, DesignElementHandle targetHandle)`
Copies all properties to the target element.
`IDesignElement`
GridHandle.`copyRow(RowOperationParameters parameters)`
Copies table row with the given parameters.
`IDesignElement`
TableHandle.`copyRow(RowOperationParameters parameters)`
Copies table row with the given parameters.
`final TemplateElementHandle`
ContentElementHandle.`createTemplateElement(String name)`
`TemplateElementHandle`
DesignElementHandle.`createTemplateElement(String name)`
Creates a template element handle and transforms the current element handle to the created template element.
`protected void`
RowBandInsertAction.`doInsert(RowOperationParameters parameters)`
Inserts source table row below or above target table row.
`protected void`
RowBandInsertAndPasteAction.`doInsertAndPaste(org.eclipse.birt.report.model.elements.TableRow copiedRow, RowOperationParameters parameters)`
Pastes the given table row to target row with the given slot id , group id and destination index.
`protected void`
RowBandPasteAction.`doPaste(org.eclipse.birt.report.model.elements.TableRow copiedRow, RowOperationParameters parameters)`
Pastes the given table row to target row with the given slot id , group id and destination index.
`protected void`
RowBandShiftAction.`doShift(RowOperationParameters parameters)`
Does shift operation with the given parameters.
`void`
DesignElementHandle.`drop()`
Drops this element from the design.
`void`
DesignElementHandle.`drop(String propName, int posn)`
Drops a content element at the given position from the container, and unresolve any reference property which refers the element to drop.
`void`
DesignElementHandle.`drop(String propName, DesignElementHandle content)`
Drops a content element from the container, and unresolve any reference property which refers the element to drop.
`final void`
ModuleHandleImpl.`drop()`
`void`
PrivateStyleHandle.`drop()`
This method is not defined for private styles.
`void`
PropertyHandleImpl.`drop(int posn)`
Drops a content element at the given position from the slot, and unresolve any reference property which refers the element to drop.
`void`
PropertyHandleImpl.`drop(DesignElementHandle content)`
Drops a content element from the slot, and unresolve any reference property which refers the element to drop.
`void`
SlotHandle.`drop(int posn)`
Drops a content element at the given position from the slot, and unresolve any reference property which refers the element to drop.
`void`
SlotHandle.`drop(DesignElementHandle content)`
Drops a content element from the slot, and unresolve any reference property which refers the element to drop.
`final void`
ModuleHandleImpl.`dropAllScriptLibs()`
Removes all script libs.
`void`
DesignElementHandle.`dropAndClear()`
Drops this element from the design.
`void`
DesignElementHandle.`dropAndClear(String propName, int posn)`
Drops a content element at the given position from the container, and clear any reference property which refers the element to drop.
`void`
DesignElementHandle.`dropAndClear(String propName, DesignElementHandle content)`
Drops a content element from the container, and clear any reference property which refers the element to drop.
`final void`
ModuleHandleImpl.`dropAndClear()`
`void`
PrivateStyleHandle.`dropAndClear()`
This method is not defined for private styles.
`void`
PropertyHandleImpl.`dropAndClear(int posn)`
Drops a content element at the given position from the slot, and clear any reference property which refers the element to drop.
`void`
PropertyHandleImpl.`dropAndClear(DesignElementHandle content)`
Drops a content element from the slot, and clear any reference property which refers the element to drop.
`void`
SlotHandle.`dropAndClear(int posn)`
Drops a content element at the given position from the slot, and clear any reference property which refers the element to drop.
`void`
SlotHandle.`dropAndClear(DesignElementHandle content)`
Drops a content element from the slot, and clear any reference property which refers the element to drop.
`void`
ModuleHandleImpl.`dropConfigVariable(String name)`
Deprecated.
`void`
AbstractThemeHandle.`dropCss(CssStyleSheetHandle sheetHandle)`
Check if the css style sheet can be dropped based on sheet handle
`void`
ModuleHandleImpl.`dropImage(String name)`
Deprecated.
`void`
ModuleHandleImpl.`dropImage(List images)`
Drops an embedded image handle list from the design.
`final void`
ModuleHandleImpl.`dropIncludeScript(IncludeScript includeScript)`
Removes the given included script.
`void`
ModuleHandleImpl.`dropLibrary(LibraryHandle library)`
Drops the given library from the included libraries of this design file.
`void`
ModuleHandleImpl.`dropLibraryAndBreakExtends(LibraryHandle library)`
Drops the given library from the design and break all the parent/child relationships.
`final void`
ModuleHandleImpl.`dropScriptLib(ScriptLib scriptLib)`
Removes special script lib.
`final void`
ModuleHandleImpl.`dropScriptLib(ScriptLibHandle scriptLibHandle)`
Removes special script lib handle.
`void`
MultiViewsHandle.`dropView(DesignElementHandle viewElement)`
Deletes the given view.
`void`
ReportItemHandleImpl.`dropView(DesignElementHandle viewElement)`
Deletes the given view.
`void`
ReportItemThemeHandle.`importCssStyles(CssStyleSheetHandle stylesheet, List<SharedStyleHandle> selectedStyles)`
Imports the selected styles in a `CssStyleSheetHandle` to the given theme of the library.
`void`
ModuleHandleImpl.`includeLibrary(String libraryFileName, String namespace)`
Includes one library with the given library file name.
`final void`
ModuleHandleImpl.`initializeModule(Map properties)`
Initializes the report design when it is just created.
`void`
GridHandle.`insertAndPasteColumn(ColumnBandData data, int columnNumber)`
Inserts and pastes a column with its cells to the given column number.
`void`
TableHandle.`insertAndPasteColumn(ColumnBandData data, int columnNumber)`
Inserts and pastes a column with its cells to the given column number.
`void`
GridHandle.`insertAndPasteRow(IDesignElement copiedRow, RowOperationParameters parameters)`
Inserts and paste table row to the given destination row with the given parameters.
`void`
TableHandle.`insertAndPasteRow(IDesignElement copiedRow, RowOperationParameters parameters)`
Inserts and paste table row to the given destination row with the given parameters.
`void`
TableHandle.`insertColumn(int columnNumber, int positionFlag)`
Inserts a column to the table.
`StructureHandle`
SimpleValueHandle.`insertItem(IStructure item, int posn)`
Inserts a new item into a list property or member at the given position.
`void`
GridHandle.`insertRow(RowOperationParameters parameters)`
Inserts table row to the given destination row with the given parameters.
`void`
TableHandle.`insertRow(RowOperationParameters parameters)`
Inserts table row to the given destination row with the given parameters.
`final void`
ContentElementHandle.`localize()`
`void`
DesignElementHandle.`localize()`
Localize the element, break the parent/child relationship and set all the extended properties locally.
`void`
DesignElementHandle.`move(String fromPropName, DesignElementHandle content, DesignElementHandle newContainer, String toPropName)`
Moves a content element from this element into a property in another container element.
`void`
DesignElementHandle.`move(String fromPropName, DesignElementHandle content, DesignElementHandle newContainer, String toPropName, int newPos)`
Moves a content element into a property in another container element at the specified position.
`void`
DesignElementHandle.`moveTo(int posn)`
Moves this element handle to the given position within its container.
`void`
DesignElementHandle.`moveTo(DesignElementHandle newContainer, String toPropName)`
Moves this element to a property in another container element.
`void`
DesignElementHandle.`moveTo(DesignElementHandle newContainer, String toPropName, int newPos)`
Moves this element to a property in another container element at the specified position.
`List<ErrorDetail>`
DesignElementHandle.`paste(String propName, IDesignElement content)`
Pastes a report item to this property.
`List<ErrorDetail>`
DesignElementHandle.`paste(String propName, IDesignElement content, int newPos)`
Pastes a report item to the property.
`List<ErrorDetail>`
DesignElementHandle.`paste(String propName, DesignElementHandle content)`
Pastes a report item to this property.
`List<ErrorDetail>`
DesignElementHandle.`paste(String propName, DesignElementHandle content, int newPos)`
Pastes a report item to the slot.
`List`
PropertyHandleImpl.`paste(IDesignElement content)`
Pastes a report item to this property.
`List`
PropertyHandleImpl.`paste(IDesignElement content, int newPos)`
Pastes a report item to the property.
`List`
PropertyHandleImpl.`paste(DesignElementHandle content)`
Pastes a report item to this property.
`List`
PropertyHandleImpl.`paste(DesignElementHandle content, int newPos)`
Pastes a report item to the slot.
`void`
GridHandle.`pasteColumn(ColumnBandData data, int columnNumber, boolean inForce)`
Pastes a column with its cells to the given column number.
`void`
TableHandle.`pasteColumn(ColumnBandData data, int columnNumber, boolean inForce)`
Pastes a column with its cells to the given column number.
`void`
GridHandle.`pasteRow(IDesignElement copiedRow, RowOperationParameters parameters)`
Pastes table row to destination row with the given parameters.
`void`
TableHandle.`pasteRow(IDesignElement copiedRow, RowOperationParameters parameters)`
Pastes table row to destination row with the given parameters.
`void`
AbstractThemeHandle.`reloadCss(CssStyleSheetHandle sheetHandle)`
Reload the css style
`void`
ModuleHandleImpl.`reloadLibraries()`
Reloads all libraries this module included.
`void`
ModuleHandleImpl.`reloadLibrary(String reloadPath)`
Reloads the library with the given library file path.
`void`
ModuleHandleImpl.`reloadLibrary(LibraryHandle libraryToReload)`
Reloads the library with the given library file path.
`void`
ComputedColumnHandle.`removeAggregateOn(String aggreValue)`
Removes an aggregate level from the list.
`void`
ComputedColumnHandle.`removeArgument(AggregationArgument argument)`
Removes an arguments from list.
`void`
ComputedColumnHandle.`removeCalculationArgument(CalculationArgument argument)`
Removes a calculation argument from list.
`void`
JointDataSetHandle.`removeDataSet(String dataSetName)`
Removes a data set from this joint data set by name.
`void`
ReportItemHandleImpl.`removedColumnBinding(String bindingName)`
Removes bound column from the element.
`void`
ReportItemHandleImpl.`removedColumnBindings(List<String> bindingNameList)`
Removes bound columns from the element.
`void`
ReportItemHandleImpl.`removedUnusedColumnBindings()`
Removes unused bound columns from the element.
`void`
ScalarParameterHandle.`removedUnusedColumnBindings()`
Removed unused bound columns from the parameter.
`void`
DataSetHandle.`removeFilter(FilterCondition fc)`
Removes the filter condition.
`void`
DerivedDataSetHandle.`removeInputDataSet(String dataSetName)`
Removes a data set with the specified name from this derived data set.
`void`
DimensionConditionHandle.`removeJoinCondition(int index)`
Remove the join condition in the specified position.
`void`
DimensionConditionHandle.`removeJoinCondition(DimensionJoinCondition joinCondition)`
Removes join condition from this dimension condition.
`void`
AccessControlHandle.`removeRole(String role)`
Deprecated.
Removes the given role from the list.
`void`
AccessControlHandle.`removeUserName(String userName)`
Deprecated.
Removes the given user name from the list.
`void`
ValueAccessControlHandle.`removeValue(String value)`
Deprecated.
Removes the given value from the list.
`void`
AbstractThemeHandle.`renameCss(IncludedCssStyleSheetHandle handle, String newFileName)`
Deprecated.
`void`
AbstractThemeHandle.`renameCssByProperties(IncludedCssStyleSheetHandle handle, String newFileName, String externalCssURI, boolean useExternalCss)`
Rename css properties based on properties
`void`
ModuleHandleImpl.`replaceConfigVariable(ConfigVariable oldVar, ConfigVariable newVar)`
Replaces the old config variable with the new one.
`void`
ModuleHandleImpl.`replaceImage(EmbeddedImage oldVar, EmbeddedImage newVar)`
Replaces the old embedded image with the new one.
`void`
SimpleValueHandle.`replaceItem(IStructure oldItem, IStructure newItem)`
Replaces an old structure with a new one for the this property or member.
`final void`
ContentElementHandle.`revertToReportItem()`
`void`
DesignElementHandle.`revertToReportItem()`
if this design element is based on a template definition `DesignElementHandle.isTemplateParameterValue()`,get rid of the template definition )
`final TemplateElementHandle`
ContentElementHandle.`revertToTemplate(String name)`
`TemplateElementHandle`
DesignElementHandle.`revertToTemplate(String name)`
Creates a template element handle and transforms the current element handle to the created template element if the current element is based on a template parameter definition.
`void`
FreeFormHandle.`sendBackward(ReportItemHandle content)`
Reduces the z-index of the given element that resides in the freeform.
`void`
FreeFormHandle.`sendToBack(ReportItemHandle content)`
Reduces the z-index of the given element so that the element will have the minimal z-index value.
`void`
DimensionHandle.`setAbsolute(double value)`
Sets the value of a dimension in default units.
`void`
GroupHandle.`setACLExpression(String expr)`
Sets the ACL expression associated with the report element instance.
`void`
ReportItemHandleImpl.`setACLExpression(String expr)`
Sets the ACL expression associated with the report element instance.
`ActionHandle`
ColumnHintHandle.`setAction(Action action)`
Set an action on the image.
`ActionHandle`
DataItemHandle.`setAction(Action action)`
Set an action on the image.
`ActionHandle`
ImageHandle.`setAction(Action action)`
Set an action on the image.
`ActionHandle`
LabelHandle.`setAction(Action action)`
Set an action on the image.
`void`
DataSetHandle.`setAfterClose(String code)`
Sets the code for the afterClose method.
`void`
DataSourceHandle.`setAfterClose(String code)`
Sets the code for the afterClose method.
`void`
DataSetHandle.`setAfterOpen(String code)`
Sets the code for the afterOpen method.
`void`
DataSourceHandle.`setAfterOpen(String code)`
Sets the code for the afterOpen method.
`void`
ComputedColumnHandle.`setAggregateFunction(String expression)`
Sets the expression used to define this computed column.
`void`
ColumnHandle.`setAlignment(String alignment)`
Deprecated.
by the `StyleHandle.setTextAlign(String)`
`void`
ScalarParameterHandle.`setAlignment(String align)`
Sets the alignment for this parameter.
`void`
ScalarParameterHandle.`setAllowBlank(boolean allowBlank)`
Deprecated.
by `AbstractScalarParameterHandleImpl.setIsRequired(boolean)`
`void`
TemplateParameterDefinitionHandle.`setAllowedType(String type)`
Sets the allowed type of the template parameter definition.
`void`
ComputedColumnHandle.`setAllowExport(boolean allowExport)`
Sets the flag which indicates whether the computed column supports export.
`void`
ReportItemHandleImpl.`setAllowExport(boolean allowExport)`
Sets the allowExport property of the report item.
`void`
ScalarParameterHandle.`setAllowNull(boolean allowNull)`
Deprecated.
by `AbstractScalarParameterHandleImpl.setIsRequired(boolean)`
`void`
ExtendedItemHandle.`setAltText(String altText)`
Sets the alt text of this extended item.
`void`
ImageHandle.`setAltText(String altText)`
Deprecated.
`void`
CellHandle.`setAltTextExpression(Expression altText)`
Sets the alternate text of this label item.
`void`
ReportItemHandleImpl.`setAltTextExpression(Expression altText)`
Sets the alternate text of this label item.
`void`
CellHandle.`setAltTextKey(String altTextKey)`
Sets the resource key of the alternate text of this image.
`void`
ExtendedItemHandle.`setAltTextKey(String altTextKey)`
Sets the alt text id of this extended item.
`void`
ReportItemHandleImpl.`setAltTextKey(String altTextKey)`
Sets the resource key of the alternate text of this image.
`void`
ColumnHintHandle.`setAnalysis(String analysis)`
Sets the analysis option.
`void`
ColumnHintHandle.`setAnalysisColumn(String column)`
Sets the analysis column.
`void`
CellHandle.`setAntidiagonalNumber(int antidiagonalNumber)`
Sets the number of the anti-diagonal lines that are from the top-right to bottom-left.
`void`
CellHandle.`setAntidiagonalStyle(String antidiagonalStyle)`
Sets the style of the anti-diagonal that is from top-right to bottom-left corner.
`void`
ScalarParameterHandle.`setAutoSuggestThreshold(int number)`
Sets the maximal number of of entries a report parameter pick list can have.
`void`
AutoTextHandle.`setAutoTextType(String type)`
Sets the autotext type for this parameter.
`void`
StyleHandle.`setBackgroundAttachment(String value)`
Sets the background attachment.
`void`
StyleHandle.`setBackgroundHeight(String height)`
Sets the height of the background image.
`void`
StyleHandle.`setBackgroundImage(String value)`
Sets the address of the background image.
`void`
StyleHandle.`setBackgroundImageType(String type)`
Sets the type of the background image.
`void`
StyleHandle.`setBackgroundRepeat(String value)`
Sets the repeat pattern for a background image.
`void`
StyleHandle.`setBackgroundWidth(String width)`
Sets the width of the background image.
`void`
DataSetHandle.`setBeforeClose(String code)`
Sets the code for the beforeClose method.
`void`
DataSourceHandle.`setBeforeClose(String code)`
Sets the code for the beforeClose method.
`void`
DataSetHandle.`setBeforeOpen(String code)`
Sets the code for the beforeOpen method.
`void`
DataSourceHandle.`setBeforeOpen(String code)`
Sets the code for the beforeOpen method.
`void`
CellHandle.`setBookmark(String bookmark)`
Sets the book mark value on the cell element.
`void`
GroupHandle.`setBookmark(String value)`
Sets the bookmark of listing group.
`void`
ReportItemHandleImpl.`setBookmark(String value)`
Sets the bookmark of the report item.
`void`
RowHandle.`setBookmark(String value)`
Sets the bookmark of this row.
`void`
CellHandle.`setBookmarkDisplayName(String bookmarkDisplayName)`
Sets the display name of the bookmark.
`void`
GroupHandle.`setBookmarkDisplayName(String bookmarkDisplayName)`
Sets the display name of the bookmark.
`void`
ReportItemHandleImpl.`setBookmarkDisplayName(String bookmarkDisplayName)`
Sets the display name of the bookmark.
`void`
RowHandle.`setBookmarkDisplayName(String bookmarkDisplayName)`
Sets the display name of the bookmark.
`void`
ActionHandle.`setBookmarkLink(String bookmark)`
Deprecated.
use `ActionHandle.setTargetBookmark(String)`instead.
`void`
DesignElementHandle.`setBooleanProperty(String propName, boolean value)`
Sets the boolean value to the property.
`void`
HighlightRuleHandle.`setBorderBottomStyle(String value)`
Sets the style of the border bottom line.
`void`
StyleHandle.`setBorderBottomStyle(String value)`
Sets the style of the bottom line of the border.
`void`
HighlightRuleHandle.`setBorderLeftStyle(String value)`
Sets the style of the border left line.
`void`
StyleHandle.`setBorderLeftStyle(String value)`
Sets the style of the left line of the border.
`void`
HighlightRuleHandle.`setBorderRightStyle(String value)`
Sets the style of the border right line.
`void`
StyleHandle.`setBorderRightStyle(String value)`
Sets the style of the right line of the border.
`void`
HighlightRuleHandle.`setBorderTopStyle(String value)`
Sets the style of the top line of the border.
`void`
StyleHandle.`setBorderTopStyle(String value)`
Sets the style of the top line of the border.
`CachedMetaDataHandle`
DataSetHandle.`setCachedMetaData(CachedMetaData metadata)`
Set the value for the cached data set information.
`void`
DataSetHandle.`setCachedRowCount(int count)`
Deprecated.
by setDataSetRowLimit method
`void`
ComputedColumnHandle.`setCalculationType(String calculationType)`
Gets the calculation function name.
`void`
StyleHandle.`setCanShrink(boolean value)`
Sets whether the section can shrink if the actual content is smaller than the design size.
`void`
GridHandle.`setCaption(String caption)`
Sets the caption text of this grid.
`void`
TableHandle.`setCaption(String caption)`
Sets the caption text of this table.
`void`
GridHandle.`setCaptionKey(String captionKey)`
Sets the resource key of the caption.
`void`
TableHandle.`setCaptionKey(String captionKey)`
Sets the resource key of the caption.
`void`
GroupHandle.`setCascadeACL(boolean cascadeACL)`
Sets the flag to control whether to cascade ACL
`void`
ReportItemHandleImpl.`setCascadeACL(boolean cascadeACL)`
Sets the flag to control whether to cascade ACL
`void`
FormatValueHandle.`setCategory(String pattern)`
Sets the category of the format.
`void`
ScalarParameterHandle.`setCategory(String category)`
Sets the category for the parameter format.
`void`
ScriptDataSetHandle.`setClose(String value)`
Sets the script for closing data set.
`void`
ScriptDataSourceHandle.`setClose(String value)`
Sets the script name for closing data connection.
`void`
CustomColorHandle.`setColor(String colorValue)`
Sets the color value.
`void`
CellHandle.`setColumn(int column)`
Sets the cell's column property.
`void`
DynamicFilterParameterHandle.`setColumn(String column)`
Sets the column value.
`void`
MasterPageHandle.`setColumnCount(int count)`
Sets the number of columns in the report.
`void`
ColumnHintHandle.`setColumnName(String columnName)`
Sets the column name.
`void`
ResultSetColumnHandle.`setColumnName(String columnName)`
Sets the column name.
`void`
SortHintHandle.`setColumnName(String columnName)`
Sets the column Name.
`void`
SortKeyHandle.`setColumnName(String columnName)`
Deprecated.
This property has been removed.
`void`
CellHandle.`setColumnSpan(int span)`
Sets the cell's column span.
`final void`
ModuleHandleImpl.`setComments(String comments)`
Sets the comments value.
`void`
ReportElementHandle.`setComments(String theComments)`
Sets the comments of the report element.
`void`
ColumnHintHandle.`setCompresssed(boolean compressed)`
Sets the flag which indicates whether the column needs to be compressed.
`void`
ScalarParameterHandle.`setConcealValue(boolean concealValue)`
Sets the attribute that's hides the user's entry by displaying asterisks.
`void`
TextItemHandle.`setContent(String value)`
Sets the text for the text element.
`void`
TextItemHandle.`setContentKey(String resourceKey)`
Sets the resource key of the text for the item.
`void`
TextDataHandle.`setContentType(String contentType)`
Sets the expression that defines the text type this multi-line data item holds.
`void`
TextItemHandle.`setContentType(String contentType)`
Sets the content type of this text item.
`void`
TextDataHandle.`setContentTypeExpr(String expr)`
Deprecated.
by the method `TextDataHandle.setContentType(String)`
`void`
DynamicFilterParameterHandle.`setControlType(String controlType)`
Sets the control type for this parameter.
`void`
ScalarParameterHandle.`setControlType(String controlType)`
Sets the control type for this parameter.
`void`
ReportItemHandleImpl.`setCube(CubeHandle handle)`
Sets the cube of the report item.
`void`
ReportItemHandleImpl.`setCurrentView(DesignElementHandle viewElement)`
Sets the view to be used.
`void`
MultiViewsHandle.`setCurrentViewIndex(int index)`
Sets the index for the view to be used.
`void`
FilterConditionHandle.`setCustomValue(String customValue)`
Sets the user specified value.
`void`
ReportItemThemeHandle.`setCustomValues(String values)`
`void`
ReportElementHandle.`setCustomXml(String customXml)`
Sets the custom XML.
`void`
ReportItemHandleImpl.`setDataBindingReference(ReportItemHandle item)`
Sets the report item of which data binding are referred by.
`void`
AbstractScalarParameterHandleImpl.`setDataSet(DataSetHandle handle)`
Sets the data set of the report item.
`void`
CascadingParameterGroupHandleImpl.`setDataSet(DataSetHandle handle)`
Sets the data set of the report item.
`void`
ReportItemHandleImpl.`setDataSet(DataSetHandle handle)`
Sets the data set of the report item.
`void`
CascadingParameterGroupHandleImpl.`setDataSetMode(String mode)`
Sets the mode for data set support.
`void`
AbstractScalarParameterHandleImpl.`setDataSetName(String dataSetName)`
Sets the data set name of the dynamic list for this parameter.
`void`
DataSetHandle.`setDataSetRowLimit(int count)`
Deprecated.
duplicate with method setRowFetchLimit()
`void`
DataSetHandle.`setDataSource(String name)`
Sets the name of the data source for this data set.
`void`
AbstractScalarParameterHandleImpl.`setDataType(String type)`
Sets the data type for this parameter.
`void`
ComputedColumnHandle.`setDataType(String dataType)`
Sets the data type of this column.
`void`
DataSetParameterHandle.`setDataType(String dataType)`
Sets the data type of this parameter.
`void`
LevelAttributeHandle.`setDataType(String dataType)`
Sets the data type of this column.
`void`
ResultSetColumnHandle.`setDataType(String dataType)`
Sets the data type of this column.
`void`
StyleHandle.`setDateFormat(String pattern)`
Sets the pattern of a date time format for a highlight rule.
`void`
StyleHandle.`setDateFormatCategory(String pattern)`
Sets the category of a number format.
`void`
StyleHandle.`setDateTimeFormat(String pattern)`
Sets the pattern of a date time format for a highlight rule.
`void`
HighlightRuleHandle.`setDateTimeFormatCategory(String pattern)`
Sets the category of a number format for a highlight rule.
`void`
StyleHandle.`setDateTimeFormatCategory(String pattern)`
Sets the category of a number format.
`final void`
ModuleHandleImpl.`setDefaultUnits(String units)`
Sets the default units for the design.
`void`
ScalarParameterHandle.`setDefaultValue(String defaultValue)`
Deprecated.
since 2.5 replaced by `AbstractScalarParameterHandleImpl.setDefaultValueList(List)`
`void`
AbstractScalarParameterHandleImpl.`setDefaultValueList(List<? extends Object> defaultValueList)`
Sets the default value list of the parameter.
`void`
ScalarParameterHandle.`setDefaultValueListMethod(String getDefaultValueListMethod)`
Sets the method content of `getDefaultValueList`.
`void`
ScriptDataSetHandle.`setDescribe(String value)`
Sets the script for describing the result set dynamically.
`final void`
ModuleHandleImpl.`setDescription(String description)`
Sets the description of the module.
`void`
TemplateElementHandle.`setDescription(String description)`
Sets the description of the template element.
`void`
TemplateParameterDefinitionHandle.`setDescription(String description)`
Sets the description of the template parameter definition.
`final void`
ModuleHandleImpl.`setDescriptionKey(String resourceKey)`
Sets the resource key of the static description of the module.
`void`
TemplateElementHandle.`setDescriptionKey(String resourceKey)`
Sets the resource key of the static description of the template element.
`void`
TemplateParameterDefinitionHandle.`setDescriptionKey(String resourceKey)`
Sets the resource key of the static description of the template parameter definition.
`void`
OdaDataSetHandle.`setDesigerStateContentAsBlob(byte[] content)`
Returns the content of designer state as the byte.
`void`
OdaDataSourceHandle.`setDesigerStateContentAsBlob(byte[] content)`
Returns the content of designer state as the byte.
`void`
OdaDataSetHandle.`setDesigerStateContentAsString(String content)`
Returns the content of designer state as the string.
`void`
OdaDataSourceHandle.`setDesigerStateContentAsString(String content)`
Returns the content of designer state as the string.
`void`
OdaDataSetHandle.`setDesigerStateVersion(String version)`
Returns the version of designer state.
`void`
OdaDataSourceHandle.`setDesigerStateVersion(String version)`
Returns the version of designer state.
`OdaDesignerStateHandle`
OdaDataSetHandle.`setDesignerState(OdaDesignerState designerState)`
Sets the designer state for a oda data set.
`OdaDesignerStateHandle`
OdaDataSourceHandle.`setDesignerState(OdaDesignerState designerState)`
Sets the designer state for a oda data source.
`void`
OdaDataSetHandle.`setDesignerValues(String values)`
Stores persistent ODA designer values in the data set.
`void`
StructureHandle.`setDesignTime(boolean isDesignTime)`
`void`
CellHandle.`setDiagonalNumber(int diagonalNumber)`
Sets the number of the diagonal lines that are from top-left to bottom-right corners.
`void`
CellHandle.`setDiagonalStyle(String lineStyle)`
Sets the style of the diagonal that is from top-left to bottom-right.
`void`
SortElementHandle.`setDirection(String direction)`
Sets the sort direction.
`void`
SortHintHandle.`setDirection(String direction)`
Sets the direction value.
`void`
SortKeyHandle.`setDirection(String direction)`
Sets the sort direction.
`void`
StyleHandle.`setDisplay(String value)`
Sets the value that specifies if a top-level element should be a block or in-line element.
`void`
ComputedColumnHandle.`setDisplayName(String columnDisplayName)`
Sets the column display name.
`void`
ReportElementHandle.`setDisplayName(String displayName)`
Sets the display name.
`void`
ComputedColumnHandle.`setDisplayNameID(String displayNameID)`
Sets column display name id.
`void`
ReportElementHandle.`setDisplayNameKey(String displayNameKey)`
Sets the resource key of the display name.
`void`
DynamicFilterParameterHandle.`setDisplayType(String displayType)`
Sets the display type for this parameter.
`void`
AbstractScalarParameterHandleImpl.`setDistinct(boolean distinct)`
Sets the flag that indicates whether duplicate values should be shown when preview.
`void`
DataItemHandle.`setDistinct(String distinct)`
Deprecated.
by the drop function of Cell element.
`void`
DataItemHandle.`setDistinctReset(String value)`
Deprecated.
by the drop function of Cell element.
`void`
ActionHandle.`setDrillThroughBookmarkLink(String bookmark)`
Deprecated.
use `ActionHandle.setTargetBookmark(String)`instead.
`void`
ActionHandle.`setDrillThroughReportName(String reportName)`
Deprecated.
use `ActionHandle.setReportName(String)`instead.
`void`
ActionHandle.`setDrillThroughTargetBookmark(String bookmark)`
Deprecated.
use `ActionHandle.setTargetBookmark(String)`instead.
`void`
OdaDataSourceHandle.`setDriverName(String driverName)`
Deprecated.
This property is removed.
`void`
CellHandle.`setDrop(String drop)`
Sets the cell's drop property.
`void`
FilterConditionElementHandle.`setDynamicFilterParameter(String parameterName)`
Sets the name of the dynamic filter parameter to reference.
`void`
DesignElementHandle.`setEncryption(String propName, String encryptionID)`
Sets the encryption for an encryptable property.
`void`
PropertyHandleImpl.`setEncryption(String encryptionID)`
`final void`
ContentElementHandle.`setEventHandlerClass(String expr)`
`void`
DesignElementHandle.`setEventHandlerClass(String expr)`
Sets the group expression.
`void`
ColumnHintHandle.`setExport(String export)`
Sets the export option.
`void`
FilterConditionElementHandle.`setExpr(String filterExpr)`
Sets the filter expression.
`void`
FilterConditionHandle.`setExpr(String filterExpr)`
Sets the filter expression.
`void`
ComputedColumnHandle.`setExpression(String expression)`
Sets the expression used to define this computed column.
`void`
ExpressionHandle.`setExpression(Object expr)`
Sets the raw expression if the type is not constant.
`void`
TOCHandle.`setExpression(String expression)`
Sets expression of TOC.
`void`
DesignElementHandle.`setExpressionProperty(String propName, Expression expression)`
Sets the value of a property to an expression.
`void`
StructureHandle.`setExpressionProperty(String memberName, Expression value)`
Sets the value of the member as an expression.
`void`
FilterConditionElementHandle.`setExtensionExprId(String extensionExprId)`
Sets the id of a custom filter expression contributed and defined by the extension identified in the consumerExpressionMapping.
`void`
FilterConditionElementHandle.`setExtensionName(String extensionName)`
Sets the unique id of an org.eclipse.datatools.connectivity.oda.filterExpressions extension to whose custom expressions are defined to map to a BIRT filter operator.
`void`
ExtendedItemHandle.`setExtensionVersion(String extensionVersion)`
Sets the extension version of this element.
`void`
OdaDataSourceHandle.`setExternalConnectionName(String externalConnectionName)`
`void`
IncludedCssStyleSheetHandle.`setExternalCssURI(String externalCssURI)`
Sets the URI of the external CSS.
`void`
ExtendedItemHandle.`setExternalScript(String theScript)`
Sets the scripts in the extension element model.
`void`
ScriptDataSetHandle.`setFetch(String value)`
Sets the script for providing the data for the next row from the result set.
`void`
ImageHandle.`setFile(String file)`
Sets the image uri property.
`void`
ImageHandle.`setFile(Expression expr)`
Sets the image uri property by an expression.
`void`
IncludedCssStyleSheetHandle.`setFileName(String fileName)`
Sets the file name of the included css style sheet..
`void`
FilterConditionHandle.`setFilterExpr(String filterExpr)`
Deprecated.
Replaced by the method `FilterConditionHandle.setExpr(String)`
`void`
ComputedColumnHandle.`setFilterExpression(String expression)`
Sets the expression used to define this computed column.
`void`
DynamicFilterParameterHandle.`setFilterOperator(List<String> filterOperatorList)`
Sets the filter operator.
`void`
FilterConditionElementHandle.`setFilterTarget(String filterTarget)`
Sets the filter target.
`void`
FilterConditionHandle.`setFilterTarget(String filterTarget)`
Sets the filter target.
`void`
ImageHandle.`setFitToContainer(boolean fitToContainer)`
Sets the fit to container property value of this image item.
`void`
ScalarParameterHandle.`setFixedOrder(boolean fixedOrder)`
Sets the flag indicates that whether to display values in the order defined in the list.
`void`
SimpleMasterPageHandle.`setFloatingFooter(boolean isFloatingFooter)`
Changes the status to say if it has a floating footer or not.
`void`
DesignElementHandle.`setFloatProperty(String propName, double value)`
Sets the value of a property to a double.
`void`
SimpleValueHandle.`setFloatValue(double value)`
Sets the value of the property or member to the given double.
`void`
HighlightRuleHandle.`setFontStyle(String value)`
Sets the font style in a string for the style.
`void`
StyleHandle.`setFontStyle(String fontStyle)`
Sets the style of the font.
`void`
HighlightRuleHandle.`setFontVariant(String value)`
Sets the font variant in a string .
`void`
StyleHandle.`setFontVariant(String fontVariant)`
Sets the variant of the font.
`void`
HighlightRuleHandle.`setFontWeight(String value)`
Sets the font weight in a string for the style.
`void`
StyleHandle.`setFontWeight(String fontWeight)`
Sets the weight of the font.
`void`
HideRuleHandle.`setFormat(String format)`
Sets the output format of this visibility rule.
`void`
ScalarParameterHandle.`setFormat(String format)`
Deprecated.
replaced by setPattern and setCategory.
`void`
ActionHandle.`setFormatType(String type)`
Sets the format type of the action.
`void`
DataGroupHandle.`setGroupName(String theName)`
Sets the group name.
`void`
GroupHandle.`setGroupStart(String groupStart)`
Deprecated.
by `GroupHandle.setIntervalBase(String)`
`void`
TextDataHandle.`setHasExpression(boolean hasExpression)`
Sets the status whether there is expression need to be evaluated in the text content of this text data handle.
`void`
TextItemHandle.`setHasExpression(boolean hasExpression)`
Sets the status whether there is expression need to be evaluated in the text content of this text item handle.
`void`
CellHandle.`setHeaders(String headers)`
Sets the headers value on the cell element.
`void`
CellHandle.`setHeight(String height)`
Set the cell height based on unit string without locale handling
`void`
CellHandle.`setHeight(DimensionValue height)`
Set the cell height based on dimension value
`void`
MasterPageHandle.`setHeight(String height)`
Set the master page height based on unit string without locale handling
`void`
MasterPageHandle.`setHeight(DimensionValue height)`
Set the master page height based on dimension value
`void`
ReportItemHandleImpl.`setHeight(double dimension)`
Sets the item's height to a value in default units.
`void`
ReportItemHandleImpl.`setHeight(String dimension)`
Sets the item's height using a dimension string with optional unit suffix such as "10" or "10pt".
`void`
RowHandle.`setHeight(String height)`
Set the row height based on unit string without locale handling
`void`
RowHandle.`setHeight(DimensionValue height)`
Set the row height based on dimension value
`void`
StyleHandle.`setHeight(String height)`
Sets the value of height property.
`void`
DataItemHandle.`setHelpText(String value)`
Sets the help text of this data item.
`void`
ImageHandle.`setHelpText(String helpText)`
Sets the help text of this image item.
`void`
LabelHandle.`setHelpText(String text)`
Sets the help text of this label item.
`void`
ParameterGroupHandle.`setHelpText(String text)`
Returns additional pop-up help text associated with the group.
`void`
ParameterHandle.`setHelpText(String helpText)`
Returns the additional text to display for the parameter to explain how to use the parameter.
`void`
DataItemHandle.`setHelpTextKey(String value)`
Sets the resource key of the help text of this data item.
`void`
ImageHandle.`setHelpTextKey(String helpTextKey)`
Sets the resource key of help text of this image item.
`void`
LabelHandle.`setHelpTextKey(String resourceKey)`
Sets the help text key of this label item.
`void`
ParameterGroupHandle.`setHelpTextKey(String text)`
Sets the resource key of the help text for this parameter group.
`void`
ParameterHandle.`setHelpTextKey(String resourceKey)`
Sets the resource key of the additional text to display for the parameter to explain how to use the parameter.
`void`
ParameterHandle.`setHidden(boolean hidden)`
Sets the hidden property of this parameter.
`void`
GroupHandle.`setHideDetail(boolean value)`
Sets whether to hide the detail rows of this group.
`void`
DimensionConditionHandle.`setHierarchy(String hierarchyName)`
Sets the referred hierarchy by the name.
`void`
DimensionConditionHandle.`setHierarchy(HierarchyHandle hierarchyHandle)`
Sets the referred hierarchy by the handle.
`void`
StyleHandle.`setHighlightTestExpr(String value)`
Deprecated.
`void`
ColumnHintHandle.`setHorizontalAlign(String align)`
Sets the horizontal alignment of the column.
`void`
ActionHandle.`setHyperlink(String hyperlink)`
Deprecated.
`ActionHandle.setURI(String)`
`void`
ImageHandle.`setImageName(String name)`
Sets the embedded image name that this image refers, if the image source type is `IMAGE_REF_TYPE_EMBED`.
`void`
ColumnHintHandle.`setIndexColumn(boolean indexColumn)`
Sets the flag which indicates whether the column should be generated with index.
`void`
DataGroupHandle.`setInterval(String interval)`
Returns the interval of this data group.
`void`
GroupHandle.`setInterval(String interval)`
Returns the interval of this group.
`void`
DataGroupHandle.`setIntervalBase(String intervalBase)`
Sets the base of the interval property of this data group.IntervalBase, in conjunction with Interval and IntervalRange, determines how data is divided into data groups.
`void`
GroupHandle.`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`
DataGroupHandle.`setIntervalRange(double intervalRange)`
Returns the interval range of this data group.
`void`
DataGroupHandle.`setIntervalRange(String intervalRange)`
Sets the interval range of data group.
`void`
GroupHandle.`setIntervalRange(double intervalRange)`
Returns the interval range of this group.
`void`
GroupHandle.`setIntervalRange(String intervalRange)`
Sets the interval range of group.
`void`
DesignElementHandle.`setIntProperty(String propName, int value)`
Sets the value of a property to an integer.
`void`
SimpleValueHandle.`setIntValue(int value)`
Sets the value of the property or member to the given integer.
`void`
AbstractScalarParameterHandleImpl.`setIsRequired(boolean isRequired)`
Sets the flag that indicates whether the value of the parameter is required.
`void`
TableHandle.`setIsSummaryTable(boolean isSummaryTable)`
Sets the flag to control whether the table is a summary table.
`void`
DataSetHandle.`setIsVisible(boolean isVisible)`
Sets the isVisible property value.
`void`
JoinConditionHandle.`setJoinType(String type)`
Sets the join type value of this condition.
`void`
TextDataHandle.`setJTidy(boolean useJTidy)`
set if jTidy need to be used to validate the HTML content.
`void`
TextItemHandle.`setJTidy(boolean useJTidy)`
set if jTidy need to be used to validate the HTML content.
`void`
SortElementHandle.`setKey(String key)`
Sets an expression that gives the sort key on which to sort.
`void`
SortKeyHandle.`setKey(String key)`
Sets an expression that gives the sort key on which to sort.
`void`
DataGroupHandle.`setKeyExpr(String expr)`
Sets the data group expression.
`void`
GroupHandle.`setKeyExpr(String expr)`
Sets the group expression.
`void`
ScalarParameterHandle.`setLabelColumn(String labelColumn)`
Deprecated.
Replaced by the method `AbstractScalarParameterHandleImpl.setLabelExpr(String)`
`void`
AbstractScalarParameterHandleImpl.`setLabelExpr(String labelExpr)`
Sets an expression on the data row from the dynamic list data set that returns the prompt for the choice.
`void`
CellHandle.`setLanguage(String language)`
Sets the language of this label item.
`void`
ReportItemHandleImpl.`setLanguage(String language)`
Sets the language of this label item.
`void`
RowHandle.`setLanguage(String language)`
Sets the language of this label item.
`void`
DimensionJoinConditionHandle.`setLevel(String levelName)`
Sets the referred level by the name.
`void`
DimensionJoinConditionHandle.`setLevel(LevelHandle levelHandle)`
Sets the referred level by the handle.
`void`
MemberValueHandle.`setLevel(LevelHandle levelHandle)`
Sets the referred level of this member value.
`void`
ActionHandle.`setLinkType(String type)`
Sets the link type of the action.
`void`
AbstractScalarParameterHandleImpl.`setListlimit(int listLimit)`
Set the value for the list limitation number.
`void`
ExpressionListHandle.`setListValue(List<Expression> toSet)`
Returns the value as an expression list.
`void`
DataSetHandle.`setLocale(com.ibm.icu.util.ULocale locale)`
Sets the locale for this data set element.
`void`
FormatValueHandle.`setLocale(com.ibm.icu.util.ULocale locale)`
Sets the locale of the format.
`void`
SortElementHandle.`setLocale(com.ibm.icu.util.ULocale locale)`
Sets the locale for this sort.
`void`
SortKeyHandle.`setLocale(com.ibm.icu.util.ULocale locale)`
Sets the locale for this sort.
`void`
StyleHandle.`setMapTestExpr(String value)`
Deprecated.
`void`
PropertyMaskHandle.`setMask(String mask)`
Sets the property mask.
`void`
StyleHandle.`setMasterPage(String value)`
Sets the master page name on which to start this section.
`void`
TimeIntervalHandle.`setMeasure(int measure)`
Sets the measure value.
`void`
ScalarParameterHandle.`setMustMatch(boolean mustMatch)`
Sets the flag indicates that whether the value must match one of values in the selection list.
`void`
AggregationArgumentHandle.`setName(String argumentName)`
Sets the argument name.
`void`
CalculationArgumentHandle.`setName(String argumentName)`
Sets the argument name.
`void`
ComputedColumnHandle.`setName(String columnName)`
Sets the column name.
`void`
CustomColorHandle.`setName(String name)`
Sets the custom color name.
`void`
DataSetParameterHandle.`setName(String name)`
Sets the parameter name.
`void`
EmbeddedImageHandle.`setName(String name)`
Sets the embedded image name.
`void`
LevelAttributeHandle.`setName(String columnName)`
Sets the column name.
`void`
PropertyMaskHandle.`setName(String name)`
Sets the property name.
`void`
ScriptLibHandle.`setName(String name)`
Sets the jar file name value.
`void`
DynamicFilterParameterHandle.`setNativeDataType(int nativeDataType)`
Sets the native data type of the dynamic parameter.
`void`
OdaLevelAttributeHandle.`setNativeName(String nativeName)`
Sets the native name for this result set column.
`void`
OdaResultSetColumnHandle.`setNativeName(String nativeName)`
Sets the native name for this result set column.
`void`
DataSetHandle.`setNeedsCache(boolean needsCache)`
Sets whether to do some cache when rendering the report.
`void`
DesignElementHandle.`setNewHandlerOnEachEvent(boolean newHandler)`
Sets the newHandlerOnEachEvent property value.
`void`
DataSetHandle.`setNullsOrdering(String nullsOrdering)`
Sets the ordering of null values.
`void`
SortHintHandle.`setNullValueOrdering(String nullValueOrdering)`
Sets the null value ordering.
`void`
StyleHandle.`setNumberFormat(String pattern)`
Sets the pattern of a number format.
`void`
HighlightRuleHandle.`setNumberFormatCategory(String category)`
Sets the category of a number format for a highlight rule.
`void`
StyleHandle.`setNumberFormatCategory(String category)`
Sets the category of a number format for a highlight rule.
`void`
DesignElementHandle.`setNumberProperty(String propName, BigDecimal value)`
Sets the value of a property to a number (BigDecimal).
`void`
SimpleValueHandle.`setNumberValue(BigDecimal value)`
Sets the value of the property or member to the given number.
`void`
ColumnHintHandle.`setOnColumnLayout(boolean onColumnLayout)`
Sets the hint if the dimension data element should be layout on column.
`void`
CellHandle.`setOnCreate(String script)`
Sets the on-create script of the group element.
`void`
GroupHandle.`setOnCreate(String script)`
Sets create property value of this group.
`void`
ReportItemHandleImpl.`setOnCreate(String value)`
Sets the script executed when the element is created in the Factory.
`void`
RowHandle.`setOnCreate(String script)`
Sets the on-create script of the group element.
`void`
DataSetHandle.`setOnFetch(String code)`
Sets the code for the onFetch method.
`void`
GroupHandle.`setOnPageBreak(String script)`
Sets the on-pageBreak script of the group element.
`void`
ReportItemHandleImpl.`setOnPageBreak(String script)`
Sets the on-pageBreak script of the report item.
`void`
MasterPageHandle.`setOnPageEnd(String onPageEnd)`
Sets the script of onPageEnd method.
`void`
MasterPageHandle.`setOnPageStart(String onPageStart)`
Sets the script of onPageStart method.
`void`
CellHandle.`setOnPrepare(String script)`
Sets the on-prepare script of the group element.
`void`
GroupHandle.`setOnPrepare(String script)`
Sets the on-prepare script of the group element.
`void`
ReportItemHandleImpl.`setOnPrepare(String script)`
Sets the on-prepare script of the group element.
`void`
RowHandle.`setOnPrepare(String script)`
Sets the on-prepare script of the group element.
`void`
CellHandle.`setOnRender(String script)`
Sets the on-render script of the group element.
`void`
GroupHandle.`setOnRender(String script)`
Sets render property value of this group.
`void`
ReportItemHandleImpl.`setOnRender(String value)`
Sets the script executed when the element is prepared for rendering in the Presentation engine.
`void`
RowHandle.`setOnRender(String script)`
Sets the on-render script of the group element.
`void`
ScriptDataSetHandle.`setOpen(String value)`
Sets the script for opening data set.
`void`
ScriptDataSourceHandle.`setOpen(String value)`
Sets the script for opening data connection.
`void`
FilterConditionElementHandle.`setOperator(String operator)`
Sets the operator of this filter condition.
`void`
FilterConditionHandle.`setOperator(String operator)`
Sets the operator of this filter condition.
`void`
JoinConditionHandle.`setOperator(String operator)`
Sets the operator value of this condition.
`void`
StyleRuleHandle.`setOperator(String operator)`
Sets the operator.
`void`
FilterConditionElementHandle.`setOptional(boolean isOptional)`
Sets the optional status for this filter condition.
`void`
ReportItemHandleImpl.`setOrder(int order)`
Sets the order of this label item.
`void`
LineHandle.`setOrientation(String orientation)`
Sets the orientation of the line.
`void`
MasterPageHandle.`setOrientation(String orientation)`
Returns the page orientation.
`void`
StyleHandle.`setOrphans(String value)`
Sets the orphans property.
`void`
StyleHandle.`setOverflow(String value)`
Sets the value of overflow property.
`void`
GroupHandle.`setPageBreakAfter(String value)`
Sets page break after property value of this group.
`void`
StyleHandle.`setPageBreakAfter(String value)`
Sets the page break after property for block-level elements.
`void`
GroupHandle.`setPageBreakBefore(String value)`
Sets page break before property value of this group.
`void`
StyleHandle.`setPageBreakBefore(String value)`
Sets the page break before property for block-level elements.
`void`
GroupHandle.`setPageBreakInside(String value)`
Sets page break inside property value of this group.
`void`
StyleHandle.`setPageBreakInside(String value)`
Sets the page break inside property for block-level elements.
`void`
ListingHandle.`setPageBreakInterval(int pageBreakInterval)`
Sets the page break interval value
`void`
MasterPageHandle.`setPageType(String type)`
Sets the type of the page.
`void`
AutoTextHandle.`setPageVariable(String pageVariable)`
Sets the page variable property value.
`void`
DataSetParameterHandle.`setParameterDataType(String dataType)`
Sets the data type in parameter type choices to this parameter.
`void`
ScalarParameterHandle.`setParamType(String type)`
Sets the parameter type for this scalar parameter.
`void`
ScalarParameterHandle.`setPattern(String pattern)`
Sets the pattern of format instructions for the parameter value.
`void`
AccessControlHandle.`setPermission(String permission)`
Deprecated.
Sets the permission.
`void`
SortHintHandle.`setPosition(int position)`
Sets the index position of a result set column.
`void`
OdaDataSetHandle.`setPrivateDriverDesignState(String state)`
Deprecated.
`void`
OdaDataSetHandle.`setPrivateDriverProperty(String name, String value)`
Sets a private driver property value with the given name and value.
`void`
OdaDataSourceHandle.`setPrivateDriverProperty(String name, String value)`
Sets a private driver property value with the given name and value.
`void`
ParameterGroupHandle.`setPromptText(String promptValue)`
Sets the value for the display prompt context.
`void`
ParameterHandle.`setPromptText(String promptValue)`
Set the value for the display prompt context.
`void`
ParameterHandle.`setPromptTextID(String promptIDValue)`
Set the value for the prompt text ID.
`void`
ParameterGroupHandle.`setPromptTextKey(String promptIDValue)`
Set the value for the prompt text key.
`void`
DesignElementHandle.`setProperties(Map<?,?> properties)`
Sets a bunch of property values on the element.
`void`
DesignElementHandle.`setProperty(String propName, Object value)`
Sets the value of a property from a generic object.
`final void`
GroupElementHandle.`setProperty(String propName, Object value)`
Set the value of a property on the given collection of elements.
`void`
JointDataSetHandle.`setProperty(String propName, Object value)`
`void`
ScalarParameterHandle.`setProperty(String propName, Object value)`
`void`
StructureHandle.`setProperty(String memberName, Object value)`
Sets the value of the member.
`void`
DesignElementHandle.`setPropertyBinding(String propName, String value)`
Deprecated.
instead use setPropertyBinding( String propName, Expression value )
`void`
DesignElementHandle.`setPropertyBinding(String propName, Expression value)`
Sets the mask of the specified property.
`void`
ReportElementHandle.`setPropertyMask(String propName, String maskValue)`
Sets the mask of the specified property.
`void`
ImageHandle.`setProportionalScale(boolean proportionalScale)`
Sets the flag which indicates whether the image scales proportionally or not.
`void`
FilterConditionElementHandle.`setPushDown(boolean pushDown)`
Sets the push down status for this filter condition
`void`
ReportItemHandleImpl.`setPushDown(boolean pushDown)`
Sets the pushdown property value of the report item.
`void`
OdaDataSetHandle.`setQueryScript(String script)`
Deprecated.
to be removed.
`void`
DerivedDataSetHandle.`setQueryText(String text)`
Sets the query text.
`void`
OdaDataSetHandle.`setQueryText(String text)`
Sets the query text.
`void`
ComputedColumnHandle.`setReferenceDateType(String refDateType)`
Sets reference date type for the calculation in this column.
`void`
RowHandle.`setRepeatable(boolean repeatable)`
Sets the repeatable value.
`void`
ColumnHandle.`setRepeatCount(int count)`
Sets the repeat count for this column.
`void`
GroupHandle.`setRepeatHeader(boolean value)`
Sets whether to repeat the headings at the top of each page.
`void`
ListingHandle.`setRepeatHeader(boolean value)`
Sets whether to repeat the headings at the top of each page.
`void`
ActionHandle.`setReportName(String reportName)`
Sets target report name for a drill-though link.
`void`
DataItemHandle.`setResultSetColumn(String columnName)`
Sets the value of the column name property.
`void`
OdaDataSetHandle.`setResultSetName(String name)`
Sets the result set name.
`void`
OdaDataSetHandle.`setResultSetNumber(int number)`
Sets the result set number.
`void`
ColorHandle.`setRGB(int rgbValue)`
Sets a color with a given integer RGB value.
`void`
DataSetHandle.`setRowFetchLimit(int count)`
Sets the max number of rows from data set property value.
`void`
CellHandle.`setRowSpan(int span)`
Sets the cell's row span.
`void`
ImageHandle.`setScale(double scale)`
Sets the image scale property.
`void`
CellHandle.`setScope(String scope)`
Sets the scope value of the cell.The input value is one of the constants defined in `DesignChoiceConstants`: `SCOPE_TYPE_ROW` `SCOPE_TYPE_COL` `SCOPE_TYPE_ROWGROUP` `SCOPE_TYPE_COLGROUP`
`void`
ColumnHintHandle.`setSearching(String searching)`
Sets the searching option.
`void`
ScalarParameterHandle.`setSelectionValueListMethod(String getSelectionValueListMethod)`
Sets the method content of `getSelectionValueList`.
`void`
GroupHandle.`setShowDetailFilter(boolean showDetailFilter)`
Sets the flag which indicates whether to show the detail filter or not.
`void`
SimpleMasterPageHandle.`setShowFooterOnLast(boolean showFooterOnLast)`
Changes the status to show footer on the last page.
`void`
SimpleMasterPageHandle.`setShowHeaderOnFirst(boolean showHeaderOnFirst)`
Changes the status to show page header on the first page or not.
`void`
StyleHandle.`setShowIfBlank(boolean value)`
Sets whether to show this frame even if it is empty, or all its data elements are empty.
`void`
ImageHandle.`setSize(String size)`
Sets the image size property.
`void`
AbstractScalarParameterHandleImpl.`setSortBy(String sortValue)`
Sets the sort key for parameter values when preview.
`void`
AbstractScalarParameterHandleImpl.`setSortByColumn(String sortByColumn)`
Sets the expression by which the result sorts.
`void`
ListingHandle.`setSortByGroups(boolean isSortByGroups)`
Sets whether the result set of this element will be sorted by the group keys.
`void`
AbstractScalarParameterHandleImpl.`setSortDirection(String direction)`
Sets the sort order for parameter values when preview.
`void`
DataGroupHandle.`setSortDirection(String direction)`
Sets the sort direction of this data group.
`void`
GroupHandle.`setSortDirection(String direction)`
Sets the sort direction of this group.
`void`
DataGroupHandle.`setSortType(String sortType)`
Sets the sort type, which indicates the way of sorting.
`void`
GroupHandle.`setSortType(String sortType)`
Sets the sort type, which indicates the way of sorting
`void`
ImageHandle.`setSource(String source)`
Sets the image source type.
`void`
ParameterGroupHandle.`setStartExpanded(boolean value)`
Sets whether the UI can expand and collapse groups.
`void`
SortElementHandle.`setStrength(int strength)`
Sets the strength for this sort.
`void`
SortKeyHandle.`setStrength(int strength)`
Sets the strength for this sort.
`void`
StyleHandle.`setStringFormat(String pattern)`
Sets the pattern of a string format.
`void`
HighlightRuleHandle.`setStringFormatCategory(String category)`
Sets the category of a string format for a highlight rule.
`void`
StyleHandle.`setStringFormatCategory(String pattern)`
Sets the category of a string format.
`void`
DesignElementHandle.`setStringProperty(String propName, String value)`
Sets the value of a property to a string.
`final void`
GroupElementHandle.`setStringProperty(String propName, String value)`
Set the value of a property to a string .
`void`
ComplexValueHandle.`setStringValue(String value)`
Sets the value of a property or member to a string.
`void`
GroupPropertyHandle.`setStringValue(String value)`
Set the string value on a group of elements.
`void`
SimpleValueHandle.`setStringValue(String value)`
Sets the value of the property or member to the given integer.
`void`
HighlightRuleHandle.`setStyle(StyleHandle style)`
Sets the style property.
`void`
HighlightRuleHandle.`setStyleName(String styleName)`
Sets the style property.
`void`
TOCHandle.`setStyleName(String styleName)`
Sets style of TOC.
`final void`
ModuleHandleImpl.`setSubject(String subject)`
Sets the subject of the module.
`void`
GridHandle.`setSummary(String summary)`
Sets the value of summary.
`void`
TableHandle.`setSummary(String summary)`
Sets the value of summary.
`void`
RowHandle.`setSuppressDuplicates(boolean value)`
Sets the flag whether to suppress duplicates rows with same content.
`final void`
ModuleHandleImpl.`setSymbolicName(String symbolicName)`
Sets symbolic name of this module.
`void`
CellHandle.`setTagType(String tagType)`
Sets the tag type of this label item.
`void`
ReportItemHandleImpl.`setTagType(String tagType)`
Sets the tag type of this label item.
`void`
RowHandle.`setTagType(String tagType)`
Sets the tag type of this label item.
`void`
ActionHandle.`setTargetBookmark(String bookmark)`
Sets the target bookmark defined within this same report, or another report for a drill-though link.
`void`
ActionHandle.`setTargetBookmarkType(String targetBookmarkType)`
Sets target bookmark type for a drill-through or bookmark-link action.
`void`
ActionHandle.`setTargetFileType(String targetFileType)`
Sets target report file type for a drill-through action.
`void`
ActionHandle.`setTargetWindow(String window)`
Sets the target window of the action.
`void`
LabelHandle.`setText(String text)`
Sets the text of the label.
`void`
HighlightRuleHandle.`setTextAlign(String value)`
Sets the text align property.
`void`
StyleHandle.`setTextAlign(String value)`
Sets the text align for block-level elements.
`void`
HighlightRuleHandle.`setTextDirection(String value)`
Sets the Bidi direction property.
`void`
StyleHandle.`setTextDirection(String value)`
Sets the Bidi direction for elements.
`void`
TOCHandle.`setTextDirection(String value)`
Sets the Bidi direction property.
`void`
ColumnHintHandle.`setTextFormat(String format)`
Deprecated.
`void`
StyleHandle.`setTextHyperlinkStyle(String value)`
Sets one 'text-decoration' property to set hypertext styles.
`void`
LabelHandle.`setTextKey(String resourceKey)`
Sets the resource key of the static text of the label.
`void`
HighlightRuleHandle.`setTextLineThrough(String value)`
Sets the text line through property.
`void`
StyleHandle.`setTextLineThrough(String value)`
Sets one 'text-decoration' property to set line-through styles.
`void`
HighlightRuleHandle.`setTextOverline(String value)`
Sets the text overline property.
`void`
StyleHandle.`setTextOverline(String value)`
Sets one 'text-decoration' property to set overline styles.
`void`
HighlightRuleHandle.`setTextTransform(String value)`
Sets the text transform property.
`void`
StyleHandle.`setTextTransform(String value)`
Sets the value used to transform the text.
`void`
HighlightRuleHandle.`setTextUnderline(String value)`
Sets the text underline property.
`void`
StyleHandle.`setTextUnderline(String value)`
Sets one 'text-decoration' property to set underline styles.
`void`
ModuleHandleImpl.`setTheme(ThemeHandle theme)`
Sets the theme to a report.
`void`
ReportItemHandleImpl.`setTheme(ReportItemThemeHandle theme)`
Set the theme
`void`
ModuleHandleImpl.`setThemeName(String themeName)`
Sets the theme to a report.
`void`
ReportItemHandleImpl.`setThemeName(String themeName)`
Set the theme name
`void`
ComputedColumnHandle.`setTimeDimension(String timeDimension)`
Sets the time dimension string value.
`void`
StyleHandle.`setTimeFormat(String pattern)`
Sets the pattern of a date time format for a highlight rule.
`void`
StyleHandle.`setTimeFormatCategory(String pattern)`
Sets the category of a number format.
`final void`
ModuleHandleImpl.`setTitle(String title)`
Sets the title value.
`final void`
ModuleHandleImpl.`setTitleKey(String titleKey)`
Sets the title key.
`void`
GroupHandle.`setTocExpression(String expression)`
Deprecated.
`void`
ReportItemHandleImpl.`setTocExpression(String expression)`
Deprecated.
`void`
ActionHandle.`setToolTip(String toolTip)`
Sets the value of the tool tip.
`void`
EmbeddedImageHandle.`setType(String type)`
Sets the image type.
`void`
ExpressionHandle.`setType(String type)`
Sets the type of the expression.
`void`
FilterConditionElementHandle.`setType(String type)`
Sets the type of this filter condition.
`void`
FilterConditionHandle.`setType(String type)`
Sets the type of this filter condition.
`void`
OdaDataSetHandle.`setType(String type)`
Deprecated.
type has been replaced by extension ID
`void`
ReportItemThemeHandle.`setType(String type)`
Sets the type for this report item theme.
`void`
ScalarParameterHandle.`setType(String type)`
Deprecated.
Replaced by the method `AbstractScalarParameterHandleImpl.setDataType(String)`
`void`
VariableElementHandle.`setType(String workMode)`
Sets the value of work mode property.
`void`
ImageHandle.`setTypeExpression(String value)`
Sets the type expression value.
`void`
TimeIntervalHandle.`setUnit(String unit)`
Sets the unit of the time interval.
`void`
FilterConditionElementHandle.`setUpdateAggregation(boolean updateAggregation)`
Sets the updateAggregation flag of the filter condition.
`void`
FilterConditionHandle.`setUpdateAggregation(boolean updateAggregation)`
Sets the updateAggregation flag of the filter condition.
`void`
ActionHandle.`setURI(String uri)`
Sets the hyperlink of this action.
`void`
ImageHandle.`setURI(String uri)`
Deprecated.
should use `ImageHandle.setFile(String)` or `ImageHandle.setURL(String)`.
`void`
ImageHandle.`setURL(String url)`
Sets the image uri property.
`void`
ImageHandle.`setURL(Expression expr)`
Sets the image uri property by an expression.
`void`
ReportItemHandleImpl.`setURL(String url)`
Sets the url of this label item.
`void`
IncludedCssStyleSheetHandle.`setUseExternalCss(boolean useExternalCss)`
`void`
ParameterHandle.`setValidate(String validation)`
Sets the custom validation code for the parameter.
`void`
AggregationArgumentHandle.`setValue(String argumentValue)`
Sets the argument value.
`void`
ComplexValueHandle.`setValue(Object value)`
Sets the value of a property to the given value.
`void`
GroupPropertyHandle.`setValue(Object value)`
Set the object value on a group of elements.
`void`
MemberHandle.`setValue(Object value)`
`void`
MemberValueHandle.`setValue(String value)`
Sets the value of this member value.
`void`
PropertyHandleImpl.`setValue(Object value)`
Implementation of abstract method defined in base class.
`void`
SelectionChoiceHandle.`setValue(String value)`
Sets the data value for this choice.
`abstract void`
SimpleValueHandle.`setValue(Object value)`
Sets the value of a property or member to the object given.
`void`
VariableElementHandle.`setValue(String value)`
Sets the value of the variable.
`void`
FilterConditionElementHandle.`setValue1(String value1Expr)`
Sets the value 1 expression of this filter condition.
`void`
FilterConditionElementHandle.`setValue1(List value1List)`
Sets the value 1 expression list of this filter condition.
`void`
FilterConditionHandle.`setValue1(List value1List)`
Sets the value 1 expression list of this filter condition.
`void`
StyleRuleHandle.`setValue1(List value1List)`
Sets the value 1 expression list.
`void`
FilterConditionElementHandle.`setValue2(String value2Expr)`
Sets the value 2 expression of this filter condition.
`void`
FilterConditionHandle.`setValue2(Expression value2Expr)`
Sets the value 2 expression of this filter condition.
`void`
ScalarParameterHandle.`setValueColumn(String valueColumn)`
Deprecated.
Replaced by the method `AbstractScalarParameterHandleImpl.setValueExpr(String)`
`void`
AbstractScalarParameterHandleImpl.`setValueExpr(String valueExpr)`
Sets an expression on the data row from the dynamic list data set that returns the value for the choice.
`void`
DataItemHandle.`setValueExpr(String expr)`
Deprecated.
As of BIRT version 2.1.0, replaced by setResultSetColumn(String columnName)
`void`
TextDataHandle.`setValueExpr(String expr)`
Sets the expression that gives the text that this multi-line data item displays.
`void`
ImageHandle.`setValueExpression(String value)`
Sets the value expression value.
`void`
ColumnHintHandle.`setValueFormat(FormatValue format)`
Sets the value format of the column.
`void`
AbstractScalarParameterHandleImpl.`setValueType(String type)`
Sets the parameter value type for this scalar parameter.
`void`
VariableElementHandle.`setVariableName(String name)`
Sets the name of the variable.
`void`
StyleHandle.`setVerticalAlign(String value)`
Sets the value of the vertical align property for inline elements.
`void`
StyleHandle.`setWhiteSpace(String value)`
Sets the white space property for block elements.
`void`
StyleHandle.`setWidows(String value)`
Sets the widows property.
`void`
CellHandle.`setWidth(String width)`
Set the cell width based on unit string without locale handling
`void`
CellHandle.`setWidth(DimensionValue width)`
Set the cell width based on dimension value
`void`
ColumnHandle.`setWidth(String width)`
Set the column width based on unit string without locale handling
`void`
ColumnHandle.`setWidth(DimensionValue width)`
Set the column width based on dimension value
`void`
MasterPageHandle.`setWidth(String width)`
Set the master page width based on unit string without locale handling
`void`
MasterPageHandle.`setWidth(DimensionValue width)`
Set the master page width based on dimension value
`void`
ReportItemHandleImpl.`setWidth(double dimension)`
Sets the item's width to a value in default units.
`void`
ReportItemHandleImpl.`setWidth(String dimension)`
Sets the item's width using a dimension string with optional unit suffix such as "10" or "10pt".
`void`
StyleHandle.`setWidth(String width)`
Sets the value of width property.
`void`
TableHandle.`setWidthToFitColumns()`
Sets the width of the table to fit columns' widths with default dpi value.
`void`
TableHandle.`setWidthToFitColumns(int dpi)`
Sets the width of the table to fit columns' widths with the given dpi value.
`void`
ReportItemHandleImpl.`setX(double dimension)`
Sets the item's x position to a value in default units.
`void`
ReportItemHandleImpl.`setX(String dimension)`
Sets the item's x position using a dimension string with optional unit suffix such as "10" or "10pt".
`void`
ReportItemHandleImpl.`setY(double dimension)`
Sets the item's y position to a value in default units.
`void`
ReportItemHandleImpl.`setY(String dimension)`
Sets the item's y position using a dimension string with optional unit suffix such as "10" or "10pt".
`void`
ReportItemHandleImpl.`setZIndex(int zIndex)`
Sets the item's z position to an integer.
`final void`
ModuleHandleImpl.`shifIncludeScripts(int sourceIndex, int destIndex)`
Shifts included script from source position to destination position.
`void`
DesignElementHandle.`shift(String propName, DesignElementHandle content, int toPosn)`
Moves the position of a content element within this container.
`void`
GridHandle.`shiftColumn(int sourceColumn, int destColumn)`
Moves the column from `sourceColumn` to `destIndex` .
`void`
TableHandle.`shiftColumn(int sourceColumn, int destColumn)`
Moves the column from `sourceColumn` to `destIndex` .
`void`
TableHandle.`shiftColumn(int sourceColumn, int destColumn, boolean weakMode)`
Shift column
`void`
ModuleHandleImpl.`shiftLibrary(LibraryHandle library, int toPosn)`
Shifts the library to new position.
`void`
GridHandle.`shiftRow(RowOperationParameters parameters)`
Shifts table row to the given destination row with the given parameters.
`void`
TableHandle.`shiftRow(RowOperationParameters parameters)`
Shifts table row to the given destination row with the given parameters.
`final void`
ModuleHandleImpl.`shiftScriptLibs(int sourceIndex, int destIndex)`
Shifts jar file from source position to destination position.
`void`
TemplateDataSetHandle.`transformToDataSet(DataSetHandle dataSetHandle)`
Transforms the current template data set to the given real data set.
`void`
TemplateReportItemHandle.`transformToReportItem(ReportItemHandle reportItemHandle)`
Transforms the current template report item to the given real report item.

## Uses of SemanticException in org.eclipse.birt.report.model.api.command

Subclasses of SemanticException in org.eclipse.birt.report.model.api.command
Modifier and Type
Class
Description
`class`
`CircularExtendsException`
An error indicates circular extension while setting the extends property of an element.
`class`
`ContentException`
Reports an error during a container operation.
`class`
`CssException`
Included css style sheet exception
`class`
`CustomMsgException`
Reports an error during a user-defined message operation.
`class`
`EncryptionException`
Indicates an error when setting the name of an element.
`class`
`ExtendsException`
Indicates an error while setting the extends property of an element.
`class`
`ExtendsForbiddenException`
An error indicates not supported extension while setting the extends property of an element.
`class`
`InvalidParentException`
An error indicates invalid parent while setting the extends property of an element.
`class`
`LibraryException`
Indicates an error while operating with library.
`class`
`NameException`
Indicates an error when setting the name of an element.
`class`
`PropertyNameException`
Exception thrown when a property name is invalid.
`class`
`StyleException`
Indicates an error while setting the style of an element.
`class`
`TemplateException`
Reports an error during a template related operation.
`class`
`ThemeException`
Indicates an error while setting the style of an element.
`class`
`UserPropertyException`
Reports an error during a user property operation.
`class`
`WrongTypeException`
An error indicates wrong type while setting the extends property of an element.

## Uses of SemanticException in org.eclipse.birt.report.model.api.elements

Subclasses of SemanticException in org.eclipse.birt.report.model.api.elements
Modifier and Type
Class
Description
`class`
`SemanticError`
The class provides the error code and the element with semantic error.

## Uses of SemanticException in org.eclipse.birt.report.model.api.elements.structures

Methods in org.eclipse.birt.report.model.api.elements.structures that return types with arguments of type SemanticException
Modifier and Type
Method
Description
`List<SemanticException>`
ColumnHint.`validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)`
Validates this structure.
`List<SemanticException>`
HideRule.`validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)`
Validates this structure.
`List<SemanticException>`
PropertyBinding.`validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)`
`List<SemanticException>`
PropertyMask.`validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)`
`List<SemanticException>`
SortHint.`validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)`
Validates this structure.
Methods in org.eclipse.birt.report.model.api.elements.structures that throw SemanticException
Modifier and Type
Method
Description
`void`
TOC.`setExpression(String expression)`
Sets toc expression.

## Uses of SemanticException in org.eclipse.birt.report.model.api.extension

Subclasses of SemanticException in org.eclipse.birt.report.model.api.extension
Modifier and Type
Class
Description
`class`
`ExtendedElementException`
Base class for all peer-provided exceptions.
Fields in org.eclipse.birt.report.model.api.extension with type parameters of type SemanticException
Modifier and Type
Field
Description
`protected List<SemanticException>`
CompatibilityStatus.`errors`
List of the errors after checking compatibilities.
Methods in org.eclipse.birt.report.model.api.extension that return types with arguments of type SemanticException
Modifier and Type
Method
Description
`List<SemanticException>`
CompatibilityStatus.`getErrors()`
Gets the error list of this status after checking the compatibilities.
`List<SemanticException>`
IReportItem.`validate()`
Performs a semantic check on the report item.
`List<SemanticException>`
ReportItem.`validate()`
Method parameters in org.eclipse.birt.report.model.api.extension with type arguments of type SemanticException
Modifier and Type
Method
Description
`void`
CompatibilityStatus.`setErrors(List<SemanticException> errors)`
Sets the error list of this status.
Methods in org.eclipse.birt.report.model.api.extension that throw SemanticException
Modifier and Type
Method
Description
`void`
MultiRowItem.`addDataBinding(IDataBinding binding)`
`void`
SimpleRowItem.`addDataBinding(IDataBinding binding)`
`void`
MultiRowItem.`addFilterCondition(IFilterCondition condition)`
`void`
MultiRowItem.`addHideRule(IHideRule rule)`
`void`
SimpleRowItem.`addHideRule(IHideRule rule)`
`void`
MultiRowItem.`addHighlightRule(IHighlightRule rule)`
`void`
SimpleRowItem.`addHighlightRule(IHighlightRule rule)`
`void`
MultiRowItem.`addSortCondition(ISortCondition condition)`
`void`
MultiRowItem.`removeDataBinding(String bindingName)`
`void`
SimpleRowItem.`removeDataBinding(String bindingName)`
`void`
MultiRowItem.`removeDataBindings()`
`void`
SimpleRowItem.`removeDataBindings()`
`void`
MultiRowItem.`removeFilterCondition(IFilterCondition condition)`
`void`
MultiRowItem.`removeFilterConditions()`
`void`
MultiRowItem.`removeHideRule(IHideRule rule)`
`void`
SimpleRowItem.`removeHideRule(IHideRule rule)`
`void`
MultiRowItem.`removeHideRules()`
`void`
SimpleRowItem.`removeHideRules()`
`void`
MultiRowItem.`removeHighlightRule(IHighlightRule rule)`
`void`
SimpleRowItem.`removeHighlightRule(IHighlightRule rule)`
`void`
MultiRowItem.`removeHighlightRules()`
`void`
SimpleRowItem.`removeHighlightRules()`
`void`
MultiRowItem.`removeSortCondition(ISortCondition condition)`
`void`
MultiRowItem.`removeSortConditions()`
`void`
MultiRowItem.`setBookmark(String value)`
`void`
SimpleRowItem.`setBookmark(String value)`
`void`
MultiRowItem.`setComments(String theComments)`
`void`
SimpleRowItem.`setComments(String theComments)`
`void`
MultiRowItem.`setCurrentView(IDesignElement viewElement)`
`void`
SimpleRowItem.`setCurrentView(IDesignElement viewElement)`
`void`
MultiRowItem.`setCustomXml(String customXml)`
`void`
SimpleRowItem.`setCustomXml(String customXml)`
`void`
MultiRowItem.`setDisplayName(String displayName)`
`void`
SimpleRowItem.`setDisplayName(String displayName)`
`void`
MultiRowItem.`setDisplayNameKey(String displayNameKey)`
`void`
SimpleRowItem.`setDisplayNameKey(String displayNameKey)`
`void`
MultiRowItem.`setHeight(double dimension)`
`void`
MultiRowItem.`setHeight(String dimension)`
`void`
SimpleRowItem.`setHeight(double dimension)`
`void`
SimpleRowItem.`setHeight(String dimension)`
`void`
MultiRowItem.`setName(String name)`
`void`
SimpleRowItem.`setName(String name)`
`void`
MultiRowItem.`setNamedExpression(String name, String exp)`
`void`
SimpleRowItem.`setNamedExpression(String name, String exp)`
`void`
MultiRowItem.`setTocExpression(String expression)`
`void`
SimpleRowItem.`setTocExpression(String expression)`
`void`
MultiRowItem.`setUserProperty(String name, Object value, String type)`
`void`
MultiRowItem.`setUserProperty(String name, String value)`
`void`
SimpleRowItem.`setUserProperty(String name, Object value, String type)`
`void`
SimpleRowItem.`setUserProperty(String name, String value)`
`void`
MultiRowItem.`setWidth(double dimension)`
`void`
MultiRowItem.`setWidth(String dimension)`
`void`
SimpleRowItem.`setWidth(double dimension)`
`void`
SimpleRowItem.`setWidth(String dimension)`
`void`
MultiRowItem.`setX(double dimension)`
`void`
MultiRowItem.`setX(String dimension)`
`void`
SimpleRowItem.`setX(double dimension)`
`void`
SimpleRowItem.`setX(String dimension)`
`void`
MultiRowItem.`setY(double dimension)`
`void`
MultiRowItem.`setY(String dimension)`
`void`
SimpleRowItem.`setY(double dimension)`
`void`
SimpleRowItem.`setY(String dimension)`
Constructor parameters in org.eclipse.birt.report.model.api.extension with type arguments of type SemanticException
Modifier
Constructor
Description
``
`CompatibilityStatus(List<? extends SemanticException> errors, int type)`
Constructs this status with the error list and the type.

## Uses of SemanticException in org.eclipse.birt.report.model.api.metadata

Subclasses of SemanticException in org.eclipse.birt.report.model.api.metadata
Modifier and Type
Class
Description
`class`
`PropertyValueException`
Indicates an invalid property value.
`class`
`ValidationValueException`
Indicates an invalid validation value.

## Uses of SemanticException in org.eclipse.birt.report.model.api.olap

Methods in org.eclipse.birt.report.model.api.olap that throw SemanticException
Modifier and Type
Method
Description
`DimensionConditionHandle`
TabularCubeHandle.`addDimensionCondition(DimensionCondition condition)`
Adds a dimension condition to this cube.
`DimensionConditionHandle`
TabularCubeHandle.`addDimensionCondition(DimensionCondition condition, int posn)`
Adds a dimension condition to the specified position.
`void`
CubeHandle.`addFilter(FilterCondition fc)`
Adds the filter condition.
`void`
TabularCubeHandle.`removeDimensionCondition(DimensionConditionHandle conditionHandle)`
`void`
TabularCubeHandle.`removeDimensionCondition(DimensionCondition condition)`
Removes a dimension condition from this cube.
`void`
CubeHandle.`removeFilter(FilterCondition fc)`
Removes the filter condition.
`ActionHandle`
LevelHandle.`setAction(Action action)`
Set an action on the level.
`ActionHandle`
MeasureHandle.`setAction(Action action)`
Set an action on the measure.
`void`
LevelHandle.`setAlignment(String alignment)`
Sets the alignment of the level.
`void`
MeasureHandle.`setAlignment(String alignment)`
Sets the alignment of the measure.
`void`
TabularCubeHandle.`setAutoPrimaryKey(boolean autoKey)`
Sets the status whether to generate a primary key for elements that use this cube so that user no longer need to set the aggregation for measure.
`void`
MeasureHandle.`setCalculated(boolean isCalculated)`
Sets whether this measure is computed by other measures or not.
`void`
TabularLevelHandle.`setColumnName(String columnName)`
Sets the column name for this level.
`void`
TabularCubeHandle.`setDataSet(DataSetHandle handle)`
Sets the data set of this cube.
`void`
TabularHierarchyHandle.`setDataSet(DataSetHandle handle)`
Sets the data set of this hierarchy.
`void`
LevelHandle.`setDataType(String dataType)`
Sets the data type of this level.
`void`
MeasureHandle.`setDataType(String dataType)`
Sets the data type of this measure.
`void`
LevelHandle.`setDateTimeFormat(String dateTimeFormat)`
Sets the date-time format of this level.
`void`
LevelHandle.`setDateTimeLevelType(String dateTimeType)`
Sets the date-time type of this level.
`void`
DimensionHandle.`setDefaultHierarchy(HierarchyHandle defaultHierarchy)`
Sets the default hierarchy for this dimension.
`void`
CubeHandle.`setDefaultMeasureGroup(MeasureGroupHandle defaultMeasureGroup)`
Deprecated.
`void`
LevelHandle.`setDefaultValue(String defaultValue)`
Sets the default value of this level.
`void`
TabularLevelHandle.`setDisplayColumnName(String columnName)`
Sets the display column name for this level.
`void`
LevelHandle.`setFormat(FormatValue format)`
Sets the format of the level.
`void`
MeasureHandle.`setFormat(FormatValue format)`
Sets the format of the measure.
`void`
MeasureHandle.`setFunction(String function)`
Sets the function for this measure.
`void`
LevelHandle.`setInterval(String interval)`
Returns the interval of this level.
`void`
LevelHandle.`setIntervalBase(String intervalBase)`
Sets the base of the interval property of this level.IntervalBase, in conjunction with Interval and IntervalRange, determines how data is divided into levels.
`void`
LevelHandle.`setIntervalRange(double intervalRange)`
Returns the interval range of this level.
`void`
LevelHandle.`setIntervalRange(String intervalRange)`
Sets the interval range of this level.
`void`
LevelHandle.`setLevelType(String levelType)`
Sets the level type.
`void`
MeasureHandle.`setMeasureExpression(String expression)`
Sets the measure expression for this measure.
`void`
OdaCubeHandle.`setNativeName(String nativeName)`
Sets the ODA defined cube name.
`void`
OdaDimensionHandle.`setNativeName(String nativeName)`
Sets the ODA defined cube name.
`void`
OdaHierarchyHandle.`setNativeName(String nativeName)`
Sets the ODA defined cube name.
`void`
TabularDimensionHandle.`setSharedDimension(DimensionHandle handle)`
Sets the dimension object this dimension refers to.
`void`
DimensionHandle.`setTimeType(boolean isTimeType)`
Sets the status to indicate whether this dimension is a special type of Time.
`void`
MeasureHandle.`setVisible(boolean isVisible)`
Sets the status whether the measure element is visible or not.

## Uses of SemanticException in org.eclipse.birt.report.model.api.simpleapi

Methods in org.eclipse.birt.report.model.api.simpleapi that throw SemanticException
Modifier and Type
Method
Description
`void`
IDataItem.`addAction(IAction action)`
Add the action structure to this Data item.
`void`
IImage.`addAction(IAction action)`
Add the action structure to this Image item.
`void`
ILabel.`addAction(IAction action)`
Add the action structure to this Label item.
`void`
IReportItem.`addDataBinding(IDataBinding binding)`
Add ComputedColumn.name , expression of IDataBinding are required.
`void`
IMultiRowItem.`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`
IMultiRowItem.`addSortCondition(ISortCondition condition)`
Adds sort condition.key of ISortCondition is required.
`void`
IReportItem.`removeDataBinding(String bindingName)`
Removes special column binding
`void`
IReportItem.`removeDataBindings()`
Removes all column bindings
`void`
IMultiRowItem.`removeFilterCondition(IFilterCondition condition)`
Removes filter condition.
`void`
IMultiRowItem.`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`
IMultiRowItem.`removeSortCondition(ISortCondition condition)`
Removes sort condition.
`void`
IMultiRowItem.`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`
IStyle.`setBackgroundAttachment(String value)`
Sets the background attachment.
`void`
IStyle.`setBackgroundColor(String color)`
Set the background color.
`void`
IHighlightRule.`setBackGroundColor(String color)`
Sets backgroudcolor
`void`
IStyle.`setBackgroundHeight(String value)`
Set the background height of the background image.
`void`
IStyle.`setBackgroundImage(String value)`
Sets the address of the background image.
`void`
IStyle.`setBackgroundImageType(String value)`
Sets the source type of the background image.
`void`
IStyle.`setBackGroundPositionX(String x)`
Set the x position for the background.
`void`
IStyle.`setBackGroundPositionY(String y)`
Set the y position for the background.
`void`
IStyle.`setBackgroundRepeat(String value)`
Sets the repeat pattern for a background image.
`void`
IStyle.`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`
IStyle.`setBorderBottomColor(String color)`
Set the color of the bottom side of the border.
`void`
IStyle.`setBorderBottomStyle(String value)`
Sets the style of the bottom line of the border.
`void`
IStyle.`setBorderBottomWidth(String width)`
Set the width of the bottom side of the border.
`void`
IStyle.`setBorderLeftColor(String color)`
Set the color of the left side of the border.
`void`
IStyle.`setBorderLeftStyle(String value)`
Sets the style of the left line of the border.
`void`
IStyle.`setBorderLeftWidth(String width)`
Set the width of left side of the border.
`void`
IStyle.`setBorderRightColor(String color)`
Set the color of the right side of the border.
`void`
IStyle.`setBorderRightStyle(String value)`
Sets the style of the right line of the border.
`void`
IStyle.`setBorderRightWidth(String width)`
Set the width of the right side of the border.
`void`
IStyle.`setBorderTopColor(String color)`
Set the color of the top side of the border.
`void`
IStyle.`setBorderTopStyle(String value)`
Sets the style of the top line of the border.
`void`
IStyle.`setBorderTopWidth(String width)`
Set the width of the top side of the border.
`void`
IStyle.`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`
IStyle.`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`
IStyle.`setDateTimeFormat(String pattern)`
Sets the pattern of a date time format for a highlight rule.
`void`
IStyle.`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`
ISortElement.`setDirection(String direction)`
Sets the sort direction.
`void`
IStyle.`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`
IFilterConditionElement.`setExpr(String filterExpr)`
Sets the filter expression.
`void`
IDataBinding.`setExpression(String expression)`
Sets expression of column binding.
`void`
IExpression.`setExpression(Object expr)`
Sets the raw expression if the type is not constant.
`void`
IDataBinding.`setExpressionType(String expressionType)`
Sets the expression type of the column binding.
`void`
IImage.`setFile(String file)`
Sets the image file.
`void`
IFilterConditionElement.`setFilterTarget(String filterTarget)`
Sets the filter target.
`void`
IStyle.`setFontFamily(String fontFamily)`
Set the font family.
`void`
IStyle.`setFontSize(String fontSize)`
Set the font size.
`void`
IHighlightRule.`setFontStyle(String style)`
Sets font style
`void`
IStyle.`setFontStyle(String fontStyle)`
Sets the style of the font.
`void`
IStyle.`setFontVariant(String fontVariant)`
Sets the variant of the font.
`void`
IHighlightRule.`setFontWeight(String weight)`
Sets font weight.
`void`
IStyle.`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`
IStyle.`setHeight(String height)`
Sets the value of height property.
`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`
ISortElement.`setKey(String key)`
Sets an expression that gives the sort key on which to sort.
`void`
IGroup.`setKeyExpr(String expr)`
Sets the group expression.
`void`
IStyle.`setLetterSpacing(String spacing)`
Set the spacing between individual letters.
`void`
IStyle.`setLineHeight(String height)`
Set the height of a line.
`void`
IAction.`setLinkType(String type)`
Sets the link type of the action.
`void`
IStyle.`setMarginBottom(String margin)`
Set the margin of the bottom side.
`void`
IStyle.`setMarginLeft(String margin)`
Set the margin of the left side.
`void`
IStyle.`setMarginRight(String margin)`
Set the margin of the right side.
`void`
IStyle.`setMarginTop(String margin)`
Set the margin of the top side.
`void`
IStyle.`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`
IStyle.`setNumberFormat(String pattern)`
Sets the pattern of a number format.
`void`
IStyle.`setNumberFormatCategory(String category)`
Sets the category of a number format for a highlight rule.
`void`
IFilterCondition.`setOperator(String operator)`
Sets operator
`void`
IFilterConditionElement.`setOperator(String operator)`
Sets the operator of this filter condition.
`void`
IHighlightRule.`setOperator(String operator)`
Sets Operator
`void`
IFilterConditionElement.`setOptional(boolean isOptional)`
Sets the optional status for this filter condition.
`void`
IStyle.`setOrphans(String value)`
Sets the orphans property.
`void`
IStyle.`setOverflow(String value)`
Sets the value of overflow property.
`void`
IStyle.`setPaddingBottom(String padding)`
Set the padding of the bottom side.
`void`
IStyle.`setPaddingLeft(String padding)`
Set the padding of the left side.
`void`
IStyle.`setPaddingRight(String padding)`
Set the padding of the right side.
`void`
IStyle.`setPaddingTop(String padding)`
Set the padding of the top side.
`void`
IGroup.`setPageBreakAfter(String value)`
Sets the value for break after property.
`void`
IStyle.`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`
IStyle.`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`
IStyle.`setPageBreakInside(String value)`
Sets the page break inside property for block-level elements.
`void`
IMasterPage.`setPageType(String pageType)`
Sets page size type.
`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`
IStyle.`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`
IStyle.`setStringFormat(String pattern)`
Sets the pattern of a string format.
`void`
IStyle.`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`
IStyle.`setTextAlign(String value)`
Sets the text align for block-level elements.
`void`
IStyle.`setTextDirection(String value)`
Sets the Bidi direction property.
`void`
IStyle.`setTextIndent(String indent)`
Set the text indent.
`void`
ILabel.`setTextKey(String resourceKey)`
Sets the resource key of the static text of the label.
`void`
IStyle.`setTextLineThrough(String value)`
Sets one 'text-decoration' property to set line-through styles.
`void`
IStyle.`setTextOverline(String value)`
Sets one 'text-decoration' property to set overline styles.
`void`
IStyle.`setTextTransform(String value)`
Sets the value used to transform the text.
`void`
IStyle.`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`
IExpression.`setType(String type)`
Sets the type of the expression.
`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`
IFilterConditionElement.`setValue1(List value1List)`
Sets the value 1 expression list of this filter condition.
`void`
IHighlightRule.`setValue1(String value1)`
Sets Value1
`void`
IFilterCondition.`setValue2(String value2)`
Sets value2
`void`
IFilterConditionElement.`setValue2(String value2Expr)`
Sets the value 2 expression of this filter condition.
`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`
IStyle.`setVerticalAlign(String value)`
Sets the value of the vertical align property for inline elements.
`void`
IStyle.`setWhiteSpace(String value)`
Sets the white space property for block elements.
`void`
IStyle.`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`
IStyle.`setWidth(String width)`
Sets the value of width property.
`void`
IStyle.`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 SemanticException in org.eclipse.birt.report.model.api.util

Methods in org.eclipse.birt.report.model.api.util that return types with arguments of type SemanticException
Modifier and Type
Method
Description
`List<SemanticException>`
IPasteStatus.`getErrors()`
Methods in org.eclipse.birt.report.model.api.util that throw SemanticException
Modifier and Type
Method
Description
`static ComputedColumnHandle`
ColumnBindingUtil.`addColumnBinding(ReportItemHandle handle, ComputedColumn column)`
Binds a column to the given element.
`static void`
CompatibilityUtil.`addResultSetColumn(DataSetHandle dataSetHandle, List columns)`
Adds ResultSetColumn without sending out event.
`static void`
CompatibilityUtil.`addStructures(PropertyHandle propHandle, List structures)`
Adds the given structures to the corresponding property values.
`static void`
ElementExportUtilImpl.`exportDesign(ReportDesignHandle designToExport, String libraryFileName, boolean canOverride, boolean genDefaultName)`
Export the report design to a library file specified by the file name.
`static void`
ElementExportUtilImpl.`exportDesign(ReportDesignHandle designToExport, LibraryHandle targetLibraryHandle, boolean canOverride, boolean genDefaultName)`
Exports one design to library.
`static void`
ElementExportUtilImpl.`exportElement(DesignElementHandle elementToExport, String libraryFileName, boolean canOverride)`
Exports the given element into one library file.
`static void`
ElementExportUtilImpl.`exportElement(DesignElementHandle elementToExport, LibraryHandle targetLibraryHandle, boolean canOverride)`
Exports the given element into one library.
`static void`
ElementExportUtilImpl.`exportElements(List elementsToExport, String libraryFileName, boolean canOverride)`
Exports the given element list into one library file.
`static void`
ElementExportUtilImpl.`exportStructure(StructureHandle structToExport, String libraryFileName, boolean canOverride)`
Exports the given structure into one library.
`static void`
ElementExportUtilImpl.`exportStructure(StructureHandle structToExport, LibraryHandle targetLibraryHandle, boolean canOverride)`
Exports the given structure into one library.
`static void`
ElementExportUtilImpl.`exportStructures(List structsToExport, String libraryFileName, boolean canOverride)`
Exports the given structure into one library.
`static void`
ElementExportUtilImpl.`exportStyle(StyleHandle styleToExport, ThemeHandle themeHandle, boolean canOverride)`
Exports the given style into selected theme.
`static List`
CopyUtil.`paste(IElementCopy copy, DesignElementHandle container, int slotID)`
Pastes a report item to the slot.
`static List`
CopyUtil.`paste(IElementCopy copy, DesignElementHandle container, int slotID, int newPos)`
Pastes a report item to the slot.
`static List`
CopyUtil.`paste(IElementCopy copy, DesignElementHandle container, String propName)`
Pastes a report item to the slot.
`static List`
CopyUtil.`paste(IElementCopy copy, DesignElementHandle container, String propName, int newPos)`
Pastes a report item to the slot.
`static void`
CompatibilityUtil.`updateResultSetinCachedMetaData(DataSetHandle setHandle, List resultColumns)`
Updates CachedMetaData.resultSet property with the given data set and the list of result set columns.
`static Object`
PropertyValueValidationUtil.`validateProperty(DesignElementHandle element, String propName, Object propValue)`
Validates a value to be stored for the given property.

## Uses of SemanticException in org.eclipse.birt.report.model.api.validators

Methods in org.eclipse.birt.report.model.api.validators that return types with arguments of type SemanticException
Modifier and Type
Method
Description
`List<SemanticException>`
BookmarkValidator.`validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)`
`List<SemanticException>`
CascadingParameterTypeValidator.`validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)`
Validates whether the type of the parameter is valid.
`List<SemanticException>`
CellOverlappingValidator.`validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)`
Validates whether any cell in the given row overlaps others.
`List<SemanticException>`
DataSetRequiredValidator.`validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)`
Validates whether the data set of the given listing element is provided.
`List<SemanticException>`
DataSetResultSetValidator.`validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)`
Deprecated.
Validates whether the result set of the given data set has no column defined.
`List<SemanticException>`
ElementReferenceValidator.`validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element, String propName)`
Validates the element reference value can refer to an actual element.
`List<SemanticException>`
ExtensionValidator.`validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)`
Validates whether any cell in the given row overlaps others.
`List<SemanticException>`
GroupNameValidator.`validate(ListingHandle element)`
Validates whether the given element contains the duplicate group name.
`List<SemanticException>`
GroupNameValidator.`validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)`
Validates whether the given element contains the duplicate group name.
`List<SemanticException>`
ImageDataValidator.`validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement image)`
`List<SemanticException>`
IncludedCssStyleSheetValidator.`validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)`
`List<SemanticException>`
IncludedLibraryValidator.`validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)`
`List<SemanticException>`
InconsistentColumnsValidator.`validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)`
Validates whether the page size is invalid.
`List<SemanticException>`
MasterPageContextContainmentValidator.`validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)`
Validates whether the given element can recursively resides in the specific slot of specific container type.
`List<SemanticException>`
MasterPageMultiColumnValidator.`validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)`
Validates whether multiple columns and content width are consistent.
`List<SemanticException>`
MasterPageRequiredValidator.`validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)`
Validates whether the given report has one master page.
`List<SemanticException>`
MasterPageSizeValidator.`validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)`
Validates whether the page size is invalid.
`List<SemanticException>`
MasterPageTypeValidator.`validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)`
Validates whether the page type and size are consistent.
`List<SemanticException>`
SimpleListValidator.`validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element, String propName)`
Validates whether the list property specified by `propName` is invalid.
`List<SemanticException>`
StructureListValidator.`validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element, String propName)`
Validates whether the list property specified by `propName` is invalid.
`List<SemanticException>`
StyleReferenceValidator.`validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)`
Validates the style reference value can refer to an actual style.
`List<SemanticException>`
TableHeaderContextContainmentValidator.`validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)`
Validates whether the given element can recursively resides in the specific slot of specific container type.
`List<SemanticException>`
ThemeReferenceValidator.`validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)`
Validates the theme reference value can refer to an actual theme.
`List<SemanticException>`
ThemeStyleNameValidator.`validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)`
`List<SemanticException>`
UnsupportedElementValidator.`validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)`
`List<SemanticException>`
ValueRequiredValidator.`validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element, String propName)`
Validates whether value is set for the given required property.
`List<SemanticException>`
MasterPageContextContainmentValidator.`validateForAdding(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.ContainerContext containerInfo, org.eclipse.birt.report.model.core.DesignElement toAdd)`
Validates whether the given element can recursively resides in the specific slot of specific container type when trying to add an element.
`List<SemanticException>`
MasterPageContextContainmentValidator.`validateForAdding(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element, int slotId, org.eclipse.birt.report.model.core.DesignElement toAdd)`
Deprecated.
since birt2.2, replaced by `MasterPageContextContainmentValidator.validateForAdding(Module, ContainerContext, DesignElement)`
`List<SemanticException>`
MasterPageContextContainmentValidator.`validateForAdding(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element, IElementDefn toAdd)`
Validates whether the given element can recursively resides in the specific slot of specific container type when trying to add an element.
`List<SemanticException>`
SimpleListValidator.`validateForAdding(DesignElementHandle element, IPropertyDefn propDefn, List<Object> list, Object toAdd)`
Validates whether a new item can be added to the simple value list.
`List<SemanticException>`
StructureListValidator.`validateForAdding(DesignElementHandle element, IPropertyDefn propDefn, List<Object> list, IStructure toAdd)`
Validates whether a new structure can be added to structure list.
`List<SemanticException>`
TableHeaderContextContainmentValidator.`validateForAdding(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.ContainerContext containerInfo, org.eclipse.birt.report.model.core.DesignElement toAdd)`
Validates whether the given element can recursively resides in the specific slot of specific container type when trying to add an element.
`List<SemanticException>`
TableHeaderContextContainmentValidator.`validateForAdding(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element, int slotId, org.eclipse.birt.report.model.core.DesignElement toAdd)`
Deprecated.
since birt2.2, replaced by `TableHeaderContextContainmentValidator.validateForAdding(Module, ContainerContext, DesignElement)`
`List<SemanticException>`
TableHeaderContextContainmentValidator.`validateForAdding(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element, IElementDefn toAdd)`
Validates whether the given element can recursively resides in the specific slot of specific container type when trying to add an element.
`List<SemanticException>`
GroupNameValidator.`validateForAddingGroup(ListingHandle element, String groupName)`
Validates whether the group with the given name can be added into the given listing element.
`List<SemanticException>`
ThemeStyleNameValidator.`validateForAddingStyle(AbstractThemeHandle theme, String styleName)`
Validates whether the style with the given name can be added into the given theme element.
`List<SemanticException>`
StructureListValidator.`validateForRenaming(DesignElementHandle element, IPropertyDefn propDefn, List<Object> list, IStructure toRenamed, IPropertyDefn memberDefn, String newName)`
Validates whether a structure can be renamed to the given name.
`List<SemanticException>`
GroupNameValidator.`validateForRenamingGroup(ListingHandle element, GroupHandle group, String groupName)`
Validates whether the group can be renamed to the given name.
`List<SemanticException>`
ThemeStyleNameValidator.`validateForRenamingStyle(AbstractThemeHandle theme, StyleHandle style, String styleName)`
Validates whether the style can be renamed to the given name.