A B C D E F G H I L M N O P Q R S T U V W

A

ACTION_BOOKMARK - Static variable in interface org.eclipse.birt.report.engine.api.IAction
bookmark action
ACTION_BOOKMARK - Static variable in interface org.eclipse.birt.report.engine.content.IHyperlinkAction
bookmark action
ACTION_DRILLTHROUGH - Static variable in interface org.eclipse.birt.report.engine.api.IAction
drillthrough action
ACTION_DRILLTHROUGH - Static variable in interface org.eclipse.birt.report.engine.content.IHyperlinkAction
drillthrough action
ACTION_HANDLER - Static variable in interface org.eclipse.birt.report.engine.api.IRenderOption
 
ACTION_HYPERLINK - Static variable in interface org.eclipse.birt.report.engine.api.IAction
hyperlink action
ACTION_HYPERLINK - Static variable in interface org.eclipse.birt.report.engine.content.IHyperlinkAction
hyperlink action
APPCONTEXT_BIRT_VIEWER_HTTPSERVET_REQUEST - Static variable in class org.eclipse.birt.report.engine.api.EngineConstants
 
APPCONTEXT_CHART_PRINT_RESOLUTION - Static variable in class org.eclipse.birt.report.engine.api.EngineConstants
Deprecated. use APPCONTEXT_CHART_RESOLUTION instead of APPCONTEXT_CHART_PRINT_RESOLUTION
APPCONTEXT_CHART_RESOLUTION - Static variable in class org.eclipse.birt.report.engine.api.EngineConstants
 
APPCONTEXT_CLASSLOADER_KEY - Static variable in class org.eclipse.birt.report.engine.api.EngineConstants
 
APPCONTEXT_DATASET_CACHE_OPTION - Static variable in class org.eclipse.birt.report.engine.api.EngineConstants
 
APPCONTEXT_HTML_RENDER_CONTEXT - Static variable in class org.eclipse.birt.report.engine.api.EngineConstants
 
APPCONTEXT_PDF_RENDER_CONTEXT - Static variable in class org.eclipse.birt.report.engine.api.EngineConstants
 
AUTHOR - Static variable in interface org.eclipse.birt.report.engine.api.IReportRunnable
 
AUTO - Static variable in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn
 
AUTOTEXT_CONTENT - Static variable in interface org.eclipse.birt.report.engine.content.IContent
 
accept(IContentVisitor, Object) - Method in interface org.eclipse.birt.report.engine.content.IContent
use visitor to process the object.
addColumn(IColumn) - Method in interface org.eclipse.birt.report.engine.content.ITableContent
 
addScriptableJavaObject(String, Object) - Method in class org.eclipse.birt.report.engine.api.EngineConfig
Deprecated. the user need add the object to the appContext directly.
addScriptableJavaObject(String, Object) - Method in interface org.eclipse.birt.report.engine.api.IEngineTask
Deprecated. user should add it to appContext.
allowBlank() - Method in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn
Deprecated.  
allowNewValues() - Method in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn
returns whether the user can enter a value different from values in a selection list Applies only to parameters with a selection list.
allowNull() - Method in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn
Deprecated.  
append(StringBuffer) - Method in class org.eclipse.birt.report.engine.api.DataID
add the instance id to the string buffer.
append(StringBuffer) - Method in class org.eclipse.birt.report.engine.api.InstanceID
 
appendBookmark(StringBuffer, String) - Method in class org.eclipse.birt.report.engine.api.HTMLActionHandler
 
appendBookmarkAsParamter(StringBuffer, String) - Method in class org.eclipse.birt.report.engine.api.HTMLActionHandler
 
appendChild(INode) - Method in interface org.eclipse.birt.report.engine.content.INode
 
appendFormat(StringBuffer, String) - Method in class org.eclipse.birt.report.engine.api.HTMLActionHandler
 
appendParamter(StringBuffer, String, Object) - Method in class org.eclipse.birt.report.engine.api.HTMLActionHandler
 
appendReportDesignName(StringBuffer, String) - Method in class org.eclipse.birt.report.engine.api.HTMLActionHandler
 
appendUniqueID(StringBuffer) - Method in class org.eclipse.birt.report.engine.api.InstanceID
 
args - Variable in class org.eclipse.birt.report.engine.api.ReportRunner
the input paramters

B

BAND_DETAIL - Static variable in interface org.eclipse.birt.report.engine.content.IBandContent
 
BAND_FOOTER - Static variable in interface org.eclipse.birt.report.engine.content.IBandContent
 
BAND_GROUP_FOOTER - Static variable in interface org.eclipse.birt.report.engine.content.IBandContent
 
BAND_GROUP_HEADER - Static variable in interface org.eclipse.birt.report.engine.content.IBandContent
 
BAND_HEADER - Static variable in interface org.eclipse.birt.report.engine.content.IBandContent
 
BASE_IMAGE_URL - Static variable in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption
 
BASE_PROP - Static variable in interface org.eclipse.birt.report.engine.api.IReportRunnable
 
BASE_URL - Static variable in interface org.eclipse.birt.report.engine.api.IRenderOption
 
baseImageURL - Variable in class org.eclipse.birt.report.engine.api.HTMLRenderContext
Deprecated. base URL used for image
baseURL - Variable in class org.eclipse.birt.report.engine.api.DOCRenderContext
base URL used for action handler
baseURL - Variable in class org.eclipse.birt.report.engine.api.HTMLRenderContext
Deprecated. base URL used for action handler
baseURL - Variable in class org.eclipse.birt.report.engine.api.PDFRenderContext
Deprecated. base URL used for action handler
bookmark - Variable in class org.eclipse.birt.report.engine.api.TOCNode
A bookmark that is stored for the TOC
buildDrillAction(IAction, Object) - Method in class org.eclipse.birt.report.engine.api.HTMLActionHandler
builds URL for drillthrough action

C

CANCEL_ON_ERROR - Static variable in interface org.eclipse.birt.report.engine.api.IEngineTask
cancel the task execution if there is an error.
CASCADING_PARAMETER_GROUP - Static variable in interface org.eclipse.birt.report.engine.api.IParameterDefnBase
 
CELL_CONTENT - Static variable in interface org.eclipse.birt.report.engine.content.IContent
 
CENTER - Static variable in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn
 
CHECK_BOX - Static variable in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn
 
COMMENTS - Static variable in interface org.eclipse.birt.report.engine.api.IReportRunnable
 
CONTAINER_CONTENT - Static variable in interface org.eclipse.birt.report.engine.content.IContent
 
CONTINUE_ON_ERROR - Static variable in interface org.eclipse.birt.report.engine.api.IEngineTask
continue the task execution if there is an error.
CREATEDBY - Static variable in interface org.eclipse.birt.report.engine.api.IReportRunnable
 
CUBE_RESULTSET - Static variable in interface org.eclipse.birt.report.engine.extension.IBaseResultSet
 
CUSTOM_IMAGE - Static variable in interface org.eclipse.birt.report.engine.api.IImage
 
CachedImage - class org.eclipse.birt.report.engine.api.CachedImage.
Cached Image Created by the IHTMLImageHandler.
CachedImage() - Constructor for class org.eclipse.birt.report.engine.api.CachedImage
create an empty cache.
CachedImage(String, String) - Constructor for class org.eclipse.birt.report.engine.api.CachedImage
create a instance of cached image.
ComponentID - class org.eclipse.birt.report.engine.api.ComponentID.
a class that wraps around an identifier for a report component
ComponentID() - Constructor for class org.eclipse.birt.report.engine.api.ComponentID
 
cancel() - Method in interface org.eclipse.birt.report.engine.api.IEngineTask
set the cancel flag if the task is running.
cancel(Object) - Method in interface org.eclipse.birt.report.engine.api.IEngineTask
Deprecated. user should use cancel() instead.
cellId - Variable in class org.eclipse.birt.report.engine.api.DataID
 
changeLogLevel(Level) - Method in interface org.eclipse.birt.report.engine.api.IReportEngine
Change the log level to newLevel
changeLogLevel(Level) - Method in class org.eclipse.birt.report.engine.api.ReportEngine
Change the log level to newLevel
checkTargetFileName() - Method in class org.eclipse.birt.report.engine.api.ReportRunner
If -o (targetFile) is not specified, assume same directory as inputfile, and inputfile.*** as output file name (where *** is the output format.
children - Variable in class org.eclipse.birt.report.engine.api.TOCNode
A list of children for the TOC node
clip(int, int, int, int) - Method in interface org.eclipse.birt.report.engine.layout.emitter.IPage
Clips a rectangle area.
clipRestore() - Method in interface org.eclipse.birt.report.engine.layout.emitter.IPage
Restores last saved clip state.
clipSave() - Method in interface org.eclipse.birt.report.engine.layout.emitter.IPage
Saves current clip state.
close() - Method in interface org.eclipse.birt.report.engine.api.IDataIterator
Closes this result and provide a hint that the consumer is done with this result, whose resources can be safely released as appropriate.
close() - Method in interface org.eclipse.birt.report.engine.api.IEngineTask
close the task, relese any resources.
close() - Method in interface org.eclipse.birt.report.engine.api.IExtractionResults
Closes all query result set(s) associated with this object; provides a hint to the query that it can safely release all associated resources.
close() - Method in interface org.eclipse.birt.report.engine.api.IReportDocument
close the report document, rlease all resources.
close() - Method in interface org.eclipse.birt.report.engine.extension.IBaseResultSet
 
close() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemExecutor
close the executor, if the executor is closed, all sub executor will be termiante also.
close() - Method in interface org.eclipse.birt.report.engine.extension.IRowSet
clse the row set
close() - Method in class org.eclipse.birt.report.engine.layout.content.ItemExecutorWrapper
 
close() - Method in interface org.eclipse.birt.report.engine.layout.emitter.IPageDevice
Closes this page device.
componentID - Variable in class org.eclipse.birt.report.engine.api.ComponentID
 
content - Variable in class org.eclipse.birt.report.engine.layout.content.ItemExecutorWrapper
 
createActionContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent
create a anction content.
createAutoTextContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent
create the auto text content.
createCellContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent
create a cell content.
createContainerContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent
create a container content.
createDataContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent
create the data content.
createDataContent(IContent) - Method in interface org.eclipse.birt.report.engine.content.IReportContent
create the data content, copy the properties from the template content.
createDataExtractionTask(IReportDocument) - Method in interface org.eclipse.birt.report.engine.api.IReportEngine
creates a task that allows data extraction from a report document
createDataExtractionTask(IReportDocument) - Method in class org.eclipse.birt.report.engine.api.ReportEngine
creates a task that allows data extraction from a report document
createExecutor(IReportItemExecutor, Object) - Method in interface org.eclipse.birt.report.engine.extension.IExecutorContext
create IReportItemExecutor of handle, the extendedItem is child.
createForeignContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent
create the foreign content.
createGetParameterDefinitionTask(IReportRunnable) - Method in interface org.eclipse.birt.report.engine.api.IReportEngine
creates an engine task for obtaining report parameter definitions
createGetParameterDefinitionTask(IReportRunnable) - Method in class org.eclipse.birt.report.engine.api.ReportEngine
creates an engine task for obtaining report parameter definitions
createImageContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent
create the image content.
createImageContent(IContent) - Method in interface org.eclipse.birt.report.engine.content.IReportContent
create the image content, copy the properties from the template content.
createLabelContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent
create the label content.
createLabelContent(IContent) - Method in interface org.eclipse.birt.report.engine.content.IReportContent
create the label content, copy the properties from the template content.
createListBandContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent
 
createListContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent
 
createListGroupContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent
 
createPageContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent
create a page content.
createQuery(IDataQueryDefinition, ReportElementHandle) - Method in interface org.eclipse.birt.report.engine.extension.IQueryContext
delegate to report engine to build query, the extened item may call this api to build children��s query
createRenderTask(IReportDocument) - Method in interface org.eclipse.birt.report.engine.api.IReportEngine
creates a task that renders the report to a specific output format.
createRenderTask(IReportDocument) - Method in class org.eclipse.birt.report.engine.api.ReportEngine
creates a task that renders the report to a specific output format.
createReportEngine(EngineConfig) - Method in interface org.eclipse.birt.report.engine.api.IReportEngineFactory
create a new report engine object.
createReportQueries(IDataQueryDefinition) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemQuery
 
createRowContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent
create the row content.
createRunAndRenderTask(IReportRunnable) - Method in interface org.eclipse.birt.report.engine.api.IReportEngine
creates an engine task for running and rendering report directly to output format
createRunAndRenderTask(IReportRunnable) - Method in class org.eclipse.birt.report.engine.api.ReportEngine
creates an engine task for running and rendering report directly to output format
createRunTask(IReportRunnable) - Method in interface org.eclipse.birt.report.engine.api.IReportEngine
creates a task to run a report to generate a report document
createRunTask(IReportRunnable) - Method in class org.eclipse.birt.report.engine.api.ReportEngine
creates a task to run a report to generate a report document
createStyle() - Method in interface org.eclipse.birt.report.engine.content.IReportContent
create a style.
createTableBandContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent
 
createTableContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent
create an table content.
createTableGroupContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent
 
createTextContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent
create the text content.
createTextContent(IContent) - Method in interface org.eclipse.birt.report.engine.content.IReportContent
create the text content, copy the properties from the template content.
createUniqueFile(String, String, String) - Method in class org.eclipse.birt.report.engine.api.HTMLCompleteImageHandler
creates a unique tempoary file to store an image
createUniqueFileName(String, String) - Method in class org.eclipse.birt.report.engine.api.HTMLServerImageHandler
returns a unique file name based on a directory and name prefix
createUniqueFileName(String, String, String) - Method in class org.eclipse.birt.report.engine.api.HTMLServerImageHandler
creates a unique tempoary file to store an image

D

DATA_CONTENT - Static variable in interface org.eclipse.birt.report.engine.content.IContent
 
DEFAULT_RENDER_OPTION - Static variable in interface org.eclipse.birt.report.engine.api.IEngineConfig
the default render option which used by all emitters
DESCRIPTION - Static variable in interface org.eclipse.birt.report.engine.api.IReportRunnable
 
DESIGN_IMAGE - Static variable in interface org.eclipse.birt.report.engine.api.IImage
 
DOCRenderContext - class org.eclipse.birt.report.engine.api.DOCRenderContext.
 
DOCRenderContext() - Constructor for class org.eclipse.birt.report.engine.api.DOCRenderContext
dummy constrictor
DOCUMENT_EXTENSION - Static variable in interface org.eclipse.birt.report.engine.content.IContent
 
DataID - class org.eclipse.birt.report.engine.api.DataID.
the data id of the data used by an instance.
DataID(DataSetID, long) - Constructor for class org.eclipse.birt.report.engine.api.DataID
creat the new data id instance.
DataID(DataSetID, String) - Constructor for class org.eclipse.birt.report.engine.api.DataID
 
DataSetID - class org.eclipse.birt.report.engine.api.DataSetID.
ID represent the data set.
DataSetID(DataSetID, long, String) - Constructor for class org.eclipse.birt.report.engine.api.DataSetID
DataSetID of the subquery.
DataSetID(DataSetID, String, String) - Constructor for class org.eclipse.birt.report.engine.api.DataSetID
 
DataSetID(String) - Constructor for class org.eclipse.birt.report.engine.api.DataSetID
create a dataset id of a normal query.
DefaultStatusHandler - class org.eclipse.birt.report.engine.api.DefaultStatusHandler.
default implementation for a status handler.
DefaultStatusHandler() - Constructor for class org.eclipse.birt.report.engine.api.DefaultStatusHandler
 
dataId - Variable in class org.eclipse.birt.report.engine.api.InstanceID
 
dataSet - Variable in class org.eclipse.birt.report.engine.api.DataID
data set id.
deserialize(InputStream) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation
deserializes generation time state information about the extended item
designId - Variable in class org.eclipse.birt.report.engine.api.InstanceID
 
destroy() - Method in interface org.eclipse.birt.report.engine.api.IReportEngine
shut down the engine, release all the resources.
destroy() - Method in class org.eclipse.birt.report.engine.api.ReportEngine
shuts down the report engine
dftRb - Static variable in class org.eclipse.birt.report.engine.api.EngineException
 
displayExpanded() - Method in interface org.eclipse.birt.report.engine.api.IParameterGroupDefn
returns whether to display the parameter group in expanded form
displayInFixedOrder() - Method in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn
returns whether the UI should display the seleciton list in a fixed order.
displayString - Variable in class org.eclipse.birt.report.engine.api.TOCNode
the string to be displayed for the TOC entry
dispose() - Method in interface org.eclipse.birt.report.engine.layout.emitter.IPage
 
drawBackgroundColor(Color, int, int, int, int) - Method in interface org.eclipse.birt.report.engine.layout.emitter.IPage
Draws the background color at the contentByteUnder of the pdf
drawBackgroundImage(int, int, int, int, String, String, int, int) - Method in interface org.eclipse.birt.report.engine.layout.emitter.IPage
 
drawImage(byte[], int, int, int, int, String) - Method in interface org.eclipse.birt.report.engine.layout.emitter.IPage
 
drawImage(String, int, int, int, int, String) - Method in interface org.eclipse.birt.report.engine.layout.emitter.IPage
 
drawLine(int, int, int, int, int, Color, String) - Method in interface org.eclipse.birt.report.engine.layout.emitter.IPage
Draws a line from the start position to the end position with the given linewidth, color, and style at the given pdf layer.
drawText(String, int, int, int, int, TextStyle) - Method in interface org.eclipse.birt.report.engine.layout.emitter.IPage
Draws text at specified position with specified styles.

E

EMITTER_CONFIGS - Static variable in interface org.eclipse.birt.report.engine.api.IEngineConfig
contains a hashmap which saved the default render options.
EMITTER_ID - Static variable in interface org.eclipse.birt.report.engine.api.IRenderOption
 
ENGINE_LOGGER - Static variable in interface org.eclipse.birt.report.engine.api.IEngineConfig
define the logger used by the report engine.
EXTENSION_REPORT_ENGINE_FACTORY - Static variable in interface org.eclipse.birt.report.engine.api.IReportEngineFactory
the extension point used to create the factory object.
EXTERNAL_TYPE - Static variable in interface org.eclipse.birt.report.engine.content.IForeignContent
the content is the output of a extenal item, it is byte[]
EmitterInfo - class org.eclipse.birt.report.engine.api.EmitterInfo.
The descriptor of the plugin emitter.
EmitterInfo(String, String, String, String, String, String, IConfigurationElement) - Constructor for class org.eclipse.birt.report.engine.api.EmitterInfo
 
EngineConfig - class org.eclipse.birt.report.engine.api.EngineConfig.
Wraps around configuration settings for report engine.
EngineConfig() - Constructor for class org.eclipse.birt.report.engine.api.EngineConfig
constructor
EngineConstants - class org.eclipse.birt.report.engine.api.EngineConstants.
Defines various constants that engine host may need to use
EngineConstants() - Constructor for class org.eclipse.birt.report.engine.api.EngineConstants
 
EngineException - exception org.eclipse.birt.report.engine.api.EngineException.
Define an engine exception that clients of the engine need to handle.
EngineException(String, Object) - Constructor for class org.eclipse.birt.report.engine.api.EngineException
 
EngineException(String, Object, Throwable) - Constructor for class org.eclipse.birt.report.engine.api.EngineException
 
EngineException(String, Object[]) - Constructor for class org.eclipse.birt.report.engine.api.EngineException
 
EngineException(String, Object[], Throwable) - Constructor for class org.eclipse.birt.report.engine.api.EngineException
 
EngineException(String) - Constructor for class org.eclipse.birt.report.engine.api.EngineException
 
EngineException(String, Throwable) - Constructor for class org.eclipse.birt.report.engine.api.EngineException
 
encoding - Variable in class org.eclipse.birt.report.engine.api.ReportRunner
the output encoding, used in html format in Render and RunAndRender modes.
end(IReportContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter
 
endCell(ICellContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter
 
endContainer(IContainerContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter
 
endContent(IContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter
 
endGroup(IGroupContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter
 
endList(IListContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter
 
endListBand(IListBandContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter
 
endListGroup(IListGroupContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter
 
endPage(IPageContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter
page end
endRow(IRowContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter
 
endTable(ITableContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter
table end
endTableBand(ITableBandContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter
 
endTableGroup(ITableGroupContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter
 
engine - Variable in class org.eclipse.birt.report.engine.api.ReportEngine
 
equals(Object) - Method in class org.eclipse.birt.report.engine.api.DataID
 
equals(Object) - Method in class org.eclipse.birt.report.engine.api.DataSetID
 
evaluate(String) - Method in interface org.eclipse.birt.report.engine.extension.IBaseResultSet
 
evaluate(IBaseExpression) - Method in interface org.eclipse.birt.report.engine.extension.IBaseResultSet
 
evaluate(String) - Method in interface org.eclipse.birt.report.engine.extension.IRowSet
evaluate the expression using current row.
evaluate(IBaseExpression) - Method in interface org.eclipse.birt.report.engine.extension.IRowSet
 
evaluateDefaults() - Method in interface org.eclipse.birt.report.engine.api.IGetParameterDefinitionTask
Deprecated. use getDefaultParameterValues() directly.
evaluateQuery(String) - Method in interface org.eclipse.birt.report.engine.api.IGetParameterDefinitionTask
The first step to work with the cascading parameters.
execute() - Method in class org.eclipse.birt.report.engine.api.ReportRunner
Check if the arguments are valid.
execute() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemExecutor
execute the report item
execute() - Method in class org.eclipse.birt.report.engine.layout.content.ItemExecutorWrapper
 
executeQuery(IBaseResultSet, IDataQueryDefinition) - Method in interface org.eclipse.birt.report.engine.extension.IExecutorContext
execute query
executeQuery(IBaseResultSet, IDataQueryDefinition, Object) - Method in interface org.eclipse.birt.report.engine.extension.IExecutorContext
execute query
executor - Variable in class org.eclipse.birt.report.engine.layout.content.ItemExecutorWrapper
 
extract() - Method in interface org.eclipse.birt.report.engine.api.IDataExtractionTask
 

F

FILE_IMAGE - Static variable in interface org.eclipse.birt.report.engine.api.IImage
 
FILTER_PARAMETER - Static variable in interface org.eclipse.birt.report.engine.api.IParameterDefnBase
 
FIT_TO_PAGE - Static variable in interface org.eclipse.birt.report.engine.api.IPDFRenderOption
 
FONT_DIRECTORY - Static variable in interface org.eclipse.birt.report.engine.api.IPDFRenderOption
define the font directory used by PDF.
FOREIGN_CONTENT - Static variable in interface org.eclipse.birt.report.engine.content.IContent
 
findStyle(String) - Method in interface org.eclipse.birt.report.engine.content.IReportContent
find the named style.
findTOC(String) - Method in interface org.eclipse.birt.report.engine.api.IReportDocument
get the TOCNode have the id.
findTOC(String) - Method in interface org.eclipse.birt.report.engine.api.ITOCTree
Gets the TOCNode with the specified id.
findTOCByName(String) - Method in interface org.eclipse.birt.report.engine.api.IReportDocument
Gets the TOCNodes with the given name.
findTOCByValue(Object) - Method in interface org.eclipse.birt.report.engine.api.ITOCTree
Gets the TOCNodes with specified TOC value.
finish() - Method in class org.eclipse.birt.report.engine.api.DefaultStatusHandler
 
finish() - Method in interface org.eclipse.birt.report.engine.api.IStatusHandler
does cleanup work
finish() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemGeneration
Performs clean up work
finish() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation
Performs clean up work
fontDirectory - Variable in class org.eclipse.birt.report.engine.api.DOCRenderContext
user-defined font dirctory
fontDirectory - Variable in class org.eclipse.birt.report.engine.api.PDFRenderContext
Deprecated. user-defined font dirctory
format(Object) - Method in class org.eclipse.birt.report.engine.api.ReportParameterConverter
Convert report parameter value object into string.
format - Variable in class org.eclipse.birt.report.engine.api.ReportRunner
the output format, used in Render and RunAndRender.

G

GLOBAL_VARIABLE_OPTION_ALL - Static variable in interface org.eclipse.birt.report.engine.api.IReportDocument
 
GLOBAL_VARIABLE_OPTION_JAVA_ONLY - Static variable in interface org.eclipse.birt.report.engine.api.IReportDocument
 
GLOBAL_VARIABLE_OPTION_JS_ONLY - Static variable in interface org.eclipse.birt.report.engine.api.IReportDocument
 
GROUP_CONTENT - Static variable in interface org.eclipse.birt.report.engine.content.IContent
 
getActionHandle() - Method in interface org.eclipse.birt.report.engine.api.IRenderOption
Deprecated.  
getActionHandle() - Method in class org.eclipse.birt.report.engine.api.RenderOption
Deprecated.  
getActionHandler() - Method in interface org.eclipse.birt.report.engine.api.IRenderOption
 
getActionHandler() - Method in class org.eclipse.birt.report.engine.api.RenderOption
 
getActionString() - Method in interface org.eclipse.birt.report.engine.api.IAction
 
getAlignment() - Method in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn
 
getAltText() - Method in interface org.eclipse.birt.report.engine.content.IForeignContent
 
getAltText() - Method in interface org.eclipse.birt.report.engine.content.IImageContent
 
getAltTextKey() - Method in interface org.eclipse.birt.report.engine.content.IForeignContent
 
getAltTextKey() - Method in interface org.eclipse.birt.report.engine.content.IImageContent
 
getAppContext() - Method in class org.eclipse.birt.report.engine.api.EngineConfig
 
getAppContext() - Method in interface org.eclipse.birt.report.engine.api.IEngineTask
returns the context objects for the task.
getApplicationClassLoader() - Method in interface org.eclipse.birt.report.engine.extension.IExecutorContext
get the class loader used to load user defined classes.
getArchive() - Method in interface org.eclipse.birt.report.engine.api.IReportDocument
 
getBackgroundPositionX() - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
getBackgroundPositionY() - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
getBand() - Method in interface org.eclipse.birt.report.engine.content.IRowContent
 
getBandType() - Method in interface org.eclipse.birt.report.engine.content.IBandContent
 
getBaseImageURL() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderContext
Deprecated. returns the base url for creating image URL
getBaseImageURL() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption
returns the base url for creating image URL
getBaseImageURL() - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption
returns the base url for creating image URL
getBaseURL() - Method in class org.eclipse.birt.report.engine.api.DOCRenderContext
Returns the base URL for creating an Action URL
getBaseURL() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderContext
Deprecated. Returns the base URL for creating an Action URL
getBaseURL() - Method in interface org.eclipse.birt.report.engine.api.IRenderOption
Returns the base URL for creating an Action URL
getBaseURL() - Method in class org.eclipse.birt.report.engine.api.PDFRenderContext
Deprecated. Returns the base URL for creating an Action URL
getBaseURL() - Method in class org.eclipse.birt.report.engine.api.RenderOption
Returns the base URL for creating an Action URL
getBigDecimal(String) - Method in interface org.eclipse.birt.report.engine.extension.IQueryResultSet
Returns the value of a bound column as the BigDecimal data type.
getBlob(String) - Method in interface org.eclipse.birt.report.engine.extension.IQueryResultSet
Returns the value of a bound column as the Blob data type.
getBookmark() - Method in interface org.eclipse.birt.report.engine.api.IAction
 
getBookmark() - Method in class org.eclipse.birt.report.engine.api.TOCNode
 
getBookmark() - Method in interface org.eclipse.birt.report.engine.content.IContent
 
getBookmark() - Method in interface org.eclipse.birt.report.engine.content.IDrillThroughAction
 
getBookmark() - Method in interface org.eclipse.birt.report.engine.content.IHyperlinkAction
 
getBookmarkOffset(String) - Method in interface org.eclipse.birt.report.engine.api.IReportDocument
Given a report item bookmark, returns the offset of the report content (to support Reportlet).
getBookmarks() - Method in interface org.eclipse.birt.report.engine.api.IReportDocument
 
getBoolean(String) - Method in interface org.eclipse.birt.report.engine.extension.IQueryResultSet
Returns the value of a bound column as the Boolean data type.
getBooleanOption(String, boolean) - Method in class org.eclipse.birt.report.engine.api.RenderOption
 
getBytes(String) - Method in interface org.eclipse.birt.report.engine.extension.IQueryResultSet
Returns the value of a bound column as the byte[] data type.
getCachedImage(String, int, IReportContext) - Method in class org.eclipse.birt.report.engine.api.HTMLImageHandler
 
getCachedImage(String, int, IReportContext) - Method in interface org.eclipse.birt.report.engine.api.IHTMLImageHandler
get the cached image for that id.
getCanShrink() - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
getCancelFlag() - Method in interface org.eclipse.birt.report.engine.api.IEngineTask
return a flag if the user called cancel.
getCaption() - Method in interface org.eclipse.birt.report.engine.content.ITableContent
 
getCaptionKey() - Method in interface org.eclipse.birt.report.engine.content.ITableContent
 
getCellID() - Method in class org.eclipse.birt.report.engine.api.DataID
 
getCellID() - Method in class org.eclipse.birt.report.engine.api.DataSetID
 
getCellIndex() - Method in interface org.eclipse.birt.report.engine.extension.ICubeResultSet
 
getChildren(String) - Method in interface org.eclipse.birt.report.engine.api.IReportDocument
 
getChildren() - Method in class org.eclipse.birt.report.engine.api.TOCNode
 
getChildren() - Method in interface org.eclipse.birt.report.engine.content.IElement
 
getChildren() - Method in interface org.eclipse.birt.report.engine.content.INode
 
getColSpan() - Method in interface org.eclipse.birt.report.engine.content.ICellContent
 
getColumn() - Method in interface org.eclipse.birt.report.engine.content.ICellContent
 
getColumn(int) - Method in interface org.eclipse.birt.report.engine.content.ITableContent
 
getColumnAlias(int) - Method in interface org.eclipse.birt.report.engine.api.IResultMetaData
Returns the column alias at the specified index.
getColumnCount() - Method in interface org.eclipse.birt.report.engine.api.IResultMetaData
Returns the number of columns in a detail row of the result set.
getColumnCount() - Method in interface org.eclipse.birt.report.engine.content.ITableContent
 
getColumnCount() - Method in interface org.eclipse.birt.report.engine.extension.IRowMetaData
Returns the number of columns in a detail row of the result set.
getColumnInstance() - Method in interface org.eclipse.birt.report.engine.content.ICellContent
 
getColumnLabel(int) - Method in interface org.eclipse.birt.report.engine.api.IResultMetaData
Gets the label or display name of the column at the specified index.
getColumnName(int) - Method in interface org.eclipse.birt.report.engine.api.IResultMetaData
Returns the column name at the specified index.
getColumnName(int) - Method in interface org.eclipse.birt.report.engine.extension.IRowMetaData
Returns the column name at the specified index.
getColumnType(int) - Method in interface org.eclipse.birt.report.engine.api.IResultMetaData
Returns the data type of the column at the specified index.
getColumnType(int) - Method in interface org.eclipse.birt.report.engine.extension.IRowMetaData
 
getColumnTypeName(int) - Method in interface org.eclipse.birt.report.engine.api.IResultMetaData
Returns the Data Engine data type name of the column at the specified index.
getComponentID() - Method in class org.eclipse.birt.report.engine.api.InstanceID
returns the component id for the element
getConfig() - Method in interface org.eclipse.birt.report.engine.api.IReportEngine
returns the engine configuration object
getConfig() - Method in class org.eclipse.birt.report.engine.api.ReportEngine
returns the engine configuration object
getConfigMap() - Method in class org.eclipse.birt.report.engine.api.EngineConfig
Deprecated. use getProperties() instead.
getContent(InstanceID) - Method in interface org.eclipse.birt.report.engine.content.IReportContent
return the content in this report.
getContent() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemExecutor
get the content
getContent() - Method in interface org.eclipse.birt.report.engine.layout.content.IContentWrapper
 
getContentComputedStyle() - Method in interface org.eclipse.birt.report.engine.content.IPageContent
Deprecated. use getPageBody().getComputedStyle()
getContentStyle() - Method in interface org.eclipse.birt.report.engine.content.IPageContent
Deprecated. use getPageBody().getStyle()
getContentType() - Method in interface org.eclipse.birt.report.engine.content.IContent
the content type, must be one of the predefines.
getContents() - Method in interface org.eclipse.birt.report.engine.api.IParameterGroupDefn
returns the set of parameters that appear inside the group.
getContext() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemExecutor
get executor context
getControlType() - Method in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn
 
getCssText(int) - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
getCubeCursor() - Method in interface org.eclipse.birt.report.engine.extension.ICubeResultSet
 
getData() - Method in interface org.eclipse.birt.report.engine.content.IImageContent
 
getDataID() - Method in class org.eclipse.birt.report.engine.api.InstanceID
 
getDataSet() - Method in interface org.eclipse.birt.report.engine.api.ICascadingParameterGroup
 
getDataSetID() - Method in class org.eclipse.birt.report.engine.api.DataID
return the data set.
getDataSetName() - Method in class org.eclipse.birt.report.engine.api.DataSetID
data set name if any.
getDataType() - Method in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn
returns the parameter data type.
getDate(String) - Method in interface org.eclipse.birt.report.engine.extension.IQueryResultSet
Returns the value of a bound column as the Date data type.
getDateFormat() - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
getDefaultValue(IParameterDefnBase) - Method in interface org.eclipse.birt.report.engine.api.IGetParameterDefinitionTask
get default value by parameter name
getDefaultValue(String) - Method in interface org.eclipse.birt.report.engine.api.IGetParameterDefinitionTask
get the default value of parameter.
getDefaultValue() - Method in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn
 
getDefaultValues() - Method in interface org.eclipse.birt.report.engine.api.IGetParameterDefinitionTask
get all default values
getDesign() - Method in interface org.eclipse.birt.report.engine.content.IReportContent
get the report design used to create this report content.
getDesignHandle() - Method in interface org.eclipse.birt.report.engine.api.IReportRunnable
returns the design element handle that design engine creates when opening the report
getDesignInstance() - Method in interface org.eclipse.birt.report.engine.api.IReportRunnable
Returns the report design
getDesignStream() - Method in interface org.eclipse.birt.report.engine.api.IReportDocument
 
getDisplayFilterIcon() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption
 
getDisplayFilterIcon() - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption
 
getDisplayFormat() - Method in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn
 
getDisplayGroupIcon() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption
 
getDisplayGroupIcon() - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption
 
getDisplayGroupIcon() - Method in interface org.eclipse.birt.report.engine.content.ICellContent
 
getDisplayName() - Method in interface org.eclipse.birt.report.engine.api.IParameterDefnBase
returns the locale-specific display name for the parameter.
getDisplayString() - Method in class org.eclipse.birt.report.engine.api.TOCNode
 
getDouble(String) - Method in interface org.eclipse.birt.report.engine.extension.IQueryResultSet
Returns the value of a bound column as the Double data type.
getDrillThrough() - Method in interface org.eclipse.birt.report.engine.content.IHyperlinkAction
 
getEmbeddable() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption
 
getEmbeddable() - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption
 
getEmitter() - Method in class org.eclipse.birt.report.engine.api.EmitterInfo
Get the emitter instance of the emitter.
getEmitterConfig() - Method in interface org.eclipse.birt.report.engine.emitter.IEmitterServices
TODO: review, return IEmitterConfig, by format.
getEmitterConfigs() - Method in class org.eclipse.birt.report.engine.api.EngineConfig
gets a map for emitter configuration objects
getEmitterID() - Method in interface org.eclipse.birt.report.engine.api.IRenderOption
returns the emitter id
getEmitterID() - Method in class org.eclipse.birt.report.engine.api.RenderOption
 
getEmitterInfo() - Method in interface org.eclipse.birt.report.engine.api.IReportEngine
Return all the emitter information which BIRT Engine can load.
getEmitterInfo() - Method in class org.eclipse.birt.report.engine.api.ReportEngine
Return all the emitter information which BIRT Engine can load.
getEnableAgentStyleEngine() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption
 
getEnableMetadata() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption
 
getEnableMetadata() - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption
 
getEndingGroupLevel() - Method in interface org.eclipse.birt.report.engine.extension.IQueryResultSet
Returns the 1-based index of the outermost group in which the current row is the first row.
getEndingGroupLevel() - Method in interface org.eclipse.birt.report.engine.extension.IR