A B C D E F G H I L M N O P 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 class org.eclipse.birt.report.engine.api.RenderOptionBase
 
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
 
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
 
accept(IContentVisitor, Object) - Method in interface org.eclipse.birt.report.engine.content.IContent
use visitor to process the object.
actionHandler - Variable in class org.eclipse.birt.report.engine.api.HTMLEmitterConfig
default action handler
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
defines an additional Java object that is exposed to BIRT scripting
addScriptableJavaObject(String, Object) - Method in interface org.eclipse.birt.report.engine.api.IEngineTask
defines an additional Java object that is exposed to BIRT scripting at a per-task level
allowBlank() - Method in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn
 
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
 
append(StringBuffer) - Method in class org.eclipse.birt.report.engine.api.DataID
 
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
 
args - Variable in class org.eclipse.birt.report.engine.api.ReportRunner
the input paramters

B

BAND_BODY - Static variable in interface org.eclipse.birt.report.engine.content.ITableBandContent
 
BAND_FOOTER - Static variable in interface org.eclipse.birt.report.engine.content.ITableBandContent
 
BAND_HEADER - Static variable in interface org.eclipse.birt.report.engine.content.ITableBandContent
 
BASE_PROP - Static variable in interface org.eclipse.birt.report.engine.api.IReportRunnable
 
baseImageURL - Variable in class org.eclipse.birt.report.engine.api.HTMLRenderContext
base URL used for image
baseURL - Variable in class org.eclipse.birt.report.engine.api.HTMLRenderContext
base URL used for action handler
baseURL - Variable in class org.eclipse.birt.report.engine.api.PDFRenderContext
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

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
 
CONFIG_VAR_ENGINE_HOME - Static variable in class org.eclipse.birt.report.engine.api.EngineConfig
 
CONTAINER_CONTENT - Static variable in interface org.eclipse.birt.report.engine.content.IContent
 
CREATEDBY - Static variable in interface org.eclipse.birt.report.engine.api.IReportRunnable
 
CUSTOM_IMAGE - Static variable in interface org.eclipse.birt.report.engine.api.IImage
 
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
 
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
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.IRowSet
clse the row set
componentID - Variable in class org.eclipse.birt.report.engine.api.ComponentID
 
config - Variable in class org.eclipse.birt.report.engine.api.ReportEngine
engine configuration object
configObjects - Variable in class org.eclipse.birt.report.engine.api.EngineConfig
stores various configuration objects
context - Variable in class org.eclipse.birt.report.engine.api.EngineConfig
the context that the platform is running.
createActionContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent
create a anction 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 class org.eclipse.birt.report.engine.api.ReportEngine
creates a task that allows data extraction from a report document
createDataPreviewTask(IReportRunnable) - Method in class org.eclipse.birt.report.engine.api.ReportEngine
 
createForeignContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent
create the foreign content.
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.
createPageContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent
create a page content.
createRenderTask(IReportDocument) - Method in class org.eclipse.birt.report.engine.api.ReportEngine
creates a task that renders the report to a specific output format.
createRowContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent
create the row content.
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 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.
createTableBody() - Method in interface org.eclipse.birt.report.engine.content.IReportContent
create the table body.
createTableContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent
create an table content.
createTableFooter() - Method in interface org.eclipse.birt.report.engine.content.IReportContent
create the table footer.
createTableHeader() - Method in interface org.eclipse.birt.report.engine.content.IReportContent
create the table header.
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, String) - Method in class org.eclipse.birt.report.engine.api.HTMLServerImageHandler
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

D

DATA_CONTENT - Static variable in interface org.eclipse.birt.report.engine.content.IContent
 
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
 
DataID - class org.eclipse.birt.report.engine.api.DataID.
 
DataID(DataSetID, long) - Constructor for class org.eclipse.birt.report.engine.api.DataID
 
DataSetID - class org.eclipse.birt.report.engine.api.DataSetID.
 
DataSetID(DataSetID, long, String) - Constructor for class org.eclipse.birt.report.engine.api.DataSetID
 
DataSetID(String) - Constructor for class org.eclipse.birt.report.engine.api.DataSetID
 
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
 
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 class org.eclipse.birt.report.engine.api.ReportEngine
shuts down the report engine
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

E

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[]
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
 
emitterConfigs - Variable in class org.eclipse.birt.report.engine.api.EngineConfig
store emitter configuration
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
 
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
endTableBody(ITableBandContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter
 
endTableFooter(ITableBandContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter
 
endTableHeader(ITableBandContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter
 
evaluate(IBaseExpression) - Method in interface org.eclipse.birt.report.engine.extension.IRowSet
evaluate the expression using current row.
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.
executeDataSet(String, int, HashMap) - Method in interface org.eclipse.birt.report.engine.api.IDataPreviewTask
using the binding parameters to execute the data set.
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
 
FO - Static variable in class org.eclipse.birt.report.engine.api.FORenderOption
 
FOP - Static variable in class org.eclipse.birt.report.engine.api.FORenderOption
 
FOREIGN_CONTENT - Static variable in interface org.eclipse.birt.report.engine.content.IContent
 
FORenderOption - class org.eclipse.birt.report.engine.api.FORenderOption.
output settings for FO and PDF output formats.
FORenderOption() - Constructor for class org.eclipse.birt.report.engine.api.FORenderOption
constructor
FO_TYPE - Static variable in class org.eclipse.birt.report.engine.api.FORenderOption
 
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.
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.PDFRenderContext
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
 
getActionHandle() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption
 
getActionHandler() - Method in class org.eclipse.birt.report.engine.api.HTMLEmitterConfig
returns the action handler for HTML format
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.IImageContent
 
getAltTextKey() - Method in interface org.eclipse.birt.report.engine.content.IImageContent
 
getAppContext() - Method in interface org.eclipse.birt.report.engine.api.IEngineTask
returns the context objects for the task
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
 
getBaseImageURL() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderContext
returns the base url for creating image URL
getBaseURL() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderContext
Returns the base URL for creating an Action URL
getBaseURL() - Method in class org.eclipse.birt.report.engine.api.PDFRenderContext
Returns the base URL for creating an Action URL
getBody() - Method in interface org.eclipse.birt.report.engine.content.ITableContent
 
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.IHyperlinkAction
 
getBookmarks() - Method in interface org.eclipse.birt.report.engine.api.IReportDocument
 
getBorderEdge() - Method in interface org.eclipse.birt.report.engine.content.IBounds
border rectangle, with 1/1000 pt.
getBounds() - Method in interface org.eclipse.birt.report.engine.content.IContent
bound properties caculated by the layout manager.
getCSSEngine() - Method in interface org.eclipse.birt.report.engine.content.IReportContent
get the css engien used by this content
getCanShrink() - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
getCaption() - Method in interface org.eclipse.birt.report.engine.content.ITableContent
 
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
 
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.
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.extension.IRowMetaData
 
getComponentID() - Method in class org.eclipse.birt.report.engine.api.InstanceID
returns the component id for the element
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
returns a hash map that contains all the configuration objects
getContentComputedStyle() - Method in interface org.eclipse.birt.report.engine.content.IPageContent
 
getContentStyle() - Method in interface org.eclipse.birt.report.engine.content.IPageContent
 
getContentType() - Method in interface org.eclipse.birt.report.engine.content.IContent
 
getContents() - Method in interface org.eclipse.birt.report.engine.api.IParameterGroupDefn
returns the set of parameters that appear inside the group.
getControlType() - Method in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn
 
getCssText(int) - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
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
 
getDataSetName() - Method in class org.eclipse.birt.report.engine.api.DataSetID
 
getDataType() - Method in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn
returns the parameter 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.
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
getDesignStream() - Method in interface org.eclipse.birt.report.engine.api.IReportDocument
 
getDisplayFormat() - Method in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn
 
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
 
getEmbeddable() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption
 
getEmitterConfig() - Method in interface org.eclipse.birt.report.engine.emitter.IEmitterServices
 
getEmitterConfigs() - Method in class org.eclipse.birt.report.engine.api.EngineConfig
gets a map for emitter configuration objects
getEndingGroupLevel() - Method in interface org.eclipse.birt.report.engine.extension.IRowSet
Returns the 1-based index of the outermost group in which the current row is the first row.
getEngine() - Method in interface org.eclipse.birt.report.engine.api.IEngineTask
returns the report engine object
getErrors() - Method in interface org.eclipse.birt.report.engine.content.IReportContent
get the error list which occurs in the generation.
getExecutor() - Method in interface org.eclipse.birt.report.engine.emitter.IEmitterServices
 
getExtension() - Method in interface org.eclipse.birt.report.engine.api.IImage
return the image postfix, such as jpg, png
getExtension() - Method in interface org.eclipse.birt.report.engine.content.IImageContent
 
getFontDirectory() - Method in class org.eclipse.birt.report.engine.api.PDFRenderContext
 
getFooter() - Method in interface org.eclipse.birt.report.engine.content.IPageContent
 
getFooter() - Method in interface org.eclipse.birt.report.engine.content.ITableContent
 
getFooterHeight() - Method in interface org.eclipse.birt.report.engine.content.IPageContent
 
getFormat() - Method in interface org.eclipse.birt.report.engine.api.IAction
return fomat of drillthrough report
getFormat() - Method in interface org.eclipse.birt.report.engine.content.IHyperlinkAction
 
getGenerateBy() - Method in interface org.eclipse.birt.report.engine.content.IContent
the design object which create this content.
getGlobalVariables(String) - Method in interface org.eclipse.birt.report.engine.api.IReportDocument
 
getHeader() - Method in interface org.eclipse.birt.report.engine.content.IPageContent
 
getHeader() - Method in interface org.eclipse.birt.report.engine.content.ITableContent
 
getHeaderHeight() - Method in interface org.eclipse.birt.report.engine.content.IPageContent
 
getHeight() - Method in interface org.eclipse.birt.report.engine.content.IContent
sepcified value, the actual height is defined in IBounds
getHelpKey() - Method in interface org.eclipse.birt.report.engine.content.IDataContent
 
getHelpKey() - Method in interface org.eclipse.birt.report.engine.content.IImageContent
 
getHelpKey() - Method in interface org.eclipse.birt.report.engine.content.ILabelContent
 
getHelpText() - Method in interface org.eclipse.birt.report.engine.api.IParameterDefnBase
returns the locale-specific help text.
getHelpText() - Method in interface org.eclipse.birt.report.engine.content.IContent
 
getHelpText() - Method in interface org.eclipse.birt.report.engine.content.IDataContent
 
getHelpText() - Method in interface org.eclipse.birt.report.engine.content.ILabelContent
 
getHtmlPagination() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption
 
getHyperlink() - Method in interface org.eclipse.birt.report.engine.content.IHyperlinkAction
 
getHyperlinkAction() - Method in interface org.eclipse.birt.report.engine.content.IContent
 
getID() - Method in class org.eclipse.birt.report.engine.api.ComponentID
 
getID() - Method in interface org.eclipse.birt.report.engine.api.IEngineTask
returns an identifier for the task.
getID() - Method in interface org.eclipse.birt.report.engine.api.IImage
returns an identifier for the image
getImage(OutputStream, String, String) - Method in class org.eclipse.birt.report.engine.api.HTMLServerImageHandler
get image
getImage(String) - Method in interface org.eclipse.birt.report.engine.api.IReportRunnable
returns an image stored in a report design file, or null if the image name does not exist
getImageData() - Method in interface org.eclipse.birt.report.engine.api.IImage
returns binary image data.
getImageDirectory() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderContext
returns the image directory that engine stores images and charts into
getImageHandler() - Method in class org.eclipse.birt.report.engine.api.HTMLEmitterConfig
returns the image handler for HTML output format
getImageMIMEType() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation
 
getImageMap() - Method in interface org.eclipse.birt.report.engine.content.IImageContent
 
getImageMapID(IImage) - Method in class org.eclipse.birt.report.engine.api.HTMLCompleteImageHandler
returns the unique identifier for the image
getImageMapID(IImage) - Method in class org.eclipse.birt.report.engine.api.HTMLServerImageHandler
returns the unique identifier for the image
getImageSource() - Method in interface org.eclipse.birt.report.engine.content.IImageContent
Returns the type of image source
getImageStream() - Method in interface org.eclipse.birt.report.engine.api.IImage
returns an input stream where the mage can be read
getInlineStyle() - Method in interface org.eclipse.birt.report.engine.content.IContent
 
getInnerEdge() - Method in interface org.eclipse.birt.report.engine.content.IBounds
 
getInstanceID() - Method in interface org.eclipse.birt.report.engine.content.IContent
 
getInstanceIDs() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption
 
getLabel() - Method in interface org.eclipse.birt.report.engine.api.IParameterSelectionChoice
returns the locale-specific label for a selection choice.
getLabelKey() - Method in interface org.eclipse.birt.report.engine.content.IDataContent
 
getLabelKey() - Method in interface org.eclipse.birt.report.engine.content.ILabelContent
 
getLabelText() - Method in interface org.eclipse.birt.report.engine.content.IDataContent
 
getLabelText() - Method in interface org.eclipse.birt.report.engine.content.ILabelContent
 
getLeftWidth() - Method in interface org.eclipse.birt.report.engine.content.IPageContent
 
getLocale() - Method in interface org.eclipse.birt.report.engine.api.IEngineTask
returns the locale for running the task
getMIMEType(String) - Method in class org.eclipse.birt.report.engine.api.ReportEngine
the MIME type for the specific formatted supported by the extension.
getMIMEType() - Method in interface org.eclipse.birt.report.engine.content.IImageContent
get the MIMEType
getMarginBottom() - Method in interface org.eclipse.birt.report.engine.content.IPageContent
 
getMarginLeft() - Method in interface org.eclipse.birt.report.engine.content.IPageContent
 
getMarginRight() - Method in interface org.eclipse.birt.report.engine.content.IPageContent
 
getMarginTop() - Method in interface org.eclipse.birt.report.engine.content.IPageContent
 
getMasterPage() - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
getMasterPageContent() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption
 
getMetaData() - Method in interface org.eclipse.birt.report.engine.api.IDataExtractionTask
Deprecated.  
getMetaData() - Method in interface org.eclipse.birt.report.engine.extension.IRowSet
returns the definition for the data row
getName() - Method in interface org.eclipse.birt.report.engine.api.IParameterDefnBase
returns the name of the parameter
getName() - Method in interface org.eclipse.birt.report.engine.api.IReportDocument
 
getName() - Method in interface org.eclipse.birt.report.engine.content.IContent
unique id of the content.
getNodeID() - Method in class org.eclipse.birt.report.engine.api.TOCNode
 
getNumberAlign() - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
getNumberFormat() - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
getOption(String) - Method in class org.eclipse.birt.report.engine.api.RenderOptionBase
get option value for one rendering option
getOption(String) - Method in interface org.eclipse.birt.report.engine.emitter.IEmitterServices
 
getOrientation() - Method in interface org.eclipse.birt.report.engine.content.IPageContent
 
getOuterEdge() - Method in interface org.eclipse.birt.report.engine.content.IBounds
 
getOutputFormat() - Method in interface org.eclipse.birt.report.engine.api.IRenderOption
returns the output format, i.e., html, pdf, etc.
getOutputFormat() - Method in class org.eclipse.birt.report.engine.api.RenderOptionBase
returns the output format, i.e., html, pdf, etc.
getOutputFormat() - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter
 
getOutputSetting() - Method in interface org.eclipse.birt.report.engine.api.IRenderOption
returns the output settings
getOutputSetting() - Method in class org.eclipse.birt.report.engine.api.RenderOptionBase
returns the output settings
getOutputType() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation
returns the output type, which could be IMAGE, TEXT, HTML TEXT, DRAWING, etc.
getPaddingEdge() - Method in interface org.eclipse.birt.report.engine.content.IBounds
four int array describes the padding rectangle.
getPageCount() - Method in interface org.eclipse.birt.report.engine.api.IReportDocument
 
getPageHeight() - Method in interface org.eclipse.birt.report.engine.content.IPageContent
 
getPageNumber(String) - Method in interface org.eclipse.birt.report.engine.api.IReportDocument
Given a bookmark in a report, find the (first) page that the bookmark appears in (for hyperlinks to a bookmark)
getPageNumber() - Method in interface org.eclipse.birt.report.engine.content.IPageContent
 
getPageType() - Method in interface org.eclipse.birt.report.engine.content.IPageContent
 
getPageWidth() - Method in interface org.eclipse.birt.report.engine.content.IPageContent
 
getParameter(String) - Method in interface org.eclipse.birt.report.engine.api.IGetParameterDefinitionTask
Deprecated.  
getParameterBindings() - Method in interface org.eclipse.birt.report.engine.api.IAction
 
getParameterBindings() - Method in interface org.eclipse.birt.report.engine.content.IHyperlinkAction
 
getParameterDefn(String) - Method in interface org.eclipse.birt.report.engine.api.IGetParameterDefinitionTask
returns the parameter definition given the parameter name name
getParameterDefns(boolean) - Method in interface org.eclipse.birt.report.engine.api.IGetParameterDefinitionTask
return report parameter definitions
getParameterType() - Method in interface org.eclipse.birt.report.engine.api.IParameterDefnBase
 
getParameterValue(String) - Method in interface org.eclipse.birt.report.engine.api.IEngineTask
returns the value of a parameter.
getParameterValues() - Method in interface org.eclipse.birt.report.engine.api.IEngineTask
returns the parameter name/value collection
getParameterValues() - Method in interface org.eclipse.birt.report.engine.api.IReportDocument
returns values for all the parameters that are used for generating the current report document.
getParameters() - Method in interface org.eclipse.birt.report.engine.api.IGetParameterDefinitionTask
Deprecated.  
getParent() - Method in class org.eclipse.birt.report.engine.api.TOCNode
 
getParent() - Method in interface org.eclipse.birt.report.engine.content.IElement
 
getParent() - Method in interface org.eclipse.birt.report.engine.content.INode
 
getParentID() - Method in class org.eclipse.birt.report.engine.api.DataSetID
 
getParentID() - Method in class org.eclipse.birt.report.engine.api.InstanceID
 
getProperty(String) - Method in interface org.eclipse.birt.report.engine.api.IReportRunnable
returns the property value for things like report description, title, etc.
getProperty(String, String) - Method in interface org.eclipse.birt.report.engine.api.IReportRunnable
returns the property value defined on a components in a report design.
getProperty(int) - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
getQueryName() - Method in class org.eclipse.birt.report.engine.api.DataSetID
 
getQueryResults() - Method in interface org.eclipse.birt.report.engine.api.IDataIterator
Returns IExtractionResults from which this data iterator is obtained.
getRawType() - Method in interface org.eclipse.birt.report.engine.content.IForeignContent
the orginal format of the object.
getRawValue() - Method in interface org.eclipse.birt.report.engine.content.IForeignContent
the orignal content describe in raw format.
getRenderContext() - Method in interface org.eclipse.birt.report.engine.emitter.IEmitterServices
 
getRenderOption() - Method in interface org.eclipse.birt.report.engine.api.IRenderTask
 
getRenderOption() - Method in interface org.eclipse.birt.report.engine.api.IReportPart
returns the rendering options
getRenderOption() - Method in interface org.eclipse.birt.report.engine.api.IRunAndRenderTask
 
getRenderOption() - Method in interface org.eclipse.birt.report.engine.emitter.IEmitterServices
 
getReportContent() - Method in interface org.eclipse.birt.report.engine.content.IContent
 
getReportEngine() - Method in interface org.eclipse.birt.report.engine.api.IReportRunnable
returns the report engine
getReportName() - Method in interface org.eclipse.birt.report.engine.api.IAction
 
getReportName() - Method in interface org.eclipse.birt.report.engine.api.IReportRunnable
returns report name
getReportName() - Method in interface org.eclipse.birt.report.engine.content.IHyperlinkAction
 
getReportName() - Method in interface org.eclipse.birt.report.engine.emitter.IEmitterServices
 
getReportQueries(IBaseQueryDefinition) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemQuery
returns the report queries that the extension uses.
getReportRunnable() - Method in interface org.eclipse.birt.report.engine.api.IEngineTask
returns the runnable report design object
getReportRunnable() - Method in interface org.eclipse.birt.report.engine.api.IReportDocument
The report runnable is used to create the report document while writing.
getReportRunnable() - Method in interface org.eclipse.birt.report.engine.api.IReportPart
returns the runnable report design
getReportRunnable() - Method in interface org.eclipse.birt.report.engine.emitter.IEmitterServices
 
getResultMetaData() - Method in interface org.eclipse.birt.report.engine.api.IDataIterator
Returns the metadata of this result set's detail row.
getResultMetaData() - Method in interface org.eclipse.birt.report.engine.api.IExtractionResults
Returns the metadata of the first or current result set
This method provides the result metadata without having to first fetch the result data.
getResultSetList() - Method in interface org.eclipse.birt.report.engine.api.IDataExtractionTask
returns the metadata corresponding to the data stored in the report document, for the specific extraction level, i.e., report, daat set, report item, or report item instance levels.
getRightWidth() - Method in interface org.eclipse.birt.report.engine.content.IPageContent
 
getRootScope() - Method in class org.eclipse.birt.report.engine.api.ReportEngine
get the root scope used by the engine
getRow() - Method in interface org.eclipse.birt.report.engine.content.ICellContent
 
getRowID() - Method in class org.eclipse.birt.report.engine.api.DataID
 
getRowID() - Method in class org.eclipse.birt.report.engine.api.DataSetID
 
getRowID() - Method in interface org.eclipse.birt.report.engine.content.IRowContent
 
getRowSpan() - Method in interface org.eclipse.birt.report.engine.content.ICellContent
 
getScriptObjects() - Method in class org.eclipse.birt.report.engine.api.EngineConfig
returns a hash map that contains all the app-specific, app-wide scriptable Java objects
getSearchCriteria() - Method in interface org.eclipse.birt.report.engine.api.IAction
 
getSearchCriteria() - Method in interface org.eclipse.birt.report.engine.content.IHyperlinkAction
 
getSelectionList(String) - Method in interface org.eclipse.birt.report.engine.api.IGetParameterDefinitionTask
get the collections of a selection choices.
getSelectionList() - Method in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn
Deprecated.  
getSelectionListForCascadingGroup(String, Object[]) - Method in interface org.eclipse.birt.report.engine.api.IGetParameterDefinitionTask
The second step to work with the cascading parameters.
getSelectionListType() - Method in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn
 
getServletContext() - Method in class org.eclipse.birt.report.engine.api.EngineConfig
 
getShowIfBlank() - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
getSize() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemGeneration
Get the size of the extended item.
getSize() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation
Get the size of the extended item.
getSource() - Method in interface org.eclipse.birt.report.engine.api.IImage
returns the source type of the image.
getStartingGroupLevel() - Method in interface org.eclipse.birt.report.engine.extension.IRowSet
Returns the 1-based index of the outermost group in which the current row is the last row.
getStatusHandler() - Method in class org.eclipse.birt.report.engine.api.EngineConfig
returns the status handler
getStringFormat() - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
getStyleClass() - Method in interface org.eclipse.birt.report.engine.content.IColumn
 
getStyleClass() - Method in interface org.eclipse.birt.report.engine.content.IContent
 
getSupportedFormats() - Method in class org.eclipse.birt.report.engine.api.ReportEngine
returns all supported output formats through BIRT engine emitter extensions
getSupportedImageFormats() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderContext
 
getSupportedImageFormats() - Method in class org.eclipse.birt.report.engine.api.PDFRenderContext
 
getTOC() - Method in interface org.eclipse.birt.report.engine.content.IContent
 
getTOC() - Method in interface org.eclipse.birt.report.engine.content.IReportContent
get the TOC structure constructed in the generation.
getTailoredForFOP() - Method in class org.eclipse.birt.report.engine.api.FORenderOption
 
getTargetWindow() - Method in interface org.eclipse.birt.report.engine.api.IAction
 
getTargetWindow() - Method in interface org.eclipse.birt.report.engine.content.IHyperlinkAction
 
getTask() - Method in interface org.eclipse.birt.report.engine.emitter.IEmitterServices
 
getTempDir() - Method in class org.eclipse.birt.report.engine.api.EngineConfig
returns engine temporary directory for temporary files
getTestConfig() - Method in interface org.eclipse.birt.report.engine.api.IReportRunnable
returns test configuration for the report
getText() - Method in interface org.eclipse.birt.report.engine.content.ITextContent
string content
getTextLineThrough() - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
getTextOverline() - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
getTextUnderline() - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
getType() - Method in interface org.eclipse.birt.report.engine.api.IAction
 
getType() - Method in interface org.eclipse.birt.report.engine.content.IHyperlinkAction
 
getType() - Method in interface org.eclipse.birt.report.engine.content.ITableBandContent
get type
getTypeName() - Method in interface org.eclipse.birt.report.engine.api.IParameterDefnBase
 
getURI() - Method in interface org.eclipse.birt.report.engine.content.IImageContent
 
getURL(IAction, Object) - Method in class org.eclipse.birt.report.engine.api.HTMLActionHandler
 
getURL(IAction, Object) - Method in interface org.eclipse.birt.report.engine.api.IHTMLActionHandler
generates a URL based on the action definition
getUserAgent() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption
 
getUserPropertyValue(String) - Method in interface org.eclipse.birt.report.engine.api.IParameterDefnBase
returns the value of a user-defined property
getUserPropertyValues() - Method in interface org.eclipse.birt.report.engine.api.IParameterDefnBase
returns a collection of user-defined property name and value pairs
getValue(String) - Method in interface org.eclipse.birt.report.engine.api.IDataIterator
Returns the value of a column.
getValue(int) - Method in interface org.eclipse.birt.report.engine.api.IDataIterator
 
getValue() - Method in interface org.eclipse.birt.report.engine.api.IParameterSelectionChoice
returns the value of the selection choice
getValue() - Method in interface org.eclipse.birt.report.engine.content.IDataContent
 
getVisibleFormat() - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
getWaterMark() - Method in interface org.eclipse.birt.report.engine.content.IPageContent
 
getWidth() - Method in interface org.eclipse.birt.report.engine.content.IColumn
 
getWidth() - Method in interface org.eclipse.birt.report.engine.content.IContent
specified value, the real value is defined in IBounds
getX() - Method in interface org.eclipse.birt.report.engine.content.IContent
specified value, the real value is defined in IBounds
getY() - Method in interface org.eclipse.birt.report.engine.content.IContent
specified value, the real value is defined in IBounds

H

HELP_GUIDE - Static variable in interface org.eclipse.birt.report.engine.api.IReportRunnable
 
HTML - Static variable in class org.eclipse.birt.report.engine.api.HTMLRenderOption
 
HTMLActionHandler - class org.eclipse.birt.report.engine.api.HTMLActionHandler.
Defines a default action handler for HTML output format
HTMLActionHandler() - Constructor for class org.eclipse.birt.report.engine.api.HTMLActionHandler
 
HTMLCompleteImageHandler - class org.eclipse.birt.report.engine.api.HTMLCompleteImageHandler.
Default implementation for writing images in a form that is compatible with a web browser's "HTML Complete" save option, i.e., writes images to a predefined folder.
HTMLCompleteImageHandler() - Constructor for class org.eclipse.birt.report.engine.api.HTMLCompleteImageHandler
dummy constructor
HTMLEmitterConfig - class org.eclipse.birt.report.engine.api.HTMLEmitterConfig.
Defines an emitter configuration class for HTML output format
HTMLEmitterConfig() - Constructor for class org.eclipse.birt.report.engine.api.HTMLEmitterConfig
dummy constructor
HTMLRenderContext - class org.eclipse.birt.report.engine.api.HTMLRenderContext.
Defines the context for rendering report in HTML emitter.
HTMLRenderContext() - Constructor for class org.eclipse.birt.report.engine.api.HTMLRenderContext
dummy constrictor
HTMLRenderOption - class org.eclipse.birt.report.engine.api.HTMLRenderOption.
output settings for HTML output format
HTMLRenderOption() - Constructor for class org.eclipse.birt.report.engine.api.HTMLRenderOption
constructor
HTMLServerImageHandler - class org.eclipse.birt.report.engine.api.HTMLServerImageHandler.
Default implementation for writing images in a form that is used in a web-application.
HTMLServerImageHandler() - Constructor for class org.eclipse.birt.report.engine.api.HTMLServerImageHandler
dummy constructor
HTML_NOCSS - Static variable in class org.eclipse.birt.report.engine.api.HTMLRenderOption
 
HTML_PAGINATION - Static variable in class org.eclipse.birt.report.engine.api.HTMLRenderOption
 
HTML_TYPE - Static variable in class org.eclipse.birt.report.engine.api.HTMLRenderOption
 
HTML_TYPE - Static variable in interface org.eclipse.birt.report.engine.content.IForeignContent
the content is an string which contains HTML content
handleImage(IImage, Object, String, boolean) - Method in class org.eclipse.birt.report.engine.api.HTMLCompleteImageHandler
handles an image report item and returns an image URL
handleImage(IImage, Object, String, boolean) - Method in class org.eclipse.birt.report.engine.api.HTMLServerImageHandler
handles an image report item and returns an image URL
handleTempImage(IImage, String, boolean) - Method in class org.eclipse.birt.report.engine.api.HTMLCompleteImageHandler
 
handleTempImage(IImage, String, boolean) - Method in class org.eclipse.birt.report.engine.api.HTMLServerImageHandler
 
helper - Variable in class org.eclipse.birt.report.engine.api.ReportEngine
A helper object to carry out most ReportEngine jobs
htmlType - Variable in class org.eclipse.birt.report.engine.api.ReportRunner
used to decorate the HTML output, used in Render and RunAndRender mode.

I

IAction - interface org.eclipse.birt.report.engine.api.IAction.
Defines an interface that allows engine to pass hyperlink information to an emitter, if the emitter determines to customize the hyperlinks calculated in engine, or it wants to use a totally different hyperlink string
IBounds - interface org.eclipse.birt.report.engine.content.IBounds.
descript the geometric property of content.
ICascadingParameterGroup - interface org.eclipse.birt.report.engine.api.ICascadingParameterGroup.
 
ICellContent - interface org.eclipse.birt.report.engine.content.ICellContent.
Provides the interfaces for Cell Content
IColumn - interface org.eclipse.birt.report.engine.content.IColumn.
column definition used by table content.
IContainerContent - interface org.eclipse.birt.report.engine.content.IContainerContent.
Provides the interfaces for Container content
IContent - interface org.eclipse.birt.report.engine.content.IContent.
object created by report generator.
IContentEmitter - interface org.eclipse.birt.report.engine.emitter.IContentEmitter.
used to pass the content object to following process.
IContentVisitor - interface org.eclipse.birt.report.engine.content.IContentVisitor.
Defines the visitor interface used mainly by a buffered emitter
IDataContent - interface org.eclipse.birt.report.engine.content.IDataContent.
 
IDataExtractionTask - interface org.eclipse.birt.report.engine.api.IDataExtractionTask.
an engine task that extracts data from a report.
IDataIterator - interface org.eclipse.birt.report.engine.api.IDataIterator.
An iterator on a result set from a prepared and executed query.
IDataPreviewTask - interface org.eclipse.birt.report.engine.api.IDataPreviewTask.
 
IElement - interface org.eclipse.birt.report.engine.content.IElement.
 
IEmitterServices - interface org.eclipse.birt.report.engine.emitter.IEmitterServices.
Defines interface to supply emitters with necessary information
IEngineTask - interface org.eclipse.birt.report.engine.api.IEngineTask.
defines common features for an engine task.
IExtractionResults - interface org.eclipse.birt.report.engine.api.IExtractionResults.
A handle used to retrieve data stored in a report.
IForeignContent - interface org.eclipse.birt.report.engine.content.IForeignContent.
The content of foreign object is not handle by report engine.
IGetParameterDefinitionTask - interface org.eclipse.birt.report.engine.api.IGetParameterDefinitionTask.
an engine task that retrieves parameter definitions from a report.
IHTMLActionHandler - interface org.eclipse.birt.report.engine.api.IHTMLActionHandler.
Defines an interface for action handler used in HTML format
IHTMLImageHandler - interface org.eclipse.birt.report.engine.api.IHTMLImageHandler.
Defines the image handler interface for use in HTML format
IHyperlinkAction - interface org.eclipse.birt.report.engine.content.IHyperlinkAction.
Defines an interface that allows engine to pass hyperlink information to an emitter, if the emitter determines to customize the hyperlinks calculated in engine, or it wants to use a totally different hyperlink string
IImage - interface org.eclipse.birt.report.engine.api.IImage.
Defines an interface to communicate info about an image to image handler
IImageContent - interface org.eclipse.birt.report.engine.content.IImageContent.
Image content in the report.
ILabelContent - interface org.eclipse.birt.report.engine.content.ILabelContent.
 
IMAGE_CONTENT - Static variable in interface org.eclipse.birt.report.engine.content.IContent
 
IMAGE_EXPRESSION - Static variable in interface org.eclipse.birt.report.engine.content.IImageContent
 
IMAGE_FILE - Static variable in interface org.eclipse.birt.report.engine.content.IImageContent
 
IMAGE_HANDLER - Static variable in class org.eclipse.birt.report.engine.api.RenderOptionBase
 
IMAGE_NAME - Static variable in interface org.eclipse.birt.report.engine.content.IImageContent
 
IMAGE_TYPE - Static variable in interface org.eclipse.birt.report.engine.content.IForeignContent
the content is an image content which define the image
IMAGE_URI - Static variable in interface org.eclipse.birt.report.engine.content.IImageContent
 
INSTANCE_ID_LIST - Static variable in class org.eclipse.birt.report.engine.api.HTMLRenderOption
 
INVALID_IMAGE - Static variable in interface org.eclipse.birt.report.engine.api.IImage
 
INode - interface org.eclipse.birt.report.engine.content.INode.
Tree interface.
IPageContent - interface org.eclipse.birt.report.engine.content.IPageContent.
Page instance.
IPageHandler - interface org.eclipse.birt.report.engine.api.IPageHandler.
An interface implemented by app developer to provide handler after each page is generated in factoery.
IParameterDefn - interface org.eclipse.birt.report.engine.api.IParameterDefn.
base interface for a BIRT report parameter
IParameterDefnBase - interface org.eclipse.birt.report.engine.api.IParameterDefnBase.
Captures properties shared by all types of parameters and parameter group, i.e., name, display name, help text and custom-defined properties.
IParameterGroupDefn - interface org.eclipse.birt.report.engine.api.IParameterGroupDefn.
The interface for objects which visually groups report parameters.
IParameterSelectionChoice - interface org.eclipse.birt.report.engine.api.IParameterSelectionChoice.
defines one choice in a parameter selction value list
IRenderOption - interface org.eclipse.birt.report.engine.api.IRenderOption.
Defines render options for emitters
IRenderTask - interface org.eclipse.birt.report.engine.api.IRenderTask.
An engine task that renders a Report Document to one of the output formats supported by the engine.
IReportContent - interface org.eclipse.birt.report.engine.content.IReportContent.
The object represents the report content as a whole.
IReportDocument - interface org.eclipse.birt.report.engine.api.IReportDocument.
A report document (i.e., not modifiable) that can be rendered to other formats in the BIRT presentation engine This is the high-level report document interface.
IReportItemGeneration - interface org.eclipse.birt.report.engine.extension.IReportItemGeneration.
Represents the extended item generation extension, which processes the report item at report geenration time.
IReportItemPresentation - interface org.eclipse.birt.report.engine.extension.IReportItemPresentation.
Represents the extended item presentation time extension.
IReportItemQuery - interface org.eclipse.birt.report.engine.extension.IReportItemQuery.
Defines the extended item query extension, which handles report query preparation.
IReportPart - interface org.eclipse.birt.report.engine.api.IReportPart.
Base interface that provides accessible information for a report part
IReportRunnable - interface org.eclipse.birt.report.engine.api.IReportRunnable.
A runnable report design (i.e., not modifiable) that can be run in the BIRT engine
IRowContent - interface org.eclipse.birt.report.engine.content.IRowContent.
Provides the interfaces for the Row AbstractContent
IRowMetaData - interface org.eclipse.birt.report.engine.extension.IRowMetaData.
Defines a row that the extension might receive.
IRowSet - interface org.eclipse.birt.report.engine.extension.IRowSet.
defines an interface that wraps around a row set.
IRunAndRenderTask - interface org.eclipse.birt.report.engine.api.IRunAndRenderTask.
an engine task that runs a report and renders it to one of the output formats supported by the engine.
IRunTask - interface org.eclipse.birt.report.engine.api.IRunTask.
An engine task that runs a report and generates a report document.
IScalarParameterDefn - interface org.eclipse.birt.report.engine.api.IScalarParameterDefn.
Defines a scalar parameter
IStatusHandler - interface org.eclipse.birt.report.engine.api.IStatusHandler.
Interface that defines several status handler callback functions.
IStyle - interface org.eclipse.birt.report.engine.content.IStyle.
Provides the interfaces for the ROM style the properties must be string as the user may change them in script.
ITableBandContent - interface org.eclipse.birt.report.engine.content.ITableBandContent.
Provides the interfaces for the Table Band Content
ITableContent - interface org.eclipse.birt.report.engine.content.ITableContent.
Provides the interfaces for the Table Content
ITextContent - interface org.eclipse.birt.report.engine.content.ITextContent.
Provides the interfaces for the Text Content Text content contains several paragraphs which shares the same style properties.
InstanceID - class org.eclipse.birt.report.engine.api.InstanceID.
a class that wraps around an identifier for a report element instance
InstanceID(InstanceID, long, DataID) - Constructor for class org.eclipse.birt.report.engine.api.InstanceID
 
imageDirectory - Variable in class org.eclipse.birt.report.engine.api.HTMLRenderContext
directory to store image
imageHandler - Variable in class org.eclipse.birt.report.engine.api.HTMLEmitterConfig
default image hanlder
initialize() - Method in class org.eclipse.birt.report.engine.api.DefaultStatusHandler
 
initialize() - Method in interface org.eclipse.birt.report.engine.api.IStatusHandler
initialize the status handler.
initialize(IEmitterServices) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter
 
instanceIDs - Variable in class org.eclipse.birt.report.engine.api.HTMLRenderOption
 
isEmbededFont - Variable in class org.eclipse.birt.report.engine.api.PDFRenderContext
 
isEmbededFont() - Method in class org.eclipse.birt.report.engine.api.PDFRenderContext
 
isEmpty() - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
isHeaderRepeat() - Method in interface org.eclipse.birt.report.engine.content.ITableContent
 
isHidden() - Method in interface org.eclipse.birt.report.engine.api.IParameterDefn
returns whether the parameter is a hidden parameter
isValueConcealed() - Method in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn
 

L

LABEL_CONTENT - Static variable in interface org.eclipse.birt.report.engine.content.IContent
 
LEFT - Static variable in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn
 
LIST_BOX - Static variable in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn
 
LIST_PARAMETER - Static variable in interface org.eclipse.birt.report.engine.api.IParameterDefnBase
 
LOCALE - Static variable in class org.eclipse.birt.report.engine.api.RenderOptionBase
 
LOG_DESTINATION - Static variable in class org.eclipse.birt.report.engine.api.EngineConfig
 
LOG_LEVEL - Static variable in class org.eclipse.birt.report.engine.api.EngineConfig
 
locale - Variable in class org.eclipse.birt.report.engine.api.ReportRunner
the output locale, used in Run and RunAndRender modes.
log - Variable in class org.eclipse.birt.report.engine.api.HTMLActionHandler
logger
log - Variable in class org.eclipse.birt.report.engine.api.HTMLCompleteImageHandler
 
log - Variable in class org.eclipse.birt.report.engine.api.HTMLServerImageHandler
 
logger - Static variable in class org.eclipse.birt.report.engine.api.ReportEngine
 
logger - Static variable in class org.eclipse.birt.report.engine.api.ReportRunner
 

M

MASTER_PAGE_CONTENT - Static variable in class org.eclipse.birt.report.engine.api.HTMLRenderOption
 
main(String[]) - Static method in class org.eclipse.birt.report.engine.api.ReportRunner
Main function.
mode - Variable in class org.eclipse.birt.report.engine.api.ReportRunner
execution mode, one of the Run, RunAndRender and Render.

N

needSerialization() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemGeneration
returns whether the extended item needs serialization of state information at generation time
next() - Method in interface org.eclipse.birt.report.engine.api.IDataIterator
Moves down one element from its current position of the iterator.
next() - Method in interface org.eclipse.birt.report.engine.extension.IRowSet
move the row to next.
nextResultIterator() - Method in interface org.eclipse.birt.report.engine.api.IExtractionResults
Returns the current result's iterator.
nodeId - Variable in class org.eclipse.birt.report.engine.api.TOCNode
identifier for the current node

O

OUTPUT_AS_CUSTOM - Static variable in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation
 
OUTPUT_AS_DRAWING - Static variable in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation
 
OUTPUT_AS_HTML_TEXT - Static variable in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation
 
OUTPUT_AS_IMAGE - Static variable in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation
 
OUTPUT_AS_IMAGE_WITH_MAP - Static variable in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation
 
OUTPUT_AS_TEXT - Static variable in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation
 
OUTPUT_FILE_NAME - Static variable in class org.eclipse.birt.report.engine.api.RenderOptionBase
 
OUTPUT_FORMAT - Static variable in class org.eclipse.birt.report.engine.api.RenderOptionBase
 
OUTPUT_FORMAT_FO - Static variable in class org.eclipse.birt.report.engine.api.RenderOptionBase
 
OUTPUT_FORMAT_HTML - Static variable in class org.eclipse.birt.report.engine.api.RenderOptionBase
 
OUTPUT_FORMAT_PDF - Static variable in class org.eclipse.birt.report.engine.api.RenderOptionBase
 
OUTPUT_NONE - Static variable in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation
 
OUTPUT_STREAM - Static variable in class org.eclipse.birt.report.engine.api.RenderOptionBase
 
onCustomImage(IImage, Object) - Method in class org.eclipse.birt.report.engine.api.HTMLCompleteImageHandler
 
onCustomImage(IImage, Object) - Method in class org.eclipse.birt.report.engine.api.HTMLServerImageHandler
 
onCustomImage(IImage, Object) - Method in interface org.eclipse.birt.report.engine.api.IHTMLImageHandler
handles a custom image created for example, by chart extension.
onDesignImage(IImage, Object) - Method in class org.eclipse.birt.report.engine.api.HTMLCompleteImageHandler
 
onDesignImage(IImage, Object) - Method in class org.eclipse.birt.report.engine.api.HTMLServerImageHandler
 
onDesignImage(IImage, Object) - Method in interface org.eclipse.birt.report.engine.api.IHTMLImageHandler
handles a design image.
onDocImage(IImage, Object) - Method in class org.eclipse.birt.report.engine.api.HTMLCompleteImageHandler
 
onDocImage(IImage, Object) - Method in class org.eclipse.birt.report.engine.api.HTMLServerImageHandler
 
onDocImage(IImage, Object) - Method in interface org.eclipse.birt.report.engine.api.IHTMLImageHandler
handles a database image.
onFileImage(IImage, Object) - Method in class org.eclipse.birt.report.engine.api.HTMLCompleteImageHandler
 
onFileImage(IImage, Object) - Method in class org.eclipse.birt.report.engine.api.HTMLServerImageHandler
 
onFileImage(IImage, Object) - Method in interface org.eclipse.birt.report.engine.api.IHTMLImageHandler
handles a image specified as a on-disk URI.
onPage(int, boolean) - Method in interface org.eclipse.birt.report.engine.api.IPageHandler
 
onRowSets(IRowSet[]) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemGeneration
processes the extended item in report generation environment.
onRowSets(IRowSet[]) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation
processes the extended item in report presentation environment.
onURLImage(IImage, Object) - Method in class org.eclipse.birt.report.engine.api.HTMLCompleteImageHandler
 
onURLImage(IImage, Object) - Method in class org.eclipse.birt.report.engine.api.HTMLServerImageHandler
 
onURLImage(IImage, Object) - Method in interface org.eclipse.birt.report.engine.api.IHTMLImageHandler
handles an image specified as an external URL.
openReportDesign(String) - Method in class org.eclipse.birt.report.engine.api.ReportEngine
opens a report design file and creates a report design runnable.
openReportDesign(InputStream) - Method in class org.eclipse.birt.report.engine.api.ReportEngine
opens a report design stream and creates a report design runnable.
openReportDesign(String, InputStream) - Method in class org.eclipse.birt.report.engine.api.ReportEngine
 
openReportDocument(String) - Method in class org.eclipse.birt.report.engine.api.ReportEngine
opens a report document and returns an IReportDocument object, from which further information can be retrieved.
options - Variable in class org.eclipse.birt.report.engine.api.RenderOptionBase
a hash map that stores the rendering options
org.eclipse.birt.report.engine.api - package org.eclipse.birt.report.engine.api
This is an application-writer's interface for using the BIRT report engine.
org.eclipse.birt.report.engine.content - package org.eclipse.birt.report.engine.content
Defines interfaces of BIRT report items for Engine to pass from executors to emitters.
org.eclipse.birt.report.engine.emitter - package org.eclipse.birt.report.engine.emitter
Defines the interfaces of report emitters, and also provides serval general classes for emitters to output XML document, process hyperline, etc.
org.eclipse.birt.report.engine.extension - package org.eclipse.birt.report.engine.extension
This package defines 3 key interfaces ---- IReportItemQuery, IReportItemGeneration, and IReportItemPresentation ---- that are used to process an extended item at query preparation, report generation and report rendering times.

P

PAGE_CONTENT - Static variable in interface org.eclipse.birt.report.engine.content.IContent
 
PARAMETER_GROUP - Static variable in interface org.eclipse.birt.report.engine.api.IParameterDefnBase
 
PDFRenderContext - class org.eclipse.birt.report.engine.api.PDFRenderContext.
Defines the context for rendering report in PDF emitter.
PDFRenderContext() - Constructor for class org.eclipse.birt.report.engine.api.PDFRenderContext
dummy constrictor
pageNumber - Variable in class org.eclipse.birt.report.engine.api.ReportRunner
output page number, used in Render mode.
params - Variable in class org.eclipse.birt.report.engine.api.ReportRunner
paramters used to execute the report, used in Run and RunAndRender modes.
parent - Variable in class org.eclipse.birt.report.engine.api.TOCNode
the parent node
parentId - Variable in class org.eclipse.birt.report.engine.api.InstanceID
 
parse(String) - Static method in class org.eclipse.birt.report.engine.api.DataSetID
 
parse(char[], int, int) - Static method in class org.eclipse.birt.report.engine.api.DataSetID
 
parse(String) - Static method in class org.eclipse.birt.report.engine.api.InstanceID
 
parse(char[], int, int) - Static method in class org.eclipse.birt.report.engine.api.InstanceID
 
parse(String, int) - Method in class org.eclipse.birt.report.engine.api.ReportParameterConverter
Convert report parameter from string into object.
parseOptions() - Method in class org.eclipse.birt.report.engine.api.ReportRunner
parse the arguments.
parseParameterOptions() - Method in class org.eclipse.birt.report.engine.api.ReportRunner
paraser the paramter command line inputs.
parseRenderOptions() - Method in class org.eclipse.birt.report.engine.api.ReportRunner
 
parseRunAndRenderOptions() - Method in class org.eclipse.birt.report.engine.api.ReportRunner
 
parseRunOptions() - Method in class org.eclipse.birt.report.engine.api.ReportRunner
 
pluginId - Static variable in class org.eclipse.birt.report.engine.api.EngineException
 
printUsage() - Method in class org.eclipse.birt.report.engine.api.ReportRunner
print out the command line usage.

R

RADIO_BUTTON - Static variable in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn
 
REFRESH_RATE - Static variable in interface org.eclipse.birt.report.engine.api.IReportRunnable
 
REPORTDOC_IMAGE - Static variable in interface org.eclipse.birt.report.engine.api.IImage
 
RIGHT - Static variable in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn
 
ROW_CONTENT - Static variable in interface org.eclipse.birt.report.engine.content.IContent
 
RenderOptionBase - class org.eclipse.birt.report.engine.api.RenderOptionBase.
Settings for rendering a report to an output format.
RenderOptionBase() - Constructor for class org.eclipse.birt.report.engine.api.RenderOptionBase
constructor
ReportEngine - class org.eclipse.birt.report.engine.api.ReportEngine.
A report engine provides an entry point for reporting functionalities.
ReportEngine(EngineConfig) - Constructor for class org.eclipse.birt.report.engine.api.ReportEngine
Constructor.
ReportParameterConverter - class org.eclipse.birt.report.engine.api.ReportParameterConverter.
Utilites class to convert report paramete value between object and string.
ReportParameterConverter(String, Locale) - Constructor for class org.eclipse.birt.report.engine.api.ReportParameterConverter
 
ReportRunner - class org.eclipse.birt.report.engine.api.ReportRunner.
Defines a standalone reporting application that uses StandaloneReportEngine class.
ReportRunner(String[]) - Constructor for class org.eclipse.birt.report.engine.api.ReportRunner
Constructor of ReportRunner
rb - Static variable in class org.eclipse.birt.report.engine.api.EngineException
 
readContent(DataInputStream) - Method in interface org.eclipse.birt.report.engine.content.IContent
 
readParamFile(String, HashMap) - Method in class org.eclipse.birt.report.engine.api.ReportRunner
 
readParamString(String, HashMap) - Method in class org.eclipse.birt.report.engine.api.ReportRunner
read paramters from the param and add it into the params.
removeChildren() - Method in interface org.eclipse.birt.report.engine.content.INode
 
render(long) - Method in interface org.eclipse.birt.report.engine.api.IRenderTask
 
render(String) - Method in interface org.eclipse.birt.report.engine.api.IRenderTask
Render the page from startPageNumber to endPageNumber in the Report Doucment to an output format.
renderReport() - Method in class org.eclipse.birt.report.engine.api.ReportRunner
render the report.
rootScope - Variable in class org.eclipse.birt.report.engine.api.ReportEngine
root script scope.
rowId - Variable in class org.eclipse.birt.report.engine.api.DataID
 
run() - Method in interface org.eclipse.birt.report.engine.api.IRunAndRenderTask
runs the task to generate report document or other output format
run(String) - Method in interface org.eclipse.birt.report.engine.api.IRunTask
runs the task to generate report document
run(IDocArchiveWriter) - Method in interface org.eclipse.birt.report.engine.api.IRunTask
 
runAndRenderReport() - Method in class org.eclipse.birt.report.engine.api.ReportRunner
Execute the report design which includes:
1.
runReport() - Method in class org.eclipse.birt.report.engine.api.ReportRunner
running the report to create the report document

S

SCALAR_PARAMETER - Static variable in interface org.eclipse.birt.report.engine.api.IParameterDefnBase
 
SELECTION_LIST_DYNAMIC - Static variable in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn
 
SELECTION_LIST_NONE - Static variable in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn
 
SELECTION_LIST_STATIC - Static variable in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn
 
SERIALIZE_CONTENT - Static variable in interface org.eclipse.birt.report.engine.content.IContent
 
scriptObjects - Variable in class org.eclipse.birt.report.engine.api.EngineConfig
stores app-wide, app-specific JS scriptable objects
selectColumns(String[]) - Method in interface org.eclipse.birt.report.engine.api.IDataExtractionTask
 
selectResultSet(String) - Method in interface org.eclipse.birt.report.engine.api.IDataExtractionTask
select the result set from which to export data.
serialize(OutputStream) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemGeneration
serializes the extended item generation time state.
setActionHandle(IHTMLActionHandler) - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption
 
setActionHandler(IHTMLActionHandler) - Method in class org.eclipse.birt.report.engine.api.HTMLEmitterConfig
sets the action handler for HTML format
setActionHandler(IHTMLActionHandler) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation
 
setAltText(String) - Method in interface org.eclipse.birt.report.engine.content.IImageContent
 
setAltTextKey(String) - Method in interface org.eclipse.birt.report.engine.content.IImageContent
 
setAppContext(Map) - Method in interface org.eclipse.birt.report.engine.api.IEngineTask
sets the task context
setBackgroundPositionX(String) - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
setBackgroundPositionY(String) - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
setBaseImageURL(String) - Method in class org.eclipse.birt.report.engine.api.HTMLRenderContext
sets the base image URL for image handling
setBaseURL(String) - Method in class org.eclipse.birt.report.engine.api.HTMLRenderContext
sets the base url for action handling
setBaseURL(String) - Method in class org.eclipse.birt.report.engine.api.PDFRenderContext
sets the base url for action handling
setBookmark(String) - Method in class org.eclipse.birt.report.engine.api.TOCNode
 
setBookmark(String) - Method in interface org.eclipse.birt.report.engine.content.IContent
 
setBookmark(String) - Method in interface org.eclipse.birt.report.engine.content.IHyperlinkAction
 
setBounds(IBounds) - Method in interface org.eclipse.birt.report.engine.content.IContent
 
setCanShrink(String) - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
setColSpan(int) - Method in interface org.eclipse.birt.report.engine.content.ICellContent
 
setColumn(int) - Method in interface org.eclipse.birt.report.engine.content.ICellContent
 
setConfigurationVariable(String, String) - Method in class org.eclipse.birt.report.engine.api.EngineConfig
sets a configuration variable that is available through scripting in engine
setCssText(int, String) - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
setData(byte[]) - Method in interface org.eclipse.birt.report.engine.content.IImageContent
 
setDateFormat(String) - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
setDisplayString(String) - Method in class org.eclipse.birt.report.engine.api.TOCNode
 
setDrillThrough(String, String, Map, Map, String, String) - Method in interface org.eclipse.birt.report.engine.content.IHyperlinkAction
 
setEmbeddable(boolean) - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption
sets whether the HTML output can be embedded directly into an HTML page
setEmbededFont(boolean) - Method in class org.eclipse.birt.report.engine.api.PDFRenderContext
 
setEmitterConfiguration(String, Object) - Method in class org.eclipse.birt.report.engine.api.EngineConfig
sets configuration for a specific extension to engine, i.e., an emitter extension
setEmitterID(String) - Method in interface org.eclipse.birt.report.engine.api.IRenderTask
sets a specific emitter to use when generate output.
setEmitterID(String) - Method in interface org.eclipse.birt.report.engine.api.IRunAndRenderTask
sets a specific emitter to use when generate output.
setEngineContext(IPlatformContext) - Method in class org.eclipse.birt.report.engine.api.EngineConfig
 
setEngineHome(String) - Method in class org.eclipse.birt.report.engine.api.EngineConfig
set the BIRT_HOME system property
setExtension(String) - Method in interface org.eclipse.birt.report.engine.content.IImageContent
 
setFontDirectory(String) - Method in class org.eclipse.birt.report.engine.api.PDFRenderContext
 
setGenerateBy(Object) - Method in interface org.eclipse.birt.report.engine.content.IContent
 
setHeight(DimensionType) - Method in interface org.eclipse.birt.report.engine.content.IContent
 
setHelpKey(String) - Method in interface org.eclipse.birt.report.engine.content.IImageContent
 
setHelpText(String) - Method in interface org.eclipse.birt.report.engine.content.IContent
 
setHelpText(String) - Method in interface org.eclipse.birt.report.engine.content.ILabelContent
 
setHtmlPagination(boolean) - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption
 
setHyperlink(String, String) - Method in interface org.eclipse.birt.report.engine.content.IHyperlinkAction
 
setHyperlinkAction(IHyperlinkAction) - Method in interface org.eclipse.birt.report.engine.content.IContent
 
setImageDirectory(String) - Method in class org.eclipse.birt.report.engine.api.HTMLRenderContext
sets the image directory that engine stores images and charts into
setImageHandler(IHTMLImageHandler) - Method in class org.eclipse.birt.report.engine.api.HTMLEmitterConfig
sets the image handler for HTML format
setImageMap(Object) - Method in interface org.eclipse.birt.report.engine.content.IImageContent
 
setImageSource(int) - Method in interface org.eclipse.birt.report.engine.content.IImageContent
 
setInlineStyle(IStyle) - Method in interface org.eclipse.birt.report.engine.content.IContent
 
setInstanceID(InstanceID) - Method in interface org.eclipse.birt.report.engine.api.IDataExtractionTask
* @param iid identifies a report item instance that data extraction will happen on
setInstanceID(InstanceID) - Method in interface org.eclipse.birt.report.engine.content.IContent
 
setInstanceIDs(List) - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption
 
setLabelKey(String) - Method in interface org.eclipse.birt.report.engine.content.IDataContent
 
setLabelKey(String) - Method in interface org.eclipse.birt.report.engine.content.ILabelContent
 
setLabelText(String) - Method in interface org.eclipse.birt.report.engine.content.IDataContent
 
setLabelText(String) - Method in interface org.eclipse.birt.report.engine.content.ILabelContent
 
setLocale(Locale) - Method in interface org.eclipse.birt.report.engine.api.IEngineTask
sets the task locale
setLocale(Locale) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation
passes the locale used in the presentation.
setLogConfig(String, Level) - Method in class org.eclipse.birt.report.engine.api.EngineConfig
set log configuration, i.e., log file name prefix and log level
setMIMEType(String) - Method in interface org.eclipse.birt.report.engine.content.IImageContent
 
setMasterPage(String) - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
setMasterPageContent(boolean) - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption
 
setModelObject(ExtendedItemHandle) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemGeneration
passes a handle to the extended report item model to the extension
setModelObject(ExtendedItemHandle) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation
passes a handle to the extended report item model to the extension
setModelObject(ExtendedItemHandle) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemQuery
passes a handle to the extended report item model to the query extension
setName(String) - Method in interface org.eclipse.birt.report.engine.content.IContent
 
setNodeID(String) - Method in class org.eclipse.birt.report.engine.api.TOCNode
 
setNumberAlign(String) - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
setNumberFormat(String) - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
setOption(String, Object) - Method in class org.eclipse.birt.report.engine.api.RenderOptionBase
set value for one rendering option
setOutputFileName(String) - Method in interface org.eclipse.birt.report.engine.api.IRenderOption
sets the output file name.
setOutputFileName(String) - Method in class org.eclipse.birt.report.engine.api.RenderOptionBase
 
setOutputFormat(String) - Method in interface org.eclipse.birt.report.engine.api.IRenderOption
sets the output format
setOutputFormat(String) - Method in class org.eclipse.birt.report.engine.api.RenderOptionBase
 
setOutputFormat(String) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation
sets the output format, i.e., HTML, PDF, etc.
setOutputStream(OutputStream) - Method in interface org.eclipse.birt.report.engine.api.IRenderOption
sets the stream for writing emitter output
setOutputStream(OutputStream) - Method in class org.eclipse.birt.report.engine.api.RenderOptionBase
 
setPageHandler(IPageHandler) - Method in interface org.eclipse.birt.report.engine.api.IRunTask
set up event handler to be called after each page is generated
setPageNumber(long) - Method in interface org.eclipse.birt.report.engine.content.IPageContent
 
setParameterValue(String, Object) - Method in interface org.eclipse.birt.report.engine.api.IEngineTask
sets one parameter value
setParameterValues(Map) - Method in interface org.eclipse.birt.report.engine.api.IEngineTask
set all parameter valuess
setParent(TOCNode) - Method in class org.eclipse.birt.report.engine.api.TOCNode
 
setParent(IElement) - Method in interface org.eclipse.birt.report.engine.content.IElement
 
setParent(INode) - Method in interface org.eclipse.birt.report.engine.content.INode
 
setProperties(IStyle) - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
setProperty(int, CSSValue) - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
setRawType(String) - Method in interface org.eclipse.birt.report.engine.content.IForeignContent
 
setRawValue(Object) - Method in interface org.eclipse.birt.report.engine.content.IForeignContent
 
setRenderOption(IRenderOption) - Method in interface org.eclipse.birt.report.engine.api.IRenderTask
set the rendering options
setRenderOption(IRenderOption) - Method in interface org.eclipse.birt.report.engine.api.IRunAndRenderTask
set the rendering options
setReportContent(IReportContent) - Method in interface org.eclipse.birt.report.engine.content.IContent
 
setReportQueries(IBaseQueryDefinition[]) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemGeneration
pass the prepared query definition to extended item implementation, so that it can access data.
setReportQueries(IBaseQueryDefinition[]) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation
pass the prepared query definition to extended item implementation, so that it can access data.
setResolution(int) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation
passes the dpi (dot per inch) from the rendering environment to the extension.
setRowID(int) - Method in interface org.eclipse.birt.report.engine.content.IRowContent
 
setRowSpan(int) - Method in interface org.eclipse.birt.report.engine.content.ICellContent
 
setScriptContext(IReportContext) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemGeneration
pass the script context to the report item.
setScriptContext(IReportContext) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation
pass the script context to the report item.
setShowIfBlank(String) - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
setStatusHandler(IStatusHandler) - Method in class org.eclipse.birt.report.engine.api.EngineConfig
sets the handler for reporting report running status.
setStringFormat(String) - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
setStyleClass(String) - Method in interface org.eclipse.birt.report.engine.content.IContent
 
setSupportedImageFormats(String) - Method in class org.eclipse.birt.report.engine.api.HTMLRenderContext
 
setSupportedImageFormats(String) - Method in class org.eclipse.birt.report.engine.api.PDFRenderContext
 
setSupportedImageFormats(String) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation
sets the image formats that are supported for this output format.
setTOC(String) - Method in interface org.eclipse.birt.report.engine.content.IContent
 
setTailoredForFOP(boolean) - Method in class org.eclipse.birt.report.engine.api.FORenderOption
sets whether the output needs to be tailored for FOP use.
setTempDir(String) - Method in class org.eclipse.birt.report.engine.api.EngineConfig
sets the directory for temporary files
setText(String) - Method in interface org.eclipse.birt.report.engine.content.ITextContent
 
setTextLineThrough(String) - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
setTextOverline(String) - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
setTextUnderline(String) - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
setURI(String) - Method in interface org.eclipse.birt.report.engine.content.IImageContent
 
setUserAgent(String) - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption
 
setValue(String, Object) - Method in interface org.eclipse.birt.report.engine.api.IGetParameterDefinitionTask
Set one parameter value.
setValue(Object) - Method in interface org.eclipse.birt.report.engine.content.IDataContent
 
setVisibleFormat(String) - Method in interface org.eclipse.birt.report.engine.content.IStyle
 
setWidth(DimensionType) - Method in interface org.eclipse.birt.report.engine.content.IContent
 
setX(DimensionType) - Method in interface org.eclipse.birt.report.engine.content.IContent
 
setY(DimensionType) - Method in interface org.eclipse.birt.report.engine.content.IContent
 
showStatus(String) - Method in class org.eclipse.birt.report.engine.api.DefaultStatusHandler
 
showStatus(String) - Method in interface org.eclipse.birt.report.engine.api.IStatusHandler
showa the status string
shutdown() - Method in class org.eclipse.birt.report.engine.api.ReportEngine
shut down the engine, release all the resources.
source - Variable in class org.eclipse.birt.report.engine.api.ReportRunner
the source input ,can be designName or reportArchive name
start(IReportContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter
 
startCell(ICellContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter
 
startContainer(IContainerContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter
 
startContent(IContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter
 
startData(IDataContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter
 
startForeign(IForeignContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter
 
startImage(IImageContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter
 
startLabel(ILabelContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter
 
startPage(IPageContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter
start a page
startRow(IRowContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter
 
startTable(ITableContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter
table started
startTableBody(ITableBandContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter
 
startTableFooter(ITableBandContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter
 
startTableHeader(ITableBandContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter
 
startText(ITextContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter
 
statusHandler - Variable in class org.eclipse.birt.report.engine.api.EngineConfig
default status handler
stringToObject(int, String) - Method in class org.eclipse.birt.report.engine.api.ReportRunner
 
supportedImageFormats - Variable in class org.eclipse.birt.report.engine.api.HTMLRenderContext
the image formats supported by the browser
supportedImageFormats - Variable in class org.eclipse.birt.report.engine.api.PDFRenderContext
the image formats supported by the browser

T

TABLE_BAND_CONTENT - Static variable in interface org.eclipse.birt.report.engine.content.IContent
 
TABLE_CONTENT - Static variable in interface org.eclipse.birt.report.engine.content.IContent
 
TABLE_PARAMETER - Static variable in interface org.eclipse.birt.report.engine.api.IParameterDefnBase
 
TEMPLATE_TYPE - Static variable in interface org.eclipse.birt.report.engine.content.IForeignContent
the content is an template
TEMP_DIR - Static variable in class org.eclipse.birt.report.engine.api.EngineConfig
 
TEXT_BOX - Static variable in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn
 
TEXT_CONTENT - Static variable in interface org.eclipse.birt.report.engine.content.IContent
 
TEXT_TYPE - Static variable in interface org.eclipse.birt.report.engine.content.IForeignContent
the content is an string which contains plain text
TITLE - Static variable in interface org.eclipse.birt.report.engine.api.IReportRunnable
 
TOCNode - class org.eclipse.birt.report.engine.api.TOCNode.
A node that wraps around a TOC entry.
TOCNode() - Constructor for class org.eclipse.birt.report.engine.api.TOCNode
 
TYPE_ANY - Static variable in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn
 
TYPE_BOOLEAN - Static variable in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn
 
TYPE_DATE_TIME - Static variable in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn
 
TYPE_DECIMAL - Static variable in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn
 
TYPE_FLOAT - Static variable in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn
 
TYPE_STRING - Static variable in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn
 
targetFile - Variable in class org.eclipse.birt.report.engine.api.ReportRunner
The target file name
toString() - Method in class org.eclipse.birt.report.engine.api.DataID
 
toString() - Method in class org.eclipse.birt.report.engine.api.DataSetID
 
toString() - Method in class org.eclipse.birt.report.engine.api.InstanceID
 

U

UNITS - Static variable in interface org.eclipse.birt.report.engine.api.IReportRunnable
 
UNKNOWN_TYPE - Static variable in interface org.eclipse.birt.report.engine.content.IForeignContent
the content is unkown
URL_ENCODING - Static variable in class org.eclipse.birt.report.engine.api.HTMLRenderOption
 
URL_IMAGE - Static variable in interface org.eclipse.birt.report.engine.api.IImage
 
USER_AGENT - Static variable in class org.eclipse.birt.report.engine.api.HTMLRenderOption
 

V

VALUE_TYPE - Static variable in interface org.eclipse.birt.report.engine.content.IForeignContent
the object value
validateParameters() - Method in interface org.eclipse.birt.report.engine.api.IEngineTask
 
visit(IContent, Object) - Method in interface org.eclipse.birt.report.engine.content.IContentVisitor
 
visitCell(ICellContent, Object) - Method in interface org.eclipse.birt.report.engine.content.IContentVisitor
visit cell content object
visitContainer(IContainerContent, Object) - Method in interface org.eclipse.birt.report.engine.content.IContentVisitor
visit content( free-form and list band)
visitContent(IContent, Object) - Method in interface org.eclipse.birt.report.engine.content.IContentVisitor
 
visitData(IDataContent, Object) - Method in interface org.eclipse.birt.report.engine.content.IContentVisitor
 
visitForeign(IForeignContent, Object) - Method in interface org.eclipse.birt.report.engine.content.IContentVisitor
visit exteded item
visitImage(IImageContent, Object) - Method in interface org.eclipse.birt.report.engine.content.IContentVisitor
visit image content
visitLabel(ILabelContent, Object) - Method in interface org.eclipse.birt.report.engine.content.IContentVisitor
 
visitPage(IPageContent, Object) - Method in interface org.eclipse.birt.report.engine.content.IContentVisitor
 
visitRow(IRowContent, Object) - Method in interface org.eclipse.birt.report.engine.content.IContentVisitor
visit the row content object
visitTable(ITableContent, Object) - Method in interface org.eclipse.birt.report.engine.content.IContentVisitor
visit table content object
visitTableBand(ITableBandContent, Object) - Method in interface org.eclipse.birt.report.engine.content.IContentVisitor
visit table band
visitText(ITextContent, Object) - Method in interface org.eclipse.birt.report.engine.content.IContentVisitor
visit the text content object

W

writeContent(DataOutputStream) - Method in interface org.eclipse.birt.report.engine.content.IContent
 
writeImage(File) - Method in interface org.eclipse.birt.report.engine.api.IImage
write the image to a destination file

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

Copyright © 2005 Actuate Corp. All rights reserved.