Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV NEXT | FRAMES NO FRAMES

## Deprecated API

Contents

- Deprecated Classes
- Deprecated Fields
- Deprecated Methods

Deprecated Classes
org.eclipse.birt.report.engine.api.HTMLEmitterConfig since 2.2, use HTMLRenderOption or RenderOption directly
org.eclipse.birt.report.engine.api.HTMLRenderContext set the property to RenderOption directly.
org.eclipse.birt.report.engine.api.PDFRenderContext set the option to RenderOption directly.
org.eclipse.birt.report.engine.api.RenderOptionBase use RenderOption instead

Deprecated Fields
org.eclipse.birt.report.engine.api.EngineConstants.APPCONTEXT_CHART_PRINT_RESOLUTION use APPCONTEXT_CHART_RESOLUTION instead of APPCONTEXT_CHART_PRINT_RESOLUTION
org.eclipse.birt.report.engine.api.IPDFRenderOption.FIT_TO_PAGE Scale the content to fit into the page, when the content exceeds page size. This property has been deprecated, please set PAGE_OVERFLOW = FIT_TO_PAGE_SIZE instead.
org.eclipse.birt.report.engine.api.IPDFRenderOption.FONT_DIRECTORY define the font directory used by PDF.
org.eclipse.birt.report.engine.api.IHTMLRenderOption.HTML_INCLUDE_SELECTION_HANDLE use METADATA
org.eclipse.birt.report.engine.content.IImageContent.IMAGE_URI replaced by IMAGE_URL
org.eclipse.birt.report.engine.api.IPDFRenderOption.IS_EMBEDDED_FONT should the true-type font be embedded into the generated PDF file.
org.eclipse.birt.report.engine.api.IPDFRenderOption.PAGEBREAK_PAGINATION_ONLY The flag to indicate whether PDF layout use auto page break or not. if it is set to true, then auto page break will not take effect. This property has been deprecated, please set PAGE_OVERFLOW = OUTPUT_TO_MULTIPLE_PAGES instead.

Deprecated Methods
org.eclipse.birt.report.engine.api.EngineConfig.addScriptableJavaObject(String, Object) the user need add the object to the appContext directly.
org.eclipse.birt.report.engine.api.IEngineTask.addScriptableJavaObject(String, Object) user should add it to appContext.
org.eclipse.birt.report.engine.api.IScalarParameterDefn.allowBlank()
org.eclipse.birt.report.engine.api.IScalarParameterDefn.allowNull()
org.eclipse.birt.report.engine.api.IEngineTask.cancel(Object) user should use cancel() instead.
org.eclipse.birt.report.engine.api.IGetParameterDefinitionTask.evaluateDefaults() use getDefaultParameterValues() directly.
org.eclipse.birt.report.engine.api.IGetParameterDefinitionTask.evaluateQuery(String) This api has no use.
org.eclipse.birt.report.engine.api.IRenderOption.getActionHandle()
org.eclipse.birt.report.engine.api.RenderOption.getActionHandle()
org.eclipse.birt.report.engine.api.IResultMetaData.getColumnAlias(int) it's not supported now
org.eclipse.birt.report.engine.api.EngineConfig.getConfigMap() use getProperties() instead.
org.eclipse.birt.report.engine.content.IPageContent.getContentComputedStyle() use getPageBody().getComputedStyle()
org.eclipse.birt.report.engine.content.IPageContent.getContentStyle() use getPageBody().getStyle()
org.eclipse.birt.report.engine.api.IPDFRenderOption.getFontDirectory()
org.eclipse.birt.report.engine.api.PDFRenderOption.getFontDirectory()
org.eclipse.birt.report.engine.api.IRenderOption.getImageHandle()
org.eclipse.birt.report.engine.api.RenderOption.getImageHandle()
org.eclipse.birt.report.engine.api.HTMLRenderOption.getIncludeSelectionHandle() includeSelectionHandle is replaced by eanableMetadata flag.
org.eclipse.birt.report.engine.api.IHTMLRenderOption.getIncludeSelectionHandle() includeSelectionHandle is replaced by eanableMetadata flag.
org.eclipse.birt.report.engine.api.EngineConfig.getMaxRowsPerQuery()
org.eclipse.birt.report.engine.api.IDataExtractionTask.getMetaData()
org.eclipse.birt.report.engine.api.IRenderOption.getOutputSetting() use getOptions instead
org.eclipse.birt.report.engine.api.RenderOption.getOutputSetting() user should always use the get/set to change the setting.
org.eclipse.birt.report.engine.api.IGetParameterDefinitionTask.getParameter(String)
org.eclipse.birt.report.engine.api.IGetParameterDefinitionTask.getParameters()
org.eclipse.birt.report.engine.emitter.IEmitterServices.getRenderContext() the user should use getReportContext().getRenderContext() to get the render options.
org.eclipse.birt.report.engine.extension.IReportItemQuery.getReportQueries(IBaseQueryDefinition) since 2.2
org.eclipse.birt.report.engine.api.EngineConfig.getScriptObjects() use getAppContext() instead.
org.eclipse.birt.report.engine.api.IParameterDefn.getSelectionList()
org.eclipse.birt.report.engine.api.EngineConfig.getServletContext() use getPlatformContext instead
org.eclipse.birt.report.engine.content.IReportContent.getTOC() This method shoule be substituted by: `getTOCTree( format, locale ).getTOCTree( );`
org.eclipse.birt.report.engine.extension.IDataExtractionExtension.initilize(IReportContext, IDataExtractionOption)
org.eclipse.birt.report.engine.content.IHyperlinkAction.isBookmark() replaced by IDrillThroughAction.isBookmark(); Return the bookmark type set in the drillthrough action. The return result indicated the target element is a toc or not.
org.eclipse.birt.report.engine.api.IPDFRenderOption.isEmbededFont()
org.eclipse.birt.report.engine.api.HTMLCompleteImageHandler.onCustomImage(IImage, Object)
org.eclipse.birt.report.engine.api.HTMLImageHandler.onCustomImage(IImage, Object)
org.eclipse.birt.report.engine.api.HTMLServerImageHandler.onCustomImage(IImage, Object)
org.eclipse.birt.report.engine.api.IHTMLImageHandler.onCustomImage(IImage, Object)
org.eclipse.birt.report.engine.api.HTMLCompleteImageHandler.onDesignImage(IImage, Object)
org.eclipse.birt.report.engine.api.HTMLImageHandler.onDesignImage(IImage, Object)
org.eclipse.birt.report.engine.api.HTMLServerImageHandler.onDesignImage(IImage, Object)
org.eclipse.birt.report.engine.api.IHTMLImageHandler.onDesignImage(IImage, Object)
org.eclipse.birt.report.engine.api.HTMLCompleteImageHandler.onDocImage(IImage, Object)
org.eclipse.birt.report.engine.api.HTMLImageHandler.onDocImage(IImage, Object)
org.eclipse.birt.report.engine.api.HTMLServerImageHandler.onDocImage(IImage, Object)
org.eclipse.birt.report.engine.api.IHTMLImageHandler.onDocImage(IImage, Object)
org.eclipse.birt.report.engine.api.HTMLCompleteImageHandler.onFileImage(IImage, Object)
org.eclipse.birt.report.engine.api.HTMLImageHandler.onFileImage(IImage, Object)
org.eclipse.birt.report.engine.api.HTMLServerImageHandler.onFileImage(IImage, Object)
org.eclipse.birt.report.engine.api.IHTMLImageHandler.onFileImage(IImage, Object)
org.eclipse.birt.report.engine.extension.IReportItemGeneration.onRowSets(IRowSet[]) since BIRT 2.3
org.eclipse.birt.report.engine.extension.IReportItemPresentation.onRowSets(IRowSet[]) since BIRT 2.3
org.eclipse.birt.report.engine.api.HTMLCompleteImageHandler.onURLImage(IImage, Object)
org.eclipse.birt.report.engine.api.HTMLImageHandler.onURLImage(IImage, Object)
org.eclipse.birt.report.engine.api.HTMLServerImageHandler.onURLImage(IImage, Object)
org.eclipse.birt.report.engine.api.IHTMLImageHandler.onURLImage(IImage, Object)
org.eclipse.birt.report.engine.api.IRenderTask.render(InstanceID) A page which contains the instance can be rendered like this: `setInstanceID( instanceID );` `render( );`
org.eclipse.birt.report.engine.api.IRenderTask.render(long) A page with speicfic page number can be rendered like this: `setPageNumber( pageNumber );` `render( );`
org.eclipse.birt.report.engine.api.IRenderTask.render(String) A range of pages can be rendered like this: `setPageRange( pageRange );` `render( );`
org.eclipse.birt.report.engine.api.IRunTask.run(FolderArchive)
org.eclipse.birt.report.engine.api.IRenderOption.setActionHandle(IHTMLActionHandler)
org.eclipse.birt.report.engine.api.RenderOption.setActionHandle(IHTMLActionHandler)
org.eclipse.birt.report.engine.extension.IReportItemPresentation.setActionHandler(IHTMLActionHandler) implement #init(IReportItemPresentationInfo) instead.
org.eclipse.birt.report.engine.extension.IReportItemGeneration.setApplicationClassLoader(ClassLoader) implement #init(IReportItemGenerationInfo) instead
org.eclipse.birt.report.engine.extension.IReportItemPresentation.setApplicationClassLoader(ClassLoader) implement #init(IReportItemPresentationInfo) instead.
org.eclipse.birt.report.engine.api.EngineConfig.setConfigurationVariable(String, String) use setProperty() instead.
org.eclipse.birt.report.engine.content.IHyperlinkAction.setDrillThrough(String, boolean, String, Map, Map, String, String)
org.eclipse.birt.report.engine.extension.IReportItemPresentation.setDynamicStyle(IStyle) implement #init(IReportItemPresentationInfo) instead. Set dynamic style.
org.eclipse.birt.report.engine.api.IPDFRenderOption.setEmbededFont(boolean)
org.eclipse.birt.report.engine.api.EngineConfig.setEngineContext(IPlatformContext) use setPlatformContext instead.
org.eclipse.birt.report.engine.extension.IReportItemGeneration.setExtendedItemContent(IContent) implement #init(IReportItemGenerationInfo) instead
org.eclipse.birt.report.engine.extension.IReportItemPresentation.setExtendedItemContent(IContent) implement #init(IReportItemPresentationInfo) instead.
org.eclipse.birt.report.engine.api.IPDFRenderOption.setFontDirectory(String)
org.eclipse.birt.report.engine.api.PDFRenderOption.setFontDirectory(String)
org.eclipse.birt.report.engine.api.IRenderOption.setImageHandle(IHTMLImageHandler)
org.eclipse.birt.report.engine.api.RenderOption.setImageHandle(IHTMLImageHandler)
org.eclipse.birt.report.engine.api.HTMLRenderOption.setIncludeSelectionHandle(boolean) includeSelectionHandle is replaced by eanableMetadata flag.
org.eclipse.birt.report.engine.api.IHTMLRenderOption.setIncludeSelectionHandle(boolean) includeSelectionHandle is replaced by eanableMetadata flag.
org.eclipse.birt.report.engine.extension.IReportItemPresentation.setLocale(Locale) implement #init(IReportItemPresentationInfo) instead.
org.eclipse.birt.report.engine.api.EngineConfig.setMaxRowsPerQuery(int)
org.eclipse.birt.report.engine.extension.IReportItemGeneration.setModelObject(ExtendedItemHandle) implement #init(IReportItemGenerationInfo) instead
org.eclipse.birt.report.engine.extension.IReportItemPresentation.setModelObject(ExtendedItemHandle) implement #init(IReportItemPresentationInfo) instead
org.eclipse.birt.report.engine.extension.IReportItemPresentation.setOutputFormat(String) implement #init(IReportItemPresentationInfo) instead.
org.eclipse.birt.report.engine.extension.IReportItemGeneration.setReportQueries(IDataQueryDefinition[]) implement #init(IReportItemGenerationInfo) instead
org.eclipse.birt.report.engine.extension.IReportItemPresentation.setReportQueries(IDataQueryDefinition[]) implement #init(IReportItemPresentationInfo) instead. pass the prepared query definition to extended item implementation, so that it can access data.
org.eclipse.birt.report.engine.extension.IReportItemPresentation.setResolution(int) implement #init(IReportItemPresentationInfo) instead.
org.eclipse.birt.report.engine.extension.IReportItemGeneration.setScriptContext(IReportContext) implement #init(IReportItemGenerationInfo) instead
org.eclipse.birt.report.engine.extension.IReportItemPresentation.setScriptContext(IReportContext) implement #init(IReportItemPresentationInfo) instead.
org.eclipse.birt.report.engine.extension.IReportItemPresentation.setSupportedImageFormats(String) implement #init(IReportItemPresentationInfo) instead.
org.eclipse.birt.report.engine.api.IReportEngine.shutdown() Use destroy() instead.
org.eclipse.birt.report.engine.api.ReportEngine.shutdown()

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV NEXT | FRAMES NO FRAMES

Copyright © 2008 Actuate Corp. All rights reserved.