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

A

accept(IContentVisitor, Object) - Method in interface org.eclipse.birt.report.engine.content.IContent

use visitor to process the object.

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_DATA - Static variable in interface org.eclipse.birt.report.engine.api.IDataAction

data action, the user can safely type cast this object to IDataAction

ACTION_DRILLTHROUGH - Static variable in interface org.eclipse.birt.report.engine.api.IAction

drillthrough action

ACTION_DRILLTHROUGH - Static variable in interface org.eclipse.birt.report.engine.content.IHyperlinkAction

drillthrough action

ACTION_HANDLER - Static variable in interface org.eclipse.birt.report.engine.api.IDataExtractionOption

ACTION_HANDLER - Static variable in interface org.eclipse.birt.report.engine.api.IRenderOption

ACTION_HYPERLINK - Static variable in interface org.eclipse.birt.report.engine.api.IAction

hyperlink action

ACTION_HYPERLINK - Static variable in interface org.eclipse.birt.report.engine.content.IHyperlinkAction

hyperlink action

addArea(AbstractArea) - Method in class org.eclipse.birt.report.engine.layout.pdf.emitter.InlineBlockLayout

addCachedImage(String, int, IImage, IReportContext) - Method in class org.eclipse.birt.report.engine.api.HTMLImageHandler

add the image into cache.

addCachedImage(String, int, IImage, IReportContext) - Method in interface org.eclipse.birt.report.engine.api.IHTMLImageHandler

add the image into image cache, so it can be accessed through getCachedImage.

addColumn(IColumn) - Method in interface org.eclipse.birt.report.engine.content.ITableContent

addScriptableJavaObject(String, Object) - Method in class org.eclipse.birt.report.engine.api.EngineConfig

Deprecated. the user need add the object to the appContext directly.

addScriptableJavaObject(String, Object) - Method in interface org.eclipse.birt.report.engine.api.IEngineTask

Deprecated. user should add it to appContext.

addToRoot(AbstractArea) - Method in class org.eclipse.birt.report.engine.layout.pdf.emitter.InlineContainerLayout

addToRoot(AbstractArea) - Method in class org.eclipse.birt.report.engine.layout.pdf.emitter.InlineStackingLayout

allowBlank() - Method in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn

Deprecated.

allowNewValues() - Method in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn

returns whether the user can enter a value different from values in a selection list Applies only to parameters with a selection list.

allowNull() - Method in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn

Deprecated.

APP_BASE_URL - Static variable in interface org.eclipse.birt.report.engine.api.IRenderOption

APP_BASE_URL is the same as BASE_URL

APPCONTEXT_BIRT_VIEWER_HTTPSERVET_REQUEST - Static variable in class org.eclipse.birt.report.engine.api.EngineConstants

APPCONTEXT_CHART_PRINT_RESOLUTION - Static variable in class org.eclipse.birt.report.engine.api.EngineConstants

Deprecated. use APPCONTEXT_CHART_RESOLUTION instead of APPCONTEXT_CHART_PRINT_RESOLUTION

APPCONTEXT_CHART_RESOLUTION - Static variable in class org.eclipse.birt.report.engine.api.EngineConstants

APPCONTEXT_CLASSLOADER_KEY - Static variable in class org.eclipse.birt.report.engine.api.EngineConstants

APPCONTEXT_DATASET_CACHE_OPTION - Static variable in class org.eclipse.birt.report.engine.api.EngineConstants

APPCONTEXT_HTML_RENDER_CONTEXT - Static variable in class org.eclipse.birt.report.engine.api.EngineConstants

APPCONTEXT_PDF_RENDER_CONTEXT - Static variable in class org.eclipse.birt.report.engine.api.EngineConstants

append(StringBuffer) - Method in class org.eclipse.birt.report.engine.api.DataID

add the instance id to the string buffer.

append(StringBuffer) - Method in class org.eclipse.birt.report.engine.api.InstanceID

Append unique id, designId, dataId to buffer.

appendBookmark(StringBuffer, String) - Method in class org.eclipse.birt.report.engine.api.HTMLActionHandler

Append bookmark.

appendBookmarkAsParamter(StringBuffer, String) - Method in class org.eclipse.birt.report.engine.api.HTMLActionHandler

Append bookmark as parameter .

appendChild(INode) - Method in interface org.eclipse.birt.report.engine.content.INode

Append a child to this node.

appendFormat(StringBuffer, String) - Method in class org.eclipse.birt.report.engine.api.HTMLActionHandler

Append format.

appendParamter(StringBuffer, String, Object) - Method in class org.eclipse.birt.report.engine.api.HTMLActionHandler

Append parameter.

appendReportDesignName(StringBuffer, String) - Method in class org.eclipse.birt.report.engine.api.HTMLActionHandler

Append report design name into a StringBuffer.

appendUniqueID(StringBuffer) - Method in class org.eclipse.birt.report.engine.api.InstanceID

Append uniqueID to buffer.

args - Variable in class org.eclipse.birt.report.engine.api.ReportRunner

the input paramters

AUTHOR - Static variable in interface org.eclipse.birt.report.engine.api.IReportRunnable

AUTO - Static variable in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn

AUTO_SUGGEST - Static variable in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn

AUTOTEXT_CONTENT - Static variable in interface org.eclipse.birt.report.engine.content.IContent

B

BACKGROUND_ATTACHMENT - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

BACKGROUND_COLOR - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

BACKGROUND_IMAGE - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

BACKGROUND_POSITION_X - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

BACKGROUND_POSITION_Y - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

BACKGROUND_REPEAT - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

BAND_DETAIL - Static variable in interface org.eclipse.birt.report.engine.content.IBandContent

BAND_FOOTER - Static variable in interface org.eclipse.birt.report.engine.content.IBandContent

BAND_GROUP_FOOTER - Static variable in interface org.eclipse.birt.report.engine.content.IBandContent

BAND_GROUP_HEADER - Static variable in interface org.eclipse.birt.report.engine.content.IBandContent

BAND_HEADER - Static variable in interface org.eclipse.birt.report.engine.content.IBandContent

BASE_IMAGE_URL - Static variable in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

BASE_PROP - Static variable in interface org.eclipse.birt.report.engine.api.IReportRunnable

BASE_URL - Static variable in interface org.eclipse.birt.report.engine.api.IRenderOption

baseImageURL - Variable in class org.eclipse.birt.report.engine.api.HTMLRenderContext

Deprecated. base URL used for image

baseURL - Variable in class org.eclipse.birt.report.engine.api.DOCRenderContext

base URL used for action handler

baseURL - Variable in class org.eclipse.birt.report.engine.api.HTMLRenderContext

Deprecated. base URL used for action handler

baseURL - Variable in class org.eclipse.birt.report.engine.api.PDFRenderContext

Deprecated. base URL used for action handler

birtException - Variable in exception org.eclipse.birt.report.engine.api.EngineException

bookmark - Variable in class org.eclipse.birt.report.engine.api.TOCNode

A bookmark that is stored for the TOC

BORDER_BOTTOM_COLOR - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

BORDER_BOTTOM_STYLE - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

BORDER_BOTTOM_WIDTH - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

BORDER_LEFT_COLOR - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

BORDER_LEFT_STYLE - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

BORDER_LEFT_WIDTH - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

BORDER_RIGHT_COLOR - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

BORDER_RIGHT_STYLE - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

BORDER_RIGHT_WIDTH - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

BORDER_TOP_COLOR - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

BORDER_TOP_STYLE - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

BORDER_TOP_WIDTH - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

buildDrillAction(IAction, Object) - Method in class org.eclipse.birt.report.engine.api.HTMLActionHandler

builds URL for drillthrough action

C

CachedImage - Class in org.eclipse.birt.report.engine.api

Cached Image Created by the IHTMLImageHandler.

CachedImage() - Constructor for class org.eclipse.birt.report.engine.api.CachedImage

create an empty cache.

CachedImage(String, String) - Constructor for class org.eclipse.birt.report.engine.api.CachedImage

create a instance of cached image.

CAN_SHRINK - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

cancel() - Method in interface org.eclipse.birt.report.engine.api.IEngineTask

set the cancel flag if the task is running.

cancel(Object) - Method in interface org.eclipse.birt.report.engine.api.IEngineTask

Deprecated. user should use cancel() instead.

CANCEL_ON_ERROR - Static variable in interface org.eclipse.birt.report.engine.api.IEngineTask

cancel the task execution if there is an error.

CASCADING_PARAMETER_GROUP - Static variable in interface org.eclipse.birt.report.engine.api.IParameterDefnBase

CELL_CONTENT - Static variable in interface org.eclipse.birt.report.engine.content.IContent

cellId - Variable in class org.eclipse.birt.report.engine.api.DataID

Id of the cell.

CENTER - Static variable in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn

changeLogLevel(Level) - Method in interface org.eclipse.birt.report.engine.api.IReportEngine

Change the log level to newLevel.

changeLogLevel(Level) - Method in class org.eclipse.birt.report.engine.api.ReportEngine

Change the log level to newLevel

CHECK_BOX - Static variable in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn

checkObjectType() - Method in class org.eclipse.birt.report.engine.layout.pdf.emitter.ImageLayout

checkTargetFileName() - Method in class org.eclipse.birt.report.engine.api.ReportRunner

If -o (targetFile) is not specified, assume same directory as inputfile, and inputfile.*** as output file name (where *** is the output format.

children - Variable in class org.eclipse.birt.report.engine.api.TOCNode

A list of children for the TOC node

CLIP_CONTENT - Static variable in interface org.eclipse.birt.report.engine.api.IPDFRenderOption

cloneContent(boolean) - Method in interface org.eclipse.birt.report.engine.content.IContent

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.IDocumentWriter

close this document writer; this method might trigger updates of the report document

close() - Method in interface org.eclipse.birt.report.engine.api.IEngineTask

close the task, relese any resources.

close() - Method in interface org.eclipse.birt.report.engine.api.IExtractionResults

Closes all query result set(s) associated with this object; provides a hint to the query that it can safely release all associated resources.

close() - Method in interface org.eclipse.birt.report.engine.api.IReportDocument

close the report document, rlease all resources.

close() - Method in interface org.eclipse.birt.report.engine.extension.IBaseResultSet

close() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemExecutor

close the executor, if the executor is closed, all sub executor will be terminate also.

close() - Method in interface org.eclipse.birt.report.engine.extension.IRowSet

clse the row set

close() - Method in class org.eclipse.birt.report.engine.layout.content.ItemExecutorWrapper

close() - Method in interface org.eclipse.birt.report.engine.layout.emitter.IPageDevice

Closes this page device.

CLOSE_OUTPUTSTREAM_ON_EXIT - Static variable in interface org.eclipse.birt.report.engine.api.IRenderOption

Should the output stream be closed when render task exits.The value is a Boolean object, default is Boolean.FALSE

closeLayout() - Method in class org.eclipse.birt.report.engine.layout.pdf.emitter.ImageLayout

closeLayout(ContainerLayout.ContainerContext, int, boolean) - Method in class org.eclipse.birt.report.engine.layout.pdf.emitter.InlineBlockLayout

closeLayout() - Method in class org.eclipse.birt.report.engine.layout.pdf.emitter.InlineBlockLayout

closeLayout(ContainerLayout.ContainerContext, int, boolean) - Method in class org.eclipse.birt.report.engine.layout.pdf.emitter.InlineContainerLayout

closeLayout(ContainerLayout.ContainerContext, int, boolean) - Method in class org.eclipse.birt.report.engine.layout.pdf.emitter.InlineStackingLayout

closeOutputStreamOnExit(boolean) - Method in class org.eclipse.birt.report.engine.api.RenderOption

Get flag indicates if the output stream needs to be closed on exit.

COLOR - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

COMMENTS - Static variable in interface org.eclipse.birt.report.engine.api.IReportRunnable

ComponentID - Class in org.eclipse.birt.report.engine.api

a class that wraps around an identifier for a report component

ComponentID() - Constructor for class org.eclipse.birt.report.engine.api.ComponentID

componentID - Variable in class org.eclipse.birt.report.engine.api.ComponentID

CONTAINER_CONTENT - Static variable in interface org.eclipse.birt.report.engine.content.IContent

content - Variable in class org.eclipse.birt.report.engine.layout.content.ItemExecutorWrapper

CONTINUE_ON_ERROR - Static variable in interface org.eclipse.birt.report.engine.api.IEngineTask

continue the task execution if there is an error.

copy(IArchiveFile, IArchiveFile, IReportRunnable) - Static method in class org.eclipse.birt.report.engine.api.DocumentUtil

createActionContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent

create a anction content.

createAutoTextContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent

create the auto text content.

createCellContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent

create a cell content.

createContainerContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent

create a container content.

createDataContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent

create the data content.

createDataContent(IContent) - Method in interface org.eclipse.birt.report.engine.content.IReportContent

create the data content, copy the properties from the template content.

createDataExtractionTask(IReportDocument) - Method in interface org.eclipse.birt.report.engine.api.IReportEngine

Creates a task that allows data extraction from a report document.

createDataExtractionTask(IReportDocument) - Method in class org.eclipse.birt.report.engine.api.ReportEngine

creates a task that allows data extraction from a report document

CREATEDBY - Static variable in interface org.eclipse.birt.report.engine.api.IReportRunnable

createEngineConfig() - Method in class org.eclipse.birt.report.engine.api.ReportRunner

new a EngineConfig and config it with user's setting

createEventHandler() - Method in interface org.eclipse.birt.report.engine.extension.IExtendedItem

createExecutor(IReportItemExecutor, Object) - Method in interface org.eclipse.birt.report.engine.extension.IExecutorContext

create IReportItemExecutor of handle, the extendedItem is child.

createExecutor() - Method in interface org.eclipse.birt.report.engine.extension.IExtendedItem

createExtendedItem(ExtendedItemHandle) - Method in interface org.eclipse.birt.report.engine.extension.IExtendedItemFactory

createForeignContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent

create the foreign content.

createGetParameterDefinitionTask(IReportRunnable) - Method in interface org.eclipse.birt.report.engine.api.IReportEngine

Creates an engine task for obtaining report parameter definitions.

createGetParameterDefinitionTask(IReportRunnable) - Method in class org.eclipse.birt.report.engine.api.ReportEngine

creates an engine task for obtaining report parameter definitions

createImageContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent

create the image content.

createImageContent(IContent) - Method in interface org.eclipse.birt.report.engine.content.IReportContent

create the image content, copy the properties from the template content.

createLabelContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent

create the label content.

createLabelContent(IContent) - Method in interface org.eclipse.birt.report.engine.content.IReportContent

create the label content, copy the properties from the template content.

createListBandContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent

createListContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent

createListGroupContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent

createPageContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent

create a page content.

createPreparation() - Method in interface org.eclipse.birt.report.engine.extension.IExtendedItem

createPresentation() - Method in interface org.eclipse.birt.report.engine.extension.IExtendedItem

createQuery() - Method in interface org.eclipse.birt.report.engine.extension.IExtendedItem

createQuery(IDataQueryDefinition, ReportElementHandle) - Method in interface org.eclipse.birt.report.engine.extension.IQueryContext

delegate to report engine to build query, the extened item may call this api to build children��s query

createRenderTask(IReportDocument, IReportRunnable) - Method in interface org.eclipse.birt.report.engine.api.IReportEngine

Create a task that renders the report to a specific output format.

createRenderTask(IReportDocument) - Method in interface org.eclipse.birt.report.engine.api.IReportEngine

Creates a task that renders the report to a specific output format.

createRenderTask(IReportDocument) - Method in class org.eclipse.birt.report.engine.api.ReportEngine

creates a task that renders the report to a specific output format.

createRenderTask(IReportDocument, IReportRunnable) - Method in class org.eclipse.birt.report.engine.api.ReportEngine

create a task that renders the report to a specific output format.

createReportEngine(EngineConfig) - Method in interface org.eclipse.birt.report.engine.api.IReportEngineFactory

create a new report engine object.

createReportQueries(IDataQueryDefinition) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemQuery

createRoot() - Method in class org.eclipse.birt.report.engine.layout.pdf.emitter.InlineBlockLayout

createRoot() - Method in class org.eclipse.birt.report.engine.layout.pdf.emitter.InlineContainerLayout

createRoot() - Method in class org.eclipse.birt.report.engine.layout.pdf.emitter.InlineStackingLayout

createRowContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent

create the row content.

createRunAndRenderTask(IReportRunnable) - Method in interface org.eclipse.birt.report.engine.api.IReportEngine

Creates an engine task for running and rendering report directly to output format.

createRunAndRenderTask(IReportRunnable) - Method in class org.eclipse.birt.report.engine.api.ReportEngine

creates an engine task for running and rendering report directly to output format

createRunTask(IReportRunnable) - Method in interface org.eclipse.birt.report.engine.api.IReportEngine

Creates a task to run a report to generate a report document.

createRunTask(IReportRunnable) - Method in class org.eclipse.birt.report.engine.api.ReportEngine

creates a task to run a report to generate a report document

createStyle() - Method in interface org.eclipse.birt.report.engine.content.IReportContent

create a style.

createTableBandContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent

createTableContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent

create an table content.

createTableGroupContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent

createTextContent() - Method in interface org.eclipse.birt.report.engine.content.IReportContent

create the text content.

createTextContent(IContent) - Method in interface org.eclipse.birt.report.engine.content.IReportContent

create the text content, copy the properties from the template content.

createUniqueFile(String, String, String) - Method in class org.eclipse.birt.report.engine.api.HTMLCompleteImageHandler

Creates a unique temporary file to store an image

createUniqueFileName(String, String) - Method in class org.eclipse.birt.report.engine.api.HTMLServerImageHandler

returns a unique file name based on a directory and name prefix

createUniqueFileName(String, String, String) - Method in class org.eclipse.birt.report.engine.api.HTMLServerImageHandler

creates a unique tempoary file to store an image

CUBE_RESULTSET - Static variable in interface org.eclipse.birt.report.engine.extension.IBaseResultSet

CUSTOM_IMAGE - Static variable in interface org.eclipse.birt.report.engine.api.IImage

D

DATA_CONTENT - Static variable in interface org.eclipse.birt.report.engine.content.IContent

DataExtractionFormatInfo - Class in org.eclipse.birt.report.engine.api

DataExtractionFormatInfo(String, String, String, String, Boolean, IConfigurationElement) - Constructor for class org.eclipse.birt.report.engine.api.DataExtractionFormatInfo

Constructor of the class DataExtractionFormatInfo.

DataExtractionOption - Class in org.eclipse.birt.report.engine.api

DataExtractionOption() - Constructor for class org.eclipse.birt.report.engine.api.DataExtractionOption

DataExtractionOption(Map) - Constructor for class org.eclipse.birt.report.engine.api.DataExtractionOption

DataID - Class in org.eclipse.birt.report.engine.api

the data id of the data used by an instance.

DataID(DataSetID, long) - Constructor for class org.eclipse.birt.report.engine.api.DataID

Create the new data id instance.

DataID(DataSetID, String) - Constructor for class org.eclipse.birt.report.engine.api.DataID

Create the new data id instantce.

dataId - Variable in class org.eclipse.birt.report.engine.api.InstanceID

dataSet - Variable in class org.eclipse.birt.report.engine.api.DataID

Data set id.

DataSetID - Class in org.eclipse.birt.report.engine.api

ID represent the data set.

DataSetID(DataSetID, long, String) - Constructor for class org.eclipse.birt.report.engine.api.DataSetID

DataSetID of the subquery.

DataSetID(DataSetID, String, String) - Constructor for class org.eclipse.birt.report.engine.api.DataSetID

DataSetID of the subquery.

DataSetID(String) - Constructor for class org.eclipse.birt.report.engine.api.DataSetID

create a dataset id of a normal query.

DATE_FORMAT - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

DEFAULT_RENDER_OPTION - Static variable in interface org.eclipse.birt.report.engine.api.IEngineConfig

the default render option which used by all emitters

DefaultStatusHandler - Class in org.eclipse.birt.report.engine.api

default implementation for a status handler.

DefaultStatusHandler() - Constructor for class org.eclipse.birt.report.engine.api.DefaultStatusHandler

DESCRIPTION - Static variable in interface org.eclipse.birt.report.engine.api.IReportRunnable

deserialize(InputStream) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation

deserializes generation time state information about the extended item

DESIGN_IMAGE - Static variable in interface org.eclipse.birt.report.engine.api.IImage

designId - Variable in class org.eclipse.birt.report.engine.api.InstanceID

destroy() - Method in interface org.eclipse.birt.report.engine.api.IReportEngine

Shut down the engine, release all the resources.

destroy() - Method in class org.eclipse.birt.report.engine.api.ReportEngine

shuts down the report engine

dftRb - Static variable in exception org.eclipse.birt.report.engine.api.EngineException

DIRECTION - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

DISPLAY - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

displayExpanded() - Method in interface org.eclipse.birt.report.engine.api.IParameterGroupDefn

returns whether to display the parameter group in expanded form

displayInFixedOrder() - Method in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn

returns whether the UI should display the seleciton list in a fixed order.

displayString - Variable in class org.eclipse.birt.report.engine.api.TOCNode

the string to be displayed for the TOC entry

dispose() - Method in interface org.eclipse.birt.report.engine.layout.emitter.IPage

DOCRenderContext - Class in org.eclipse.birt.report.engine.api

DOCRenderContext() - Constructor for class org.eclipse.birt.report.engine.api.DOCRenderContext

dummy constrictor

DOCUMENT_EXTENSION - Static variable in interface org.eclipse.birt.report.engine.content.IContent

DocumentUtil - Class in org.eclipse.birt.report.engine.api

DocumentUtil() - Constructor for class org.eclipse.birt.report.engine.api.DocumentUtil

DPI - Static variable in interface org.eclipse.birt.report.engine.api.IPDFRenderOption

The customer defined DPI setting for image display.

drawBackgroundColor(Color, int, int, int, int) - Method in interface org.eclipse.birt.report.engine.layout.emitter.IPage

Draws the background color at the contentByteUnder of the pdf

drawBackgroundImage(int, int, int, int, String, String, int, int) - Method in interface org.eclipse.birt.report.engine.layout.emitter.IPage

drawImage(String, byte[], String, int, int, int, int, String) - Method in interface org.eclipse.birt.report.engine.layout.emitter.IPage

drawImage(String, String, int, int, int, int, String) - Method in interface org.eclipse.birt.report.engine.layout.emitter.IPage

drawLine(int, int, int, int, int, Color, String) - Method in interface org.eclipse.birt.report.engine.layout.emitter.IPage

Draws a line from the start position to the end position with the given line width, color, and style.

drawText(String, int, int, int, int, TextStyle) - Method in interface org.eclipse.birt.report.engine.layout.emitter.IPage

Draws text at specified position with specified styles.

E

elementId - Variable in exception org.eclipse.birt.report.engine.api.EngineException

EMITTER_CONFIGS - Static variable in interface org.eclipse.birt.report.engine.api.IEngineConfig

contains a hashmap which saved the default render options.

EMITTER_ID - Static variable in interface org.eclipse.birt.report.engine.api.IRenderOption

EmitterInfo - Class in org.eclipse.birt.report.engine.api

The descriptor of the plugin emitter.

EmitterInfo(String, String, String, String, String, String, String, Boolean, Boolean, IConfigurationElement) - Constructor for class org.eclipse.birt.report.engine.api.EmitterInfo

EMPTY_CHILDREN - Static variable in class org.eclipse.birt.report.engine.api.TOCNode

enableProgressiveViewing(boolean) - Method in interface org.eclipse.birt.report.engine.api.IRunTask

need the run task support progressive viewing.

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

endClip() - Method in interface org.eclipse.birt.report.engine.layout.emitter.IPage

restores last graphic state.

endContainer(IContainerContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter

endContent(IContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter

endGroup(IGroupContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter

endLine() - Method in interface org.eclipse.birt.report.engine.layout.pdf.emitter.IInlineStackingLayout

endLine() - Method in class org.eclipse.birt.report.engine.layout.pdf.emitter.InlineContainerLayout

endLine() - Method in class org.eclipse.birt.report.engine.layout.pdf.emitter.InlineStackingLayout

endList(IListContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter

endListBand(IListBandContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter

endListGroup(IListGroupContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter

endPage(IPageContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter

page end

endRow(IRowContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter

endTable(ITableContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter

table end

endTableBand(ITableBandContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter

endTableGroup(ITableGroupContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter

engine - Variable in class org.eclipse.birt.report.engine.api.ReportEngine

the report engine.

ENGINE_LOGGER - Static variable in interface org.eclipse.birt.report.engine.api.IEngineConfig

define the logger used by the report engine.

EngineConfig - Class in org.eclipse.birt.report.engine.api

Wraps around configuration settings for report engine.

EngineConfig() - Constructor for class org.eclipse.birt.report.engine.api.EngineConfig

constructor

EngineConstants - Class in org.eclipse.birt.report.engine.api

Defines various constants that engine host may need to use

EngineConstants() - Constructor for class org.eclipse.birt.report.engine.api.EngineConstants

EngineException - Exception in org.eclipse.birt.report.engine.api

Define an engine exception that clients of the engine need to handle.

EngineException(BirtException) - Constructor for exception org.eclipse.birt.report.engine.api.EngineException

EngineException(String, Object) - Constructor for exception org.eclipse.birt.report.engine.api.EngineException

EngineException(String, Object, Throwable) - Constructor for exception org.eclipse.birt.report.engine.api.EngineException

EngineException(String, Object[]) - Constructor for exception org.eclipse.birt.report.engine.api.EngineException

EngineException(String, Object[], Throwable) - Constructor for exception org.eclipse.birt.report.engine.api.EngineException

EngineException(String) - Constructor for exception org.eclipse.birt.report.engine.api.EngineException

EngineException(String, Throwable) - Constructor for exception org.eclipse.birt.report.engine.api.EngineException

ENLARGE_PAGE_SIZE - Static variable in interface org.eclipse.birt.report.engine.api.IPDFRenderOption

equals(Object) - Method in class org.eclipse.birt.report.engine.api.DataID

equals(Object) - Method in class org.eclipse.birt.report.engine.api.DataSetID

evaluate(String) - Method in interface org.eclipse.birt.report.engine.extension.IBaseResultSet

evaluate(IBaseExpression) - Method in interface org.eclipse.birt.report.engine.extension.IBaseResultSet

evaluate(String) - Method in interface org.eclipse.birt.report.engine.extension.IRowSet

evaluate the expression using current row.

evaluate(IBaseExpression) - Method in interface org.eclipse.birt.report.engine.extension.IRowSet

evaluateDefaults() - Method in interface org.eclipse.birt.report.engine.api.IGetParameterDefinitionTask

Deprecated. use getDefaultParameterValues() directly.

evaluateQuery(String) - Method in interface org.eclipse.birt.report.engine.api.IGetParameterDefinitionTask

Deprecated. This api has no use.

EXCELRenderOption - Class in org.eclipse.birt.report.engine.api

EXCELRenderOption() - Constructor for class org.eclipse.birt.report.engine.api.EXCELRenderOption

EXCELRenderOption(IRenderOption) - Constructor for class org.eclipse.birt.report.engine.api.EXCELRenderOption

execute() - Method in class org.eclipse.birt.report.engine.api.ReportRunner

Check if the arguments are valid.

execute() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemExecutor

execute the report item

execute() - Method in class org.eclipse.birt.report.engine.layout.content.ItemExecutorWrapper

executeQuery(IBaseResultSet, IDataQueryDefinition) - Method in interface org.eclipse.birt.report.engine.extension.IExecutorContext

execute query

executeQuery(IBaseResultSet, IDataQueryDefinition, Object) - Method in interface org.eclipse.birt.report.engine.extension.IExecutorContext

execute query

executor - Variable in class org.eclipse.birt.report.engine.layout.content.ItemExecutorWrapper

EXTENSION - Static variable in interface org.eclipse.birt.report.engine.api.IDataExtractionOption

EXTENSION_REPORT_ENGINE_FACTORY - Static variable in interface org.eclipse.birt.report.engine.api.IReportEngineFactory

the extension point used to create the factory object.

EXTERNAL_TYPE - Static variable in interface org.eclipse.birt.report.engine.content.IForeignContent

the content is the output of a extenal item, it is byte[]

extract() - Method in interface org.eclipse.birt.report.engine.api.IDataExtractionTask

extract(IDataExtractionOption) - 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

findStyle(String) - Method in interface org.eclipse.birt.report.engine.content.IReportContent

find the named style.

findTOC(String) - Method in interface org.eclipse.birt.report.engine.api.IReportDocument

get the TOCNode have the id.

findTOC(String) - Method in interface org.eclipse.birt.report.engine.api.ITOCTree

Gets the TOCNode with the specified id.

findTOCByName(String) - Method in interface org.eclipse.birt.report.engine.api.IReportDocument

Gets the TOCNodes with the given name.

findTOCByValue(Object) - Method in interface org.eclipse.birt.report.engine.api.ITOCTree

Gets the TOCNodes with specified TOC value.

finish() - Method in class org.eclipse.birt.report.engine.api.DefaultStatusHandler

finish() - Method in interface org.eclipse.birt.report.engine.api.IStatusHandler

does cleanup work

finish() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemGeneration

Performs clean up work

finish() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation

Performs clean up work

FIT_TO_PAGE - Static variable in interface org.eclipse.birt.report.engine.api.IPDFRenderOption

Deprecated. Scale the content to fit into the page, when the content exceeds page size. This property has been deprecated, please set PAGE_OVERFLOW = FIT_TO_PAGE_SIZE instead.

FIT_TO_PAGE_SIZE - Static variable in interface org.eclipse.birt.report.engine.api.IPDFRenderOption

FONT_DIRECTORY - Static variable in interface org.eclipse.birt.report.engine.api.IPDFRenderOption

Deprecated. define the font directory used by PDF.

FONT_FAMILY - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

FONT_SIZE - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

FONT_STYLE - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

FONT_VARIANT - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

FONT_WEIGHT - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

fontDirectory - Variable in class org.eclipse.birt.report.engine.api.DOCRenderContext

user-defined font dirctory

fontDirectory - Variable in class org.eclipse.birt.report.engine.api.PDFRenderContext

Deprecated. user-defined font directory

FOREIGN_CONTENT - Static variable in interface org.eclipse.birt.report.engine.content.IContent

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

getACL() - Method in interface org.eclipse.birt.report.engine.content.IContent

getACL() - Method in interface org.eclipse.birt.report.engine.content.IReportContent

getActionHandle() - Method in interface org.eclipse.birt.report.engine.api.IRenderOption

Deprecated.

getActionHandle() - Method in class org.eclipse.birt.report.engine.api.RenderOption

Deprecated.

getActionHandler() - Method in class org.eclipse.birt.report.engine.api.DataExtractionOption

getActionHandler() - Method in interface org.eclipse.birt.report.engine.api.IDataExtractionOption

getActionHandler() - Method in interface org.eclipse.birt.report.engine.api.IRenderOption

getActionHandler() - Method in class org.eclipse.birt.report.engine.api.RenderOption

getActionHandler() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentationInfo

getActionString() - Method in interface org.eclipse.birt.report.engine.api.IAction

getAlignment() - Method in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn

getAltText() - Method in interface org.eclipse.birt.report.engine.content.IForeignContent

getAltText() - Method in interface org.eclipse.birt.report.engine.content.IImageContent

getAltTextKey() - Method in interface org.eclipse.birt.report.engine.content.IForeignContent

getAltTextKey() - Method in interface org.eclipse.birt.report.engine.content.IImageContent

getAppBaseURL() - Method in interface org.eclipse.birt.report.engine.api.IRenderOption

Returns the app base url for URL images

getAppBaseURL() - Method in class org.eclipse.birt.report.engine.api.RenderOption

Returns the app base url for URL images

getAppContext() - Method in class org.eclipse.birt.report.engine.api.EngineConfig

returns a hash map that contains appContext

getAppContext() - Method in interface org.eclipse.birt.report.engine.api.IEngineTask

returns the context objects for the task.

getApplicationClassLoader() - Method in interface org.eclipse.birt.report.engine.extension.IExecutorContext

get the class loader used to load user defined classes.

getApplicationClassLoader() - Method in interface org.eclipse.birt.report.engine.extension.IPreparationContext

getApplicationClassLoader() - Method in interface org.eclipse.birt.report.engine.extension.IReportEventContext

getApplicationClassLoader() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemGenerationInfo

getApplicationClassLoader() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentationInfo

getArchive() - Method in interface org.eclipse.birt.report.engine.api.IReportDocument

getAutoSuggestThreshold() - Method in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn

getBackgroundAttachement() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

getBackgroundAttachment() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the attachment type (either SCROLL or FIXED)

getBackgroundColor() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the background color

getBackgroundImage() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the background image URI

getBackgroundPositionX() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the X (horizontal) position of the background image

getBackgroundPositionX() - Method in interface org.eclipse.birt.report.engine.content.IStyle

getBackgroundPositionY() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the Y (vertical) position of the background image

getBackgroundPositionY() - Method in interface org.eclipse.birt.report.engine.content.IStyle

getBackgroundRepeat() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the background repeat type (valid types are REPEAT, REPEAT_X, REPEAT_Y and NO_REPEAT)

getBand() - Method in interface org.eclipse.birt.report.engine.content.IRowContent

getBandType() - Method in interface org.eclipse.birt.report.engine.content.IBandContent

Get the type of the band content.

getBaseImageURL() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderContext

Deprecated. returns the base url for creating image URL

getBaseImageURL() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

returns the base url for creating image URL

getBaseImageURL() - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

returns the base url for creating image URL

getBaseURL() - Method in class org.eclipse.birt.report.engine.api.DOCRenderContext

Returns the base URL for creating an Action URL

getBaseURL() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderContext

Deprecated. Returns the base URL for creating an Action URL

getBaseURL() - Method in interface org.eclipse.birt.report.engine.api.IRenderOption

Returns the base URL for creating an Action URL

getBaseURL() - Method in class org.eclipse.birt.report.engine.api.PDFRenderContext

Deprecated. Returns the base URL for creating an Action URL

getBaseURL() - Method in class org.eclipse.birt.report.engine.api.RenderOption

Returns the base URL for creating an Action URL

getBigDecimal(String) - Method in interface org.eclipse.birt.report.engine.extension.IQueryResultSet

Returns the value of a bound column as the BigDecimal data type.

getBlob(String) - Method in interface org.eclipse.birt.report.engine.extension.IQueryResultSet

Returns the value of a bound column as the Blob data type.

getBookmark() - Method in interface org.eclipse.birt.report.engine.api.IAction

getBookmark() - Method in class org.eclipse.birt.report.engine.api.TOCNode

getBookmark() - Method in interface org.eclipse.birt.report.engine.content.IContent

getBookmark() - Method in interface org.eclipse.birt.report.engine.content.IDrillThroughAction

Get the bookmark.

getBookmark() - Method in interface org.eclipse.birt.report.engine.content.IHyperlinkAction

getBookmarkInstance(String) - Method in interface org.eclipse.birt.report.engine.api.IReportDocument

Return the instance id of report item with the specified bookmark

getBookmarkOffset(String) - Method in interface org.eclipse.birt.report.engine.api.IReportDocument

Given a report item bookmark, returns the offset of the report content (to support Reportlet).

getBookmarks() - Method in interface org.eclipse.birt.report.engine.api.IReportDocument

getBoolean(String) - Method in interface org.eclipse.birt.report.engine.extension.IQueryResultSet

Returns the value of a bound column as the Boolean data type.

getBooleanOption(String, boolean) - Method in class org.eclipse.birt.report.engine.api.TaskOption

Get boolean option value by name.

getBorderBottomColor() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the bottom border color

getBorderBottomStyle() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the bottom border style.

getBorderBottomWidth() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the bottom border width.

getBorderLeftColor() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the left border color

getBorderLeftStyle() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the left border style.

getBorderLeftWidth() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the left border width.

getBorderRightColor() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the right border color

getBorderRightStyle() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the right border style.

getBorderRightWidth() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the right border width.

getBorderTopColor() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the top border color

getBorderTopStyle() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the top border style.

getBorderTopWidth() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the top border width.

getBytes(String) - Method in interface org.eclipse.birt.report.engine.extension.IQueryResultSet

Returns the value of a bound column as the byte[] data type.

getCachedImage(String, int, IReportContext) - Method in class org.eclipse.birt.report.engine.api.HTMLImageHandler

get the cached image.

getCachedImage(String, int, IReportContext) - Method in interface org.eclipse.birt.report.engine.api.IHTMLImageHandler

get the cached image for that id.

getCancelFlag() - Method in interface org.eclipse.birt.report.engine.api.IEngineTask

return a flag if the user called cancel.

getCanShrink() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Can this element shrink?

getCanShrink() - Method in interface org.eclipse.birt.report.engine.content.IStyle

getCaption() - Method in interface org.eclipse.birt.report.engine.content.ITableContent

getCaptionKey() - Method in interface org.eclipse.birt.report.engine.content.ITableContent

getCellID() - Method in class org.eclipse.birt.report.engine.api.DataID

Return the cell id.

getCellID() - Method in class org.eclipse.birt.report.engine.api.DataSetID

cell id in the parent data set.

getCellIndex() - Method in interface org.eclipse.birt.report.engine.extension.ICubeResultSet

getChildren(String) - Method in interface org.eclipse.birt.report.engine.api.IReportDocument

getChildren() - Method in class org.eclipse.birt.report.engine.api.TOCNode

getChildren() - Method in interface org.eclipse.birt.report.engine.content.IElement

Get the children of the element, or return null if the element is in leaf level.

getChildren() - Method in interface org.eclipse.birt.report.engine.content.INode

Get the children of the node.

getChildSelectionList() - Method in interface org.eclipse.birt.report.engine.api.ICascadingParameterSelectionChoice

getColor() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the font color

getColSpan() - Method in interface org.eclipse.birt.report.engine.content.ICellContent

getColumn() - Method in interface org.eclipse.birt.report.engine.content.ICellContent

getColumn(int) - Method in interface org.eclipse.birt.report.engine.content.ITableContent

getColumnAlias(int) - Method in interface org.eclipse.birt.report.engine.api.IResultMetaData

Returns the column alias at the specified index.

getColumnCount() - Method in interface org.eclipse.birt.report.engine.api.IResultMetaData

Returns the number of columns in a detail row of the result set.

getColumnCount() - Method in interface org.eclipse.birt.report.engine.content.ITableContent

getColumnCount() - Method in interface org.eclipse.birt.report.engine.extension.IRowMetaData

Returns the number of columns in a detail row of the result set.

getColumnInstance() - Method in interface org.eclipse.birt.report.engine.content.ICellContent

getColumnLabel(int) - Method in interface org.eclipse.birt.report.engine.api.IResultMetaData

Gets the label or display name of the column at the specified index.

getColumnName(int) - Method in interface org.eclipse.birt.report.engine.api.IResultMetaData

Returns the column name at the specified index.

getColumnName(int) - Method in interface org.eclipse.birt.report.engine.extension.IRowMetaData

Returns the column name at the specified index.

getColumns() - Method in interface org.eclipse.birt.report.engine.content.ITableContent

getColumnType(int) - Method in interface org.eclipse.birt.report.engine.api.IResultMetaData

Returns the data type of the column at the specified index.

getColumnType(int) - Method in interface org.eclipse.birt.report.engine.extension.IRowMetaData

getColumnTypeName(int) - Method in interface org.eclipse.birt.report.engine.api.IResultMetaData

Returns the Data Engine data type name of the column at the specified index.

getComponentID() - Method in class org.eclipse.birt.report.engine.api.InstanceID

returns the component id of the element

getConfig() - Method in interface org.eclipse.birt.report.engine.api.IReportEngine

Returns the engine configuration object.

getConfig() - Method in class org.eclipse.birt.report.engine.api.ReportEngine

returns the engine configuration object

getConfigMap() - Method in class org.eclipse.birt.report.engine.api.EngineConfig

Deprecated. use getProperties() instead.

getContent(InstanceID) - Method in interface org.eclipse.birt.report.engine.content.IReportContent

return the content in this report.

getContent() - Method in interface org.eclipse.birt.report.engine.extension.IOnCreateEvent

getContent() - Method in interface org.eclipse.birt.report.engine.extension.IOnRenderEvent

getContent() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemExecutor

get the content

getContent() - Method in interface org.eclipse.birt.report.engine.layout.content.IContentWrapper

getContentComputedStyle() - Method in interface org.eclipse.birt.report.engine.content.IPageContent

Deprecated. use getPageBody().getComputedStyle()

getContents() - Method in interface org.eclipse.birt.report.engine.api.IParameterGroupDefn

returns the set of parameters that appear inside the group.

getContentStyle() - Method in interface org.eclipse.birt.report.engine.content.IPageContent

Deprecated. use getPageBody().getStyle()

getContentType() - Method in interface org.eclipse.birt.report.engine.content.IContent

the content type, must be one of the predefines.

getContext() - Method in interface org.eclipse.birt.report.engine.extension.IReportEvent

getContext() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemExecutor

get executor context

getControlType() - Method in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn

getCssText(int) - Method in interface org.eclipse.birt.report.engine.content.IStyle

getCubeCursor() - Method in interface org.eclipse.birt.report.engine.extension.ICubeResultSet

getCubeQuery() - Method in interface org.eclipse.birt.report.engine.extension.ICubeResultSet

getData() - Method in interface org.eclipse.birt.report.engine.content.IImageContent

getDataExtractionExtension() - Method in class org.eclipse.birt.report.engine.api.DataExtractionFormatInfo

Get configuration element of data extraction extension.

getDataExtractionFormatInfo() - Method in interface org.eclipse.birt.report.engine.api.IReportEngine

Returns data extraction extension information.

getDataExtractionFormatInfo() - Method in class org.eclipse.birt.report.engine.api.ReportEngine

Returns data extraction extension information.

getDataID() - Method in class org.eclipse.birt.report.engine.api.InstanceID

Get data id of the element.

getDataSet() - Method in interface org.eclipse.birt.report.engine.api.ICascadingParameterGroup

getDataSetID() - Method in class org.eclipse.birt.report.engine.api.DataID

return the data set.

getDataSetName() - Method in class org.eclipse.birt.report.engine.api.DataSetID

data set name if any.

getDataType() - Method in interface org.eclipse.birt.report.engine.api.IDataAction

the output data type, such as csv, xml.

getDataType() - Method in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn

returns the parameter data type.

getDate(String) - Method in interface org.eclipse.birt.report.engine.extension.IQueryResultSet

Returns the value of a bound column as the Date data type.

getDateFormat() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the date format

getDateFormat() - Method in interface org.eclipse.birt.report.engine.content.IStyle

getDateTimeFormat() - Method in interface org.eclipse.birt.report.engine.content.IStyle

getDefaultValue(IParameterDefnBase) - Method in interface org.eclipse.birt.report.engine.api.IGetParameterDefinitionTask

get default value by parameter name

getDefaultValue(String) - Method in interface org.eclipse.birt.report.engine.api.IGetParameterDefinitionTask

get the default value of parameter.

getDefaultValue() - Method in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn

getDefaultValues() - Method in interface org.eclipse.birt.report.engine.api.IGetParameterDefinitionTask

get all default values

getDefualtEmitter(String) - Method in class org.eclipse.birt.report.engine.api.EngineConfig

Gets default emitter id of an output format.

getDesign() - Method in interface org.eclipse.birt.report.engine.content.IReportContent

get the report design used to create this report content.

getDesignHandle() - Method in interface org.eclipse.birt.report.engine.api.IReportRunnable

returns the design element handle that design engine creates when opening the report

getDesignInstance() - Method in interface org.eclipse.birt.report.engine.api.IReportRunnable

Returns the report design

getDesignStream() - Method in interface org.eclipse.birt.report.engine.api.IReportDocument

getDirection() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

getDisplay() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the display type (valid types are BLOCK, INLINE and NONE)

getDisplayFilterIcon() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

getDisplayFilterIcon() - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

getDisplayFormat() - Method in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn

getDisplayGroupIcon() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

getDisplayGroupIcon() - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

getDisplayGroupIcon() - Method in interface org.eclipse.birt.report.engine.content.ICellContent

getDisplayName() - Method in interface org.eclipse.birt.report.engine.api.IParameterDefnBase

returns the locale-specific display name for the parameter.

getDisplayString() - Method in class org.eclipse.birt.report.engine.api.TOCNode

getDouble(String) - Method in interface org.eclipse.birt.report.engine.extension.IQueryResultSet

Returns the value of a bound column as the Double data type.

getDrillThrough() - Method in interface org.eclipse.birt.report.engine.content.IHyperlinkAction

getElementID() - Method in exception org.eclipse.birt.report.engine.api.EngineException

Get element id.

getEmbeddable() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

getEmbeddable() - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

getEmitter() - Method in class org.eclipse.birt.report.engine.api.EmitterInfo

Get the emitter instance of the emitter.

getEmitterConfig() - Method in interface org.eclipse.birt.report.engine.emitter.IEmitterServices

TODO: review, return IEmitterConfig, by format.

getEmitterConfigs() - Method in class org.eclipse.birt.report.engine.api.EngineConfig

gets a map for emitter configuration objects

getEmitterID() - Method in interface org.eclipse.birt.report.engine.api.IRenderOption

returns the emitter id

getEmitterID() - Method in class org.eclipse.birt.report.engine.api.RenderOption

Get emitter id.

getEmitterInfo() - Method in interface org.eclipse.birt.report.engine.api.IReportEngine

Return all the emitter information which BIRT Engine can load.

getEmitterInfo() - Method in class org.eclipse.birt.report.engine.api.ReportEngine

Return all the emitter information which BIRT Engine can load.

getEnableAgentStyleEngine() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

getEnableMetadata() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

getEnableMetadata() - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

getEndingGroupLevel() - Method in interface org.eclipse.birt.report.engine.extension.IQueryResultSet

Returns the 1-based index of the outermost group in which the current row is the first row.

getEndingGroupLevel() - Method in interface org.eclipse.birt.report.engine.extension.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

getErrorCode() - Method in exception org.eclipse.birt.report.engine.api.EngineException

getErrors() - Method in interface org.eclipse.birt.report.engine.api.IEngineTask

Gets all exceptions that are thrown out during executing this task.

getErrors() - Method in interface org.eclipse.birt.report.engine.api.IReportDocumentInfo

getErrors() - Method in interface org.eclipse.birt.report.engine.content.IReportContent

get the error list which occurs in the generation.

getEventType() - Method in interface org.eclipse.birt.report.engine.extension.IReportEvent

getExecutor() - Method in interface org.eclipse.birt.report.engine.layout.content.IContentWrapper

getExtendedItemContent() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemGenerationInfo

getExtendedItemContent() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentationInfo

getExtension() - Method in class org.eclipse.birt.report.engine.api.DataExtractionOption

Get extension.

getExtension() - Method in interface org.eclipse.birt.report.engine.api.IDataExtractionOption

Get extension.

getExtension() - Method in interface org.eclipse.birt.report.engine.api.IImage

return the image postfix, such as jpg, png

getExtension(int) - Method in interface org.eclipse.birt.report.engine.content.IContent

getExtension() - Method in interface org.eclipse.birt.report.engine.content.IImageContent

getFileExtension() - Method in class org.eclipse.birt.report.engine.api.EmitterInfo

get the file extension of this emitter's output, "." not included

getFontDirectory() - Method in class org.eclipse.birt.report.engine.api.DOCRenderContext

getFontDirectory() - Method in interface org.eclipse.birt.report.engine.api.IPDFRenderOption

Deprecated.

getFontDirectory() - Method in class org.eclipse.birt.report.engine.api.PDFRenderContext

Deprecated.

getFontDirectory() - Method in class org.eclipse.birt.report.engine.api.PDFRenderOption

Deprecated.

getFontFamily() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the font family

getFontSize() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the font size

getFontStyle() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the font style

getFontVariant() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the font variant

getFontWeight() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the font weight

getFooter() - Method in interface org.eclipse.birt.report.engine.content.IGroupContent

Get the footer of the group.

getFooter() - Method in interface org.eclipse.birt.report.engine.content.IPageContent

getFooter() - Method in interface org.eclipse.birt.report.engine.content.ITableContent

get the footer band,return NULL if the table has no footer.

getFooterHeight() - Method in interface org.eclipse.birt.report.engine.content.IPageContent

getFormat() - Method in class org.eclipse.birt.report.engine.api.DataExtractionFormatInfo

Get extraction format of the output file.

getFormat() - Method in class org.eclipse.birt.report.engine.api.EmitterInfo

Get the format of the emitter.

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.IDrillThroughAction

Get the format of the target report if the action type is drillthrough.

getFormat() - Method in interface org.eclipse.birt.report.engine.content.IHyperlinkAction

getGenerateBy() - Method in interface org.eclipse.birt.report.engine.content.IColumn

getGenerateBy() - Method in interface org.eclipse.birt.report.engine.content.IContent

the design object which create this content.

getGenerationConfig() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemGeneration

getGlobalVariables(String) - Method in interface org.eclipse.birt.report.engine.api.IReportDocument

getGroup() - Method in interface org.eclipse.birt.report.engine.content.IRowContent

getGroupID() - Method in interface org.eclipse.birt.report.engine.content.IBandContent

Get the group id if the band content is in some group.

getGroupID() - Method in interface org.eclipse.birt.report.engine.content.IGroupContent

Get the unique id of the group.

getGroupId() - Method in interface org.eclipse.birt.report.engine.content.IRowContent

getGroupId(int) - Method in interface org.eclipse.birt.report.engine.extension.IQueryResultSet

getGroupLevel() - Method in interface org.eclipse.birt.report.engine.content.IGroupContent

Get the level of the group.

getHandle() - Method in interface org.eclipse.birt.report.engine.api.IParameterDefnBase

returns the report element handle which is wrapped by this object.

getHandle() - Method in interface org.eclipse.birt.report.engine.extension.IReportEvent

getHeader() - Method in interface org.eclipse.birt.report.engine.content.IGroupContent

Get the header of the group.

getHeader() - Method in interface org.eclipse.birt.report.engine.content.IListContent

Get the header of the list.

getHeader() - Method in interface org.eclipse.birt.report.engine.content.IPageContent

getHeader() - Method in interface org.eclipse.birt.report.engine.content.ITableContent

get the header band.

getHeaderHeight() - Method in interface org.eclipse.birt.report.engine.content.IPageContent

getHeight() - Method in class org.eclipse.birt.report.engine.api.ImageSize

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

Get the help key of the data content.

getHelpKey() - Method in interface org.eclipse.birt.report.engine.content.IImageContent

getHelpKey() - Method in interface org.eclipse.birt.report.engine.content.ILabelContent

Get the help key string of the label content.

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

Get the help text of the data content.

getHelpText() - Method in interface org.eclipse.birt.report.engine.content.ILabelContent

Get the help text string of the label content.

getHTMLIDNamespace() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

getHtmlPagination() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

Get html pagination.

getHtmlPagination() - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

Get Html pagination.

getHtmlRtLFlag() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

Get Html RTL flag.

getHtmlRtLFlag() - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

Get Html RTL flag.

getHtmlTitle() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

getHtmlTitle() - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

getHyperlink() - Method in interface org.eclipse.birt.report.engine.content.IHyperlinkAction

getHyperlinkAction() - Method in interface org.eclipse.birt.report.engine.content.IContent

getIcon() - Method in class org.eclipse.birt.report.engine.api.EmitterInfo

Get the icon of the emitter.

getID() - Method in class org.eclipse.birt.report.engine.api.CachedImage

get the id of the image.

getID() - Method in class org.eclipse.birt.report.engine.api.ComponentID

Get an identifier for a report component.

getId() - Method in class org.eclipse.birt.report.engine.api.DataExtractionFormatInfo

Get data extraction extension id.

getID() - Method in class org.eclipse.birt.report.engine.api.EmitterInfo

Get the id of the emitter.

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

getID() - Method in interface org.eclipse.birt.report.engine.extension.IBaseResultSet

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

Deprecated. returns the image directory that engine stores images and charts into

getImageDirectory() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

returns the image directory that engine stores images and charts into

getImageDirectory() - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

returns the image directory that engine stores images and charts into

getImageHandle() - Method in interface org.eclipse.birt.report.engine.api.IRenderOption

Deprecated.

getImageHandle() - Method in class org.eclipse.birt.report.engine.api.RenderOption

Deprecated.

getImageHandler() - Method in class org.eclipse.birt.report.engine.api.DataExtractionOption

getImageHandler() - Method in interface org.eclipse.birt.report.engine.api.IDataExtractionOption

getImageHandler() - Method in interface org.eclipse.birt.report.engine.api.IRenderOption

getImageHandler() - Method in class org.eclipse.birt.report.engine.api.RenderOption

getImageMap() - Method in class org.eclipse.birt.report.engine.api.CachedImage

get the image map of the image.

getImageMap() - Method in interface org.eclipse.birt.report.engine.api.IImage

The image map is used in HTML output.

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

getImageMIMEType() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation

getImageSize() - Method in class org.eclipse.birt.report.engine.api.CachedImage

get the image size

getImageSize() - Method in interface org.eclipse.birt.report.engine.api.IImage

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

getIncludeSelectionHandle() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

Deprecated. includeSelectionHandle is replaced by eanableMetadata flag.

getIncludeSelectionHandle() - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

Deprecated. includeSelectionHandle is replaced by eanableMetadata flag.

getInlineStyle() - Method in interface org.eclipse.birt.report.engine.content.IColumn

getInlineStyle() - Method in interface org.eclipse.birt.report.engine.content.IContent

getInstanceID() - Method in class org.eclipse.birt.report.engine.api.DataExtractionOption

getInstanceID() - Method in interface org.eclipse.birt.report.engine.api.IDataAction

Returns the instance ID of associated report item instance.

getInstanceID() - Method in interface org.eclipse.birt.report.engine.api.IDataExtractionOption

getInstanceID() - Method in interface org.eclipse.birt.report.engine.content.IColumn

get the instance id of the column.

getInstanceID() - Method in interface org.eclipse.birt.report.engine.content.IContent

get the instance id of the content.

getInstanceIDs() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

getInstanceIDs() - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

getInstanceOffset(InstanceID) - Method in interface org.eclipse.birt.report.engine.api.IReportDocument

Given a report item instance id, returns the offset of the report content (to support Reportlet).

getInteger(String) - Method in interface org.eclipse.birt.report.engine.extension.IQueryResultSet

Returns the value of a bound column as the Integer data type.

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

Get the label key of the data content.

getLabelKey() - Method in interface org.eclipse.birt.report.engine.content.ILabelContent

Get the label key string of the label content.

getLabelText() - Method in interface org.eclipse.birt.report.engine.content.IDataContent

Get the label text of the data content.

getLabelText() - Method in interface org.eclipse.birt.report.engine.content.ILabelContent

Get the text string of the label content.

getLayoutPreference() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

getLeftWidth() - Method in interface org.eclipse.birt.report.engine.content.IPageContent

getLetterSpacing() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the letter spacing

getLineHeight() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the line height

getLocale() - Method in interface org.eclipse.birt.report.engine.api.IEngineTask

returns the locale for running the task

getLocalizedMessage() - Method in exception org.eclipse.birt.report.engine.api.EngineException

getLogDirectory() - Method in class org.eclipse.birt.report.engine.api.EngineConfig

Get directory of the log file

getLogFile() - Method in class org.eclipse.birt.report.engine.api.EngineConfig

Get the name of the log file.

getLogger() - Method in class org.eclipse.birt.report.engine.api.EngineConfig

return the user's logger set through setLogger.

getLogger() - Method in interface org.eclipse.birt.report.engine.api.IEngineTask

return the logger used by the task.

getLogger() - Method in interface org.eclipse.birt.report.engine.api.IReportEngine

Get the logger used by report engine.

getLogger() - Method in class org.eclipse.birt.report.engine.api.ReportEngine

get the logger used by report engine

getLogLevel() - Method in class org.eclipse.birt.report.engine.api.EngineConfig

Get the level of the log file

getMarginBottom() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the bottom margin

getMarginBottom() - Method in interface org.eclipse.birt.report.engine.content.IPageContent

getMarginLeft() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the left margin

getMarginLeft() - Method in interface org.eclipse.birt.report.engine.content.IPageContent

getMarginRight() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the right margin

getMarginRight() - Method in interface org.eclipse.birt.report.engine.content.IPageContent

getMarginTop() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the top margin

getMarginTop() - Method in interface org.eclipse.birt.report.engine.content.IPageContent

getMasterPage() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the master page

getMasterPage() - Method in interface org.eclipse.birt.report.engine.content.IStyle

getMasterPageContent() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

Get master page content.

getMasterPageContent() - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

Get master page content.

getMaxLineWidth() - Method in interface org.eclipse.birt.report.engine.layout.pdf.emitter.IInlineStackingLayout

getMaxLineWidth() - Method in class org.eclipse.birt.report.engine.layout.pdf.emitter.InlineContainerLayout

getMaxLineWidth() - Method in class org.eclipse.birt.report.engine.layout.pdf.emitter.InlineStackingLayout

getMaxRowsPerQuery() - Method in class org.eclipse.birt.report.engine.api.EngineConfig

Deprecated.

getMessage() - Method in exception org.eclipse.birt.report.engine.api.EngineException

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

getMIMEType() - Method in class org.eclipse.birt.report.engine.api.CachedImage

get the mime type of the image.

getMimeType() - Method in class org.eclipse.birt.report.engine.api.DataExtractionFormatInfo

Get mime type of the output file.

getMimeType() - Method in class org.eclipse.birt.report.engine.api.EmitterInfo

Get the mimeType of the emitter.

getMimeType() - Method in interface org.eclipse.birt.report.engine.api.IImage

getMIMEType(String) - Method in interface org.eclipse.birt.report.engine.api.IReportEngine

The MIME type for the specific formatted supported by the extension.

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

getModelObject() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemExecutor

get extended report item model handle

getModelObject() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemGenerationInfo

getModelObject() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPreparationInfo

getModelObject() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentationInfo

getName() - Method in class org.eclipse.birt.report.engine.api.DataExtractionFormatInfo

Get data extraction extension name.

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.

getNamespace() - Method in class org.eclipse.birt.report.engine.api.EmitterInfo

Get the namespace of the emitter.

getNext() - Method in interface org.eclipse.birt.report.engine.content.INode

Get the sibling node immediately following the specified node.

getNextChild() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemExecutor

return the next child's executor

getNextChild() - Method in class org.eclipse.birt.report.engine.layout.content.ItemExecutorWrapper

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 class org.eclipse.birt.report.engine.api.TOCStyle

Get number format

getNumberFormat() - Method in interface org.eclipse.birt.report.engine.content.IStyle

getOfficeVersion() - Method in class org.eclipse.birt.report.engine.api.EXCELRenderOption

Get office version.

getOfficeVersion() - Method in interface org.eclipse.birt.report.engine.api.IExcelRenderOption

getOption(String) - Method in interface org.eclipse.birt.report.engine.api.ITaskOption

get the option value defined by the name.

getOption(String) - Method in class org.eclipse.birt.report.engine.api.TaskOption

get option value for one rendering option

getOption(String) - Method in interface org.eclipse.birt.report.engine.emitter.IEmitterServices

getOptions() - Method in interface org.eclipse.birt.report.engine.api.ITaskOption

get all the options defined in this object

getOptions() - Method in class org.eclipse.birt.report.engine.api.TaskOption

Get options.

getOrientation() - Method in interface org.eclipse.birt.report.engine.content.IPageContent

getOutputDisplayNone() - Method in class org.eclipse.birt.report.engine.api.EmitterInfo

Get the outputDisplayNone of the emitter.

getOutputFile() - Method in class org.eclipse.birt.report.engine.api.DataExtractionOption

Get output file name.

getOutputFile() - Method in interface org.eclipse.birt.report.engine.api.IDataExtractionOption

Get output file name.

getOutputFileName() - Method in interface org.eclipse.birt.report.engine.api.IRenderOption

Get name of the output file.

getOutputFileName() - Method in class org.eclipse.birt.report.engine.api.RenderOption

Get name of the output file.

getOutputFormat() - Method in class org.eclipse.birt.report.engine.api.DataExtractionOption

Get output format.

getOutputFormat() - Method in interface org.eclipse.birt.report.engine.api.IDataExtractionOption

Get output format.

getOutputFormat() - Method in interface org.eclipse.birt.report.engine.api.IRenderOption

Get output format.

getOutputFormat() - Method in class org.eclipse.birt.report.engine.api.RenderOption

returns the output format, i.e., html, pdf, etc.

getOutputFormat() - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter

getOutputFormat() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentationInfo

getOutputMasterPageMargins() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

getOutputSetting() - Method in interface org.eclipse.birt.report.engine.api.IRenderOption

Deprecated. use getOptions instead

getOutputSetting() - Method in class org.eclipse.birt.report.engine.api.RenderOption

Deprecated. user should always use the get/set to change the setting.

getOutputStream() - Method in class org.eclipse.birt.report.engine.api.DataExtractionOption

Get output stream.

getOutputStream() - Method in interface org.eclipse.birt.report.engine.api.IDataExtractionOption

Get output stream.

getOutputStream() - Method in interface org.eclipse.birt.report.engine.api.IRenderOption

Get output stream.

getOutputStream() - Method in class org.eclipse.birt.report.engine.api.RenderOption

Get output stream

getOutputType() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation

returns the output type, which could be IMAGE, TEXT, HTML TEXT, DRAWING, etc.

getPaddingBottom() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the bottom padding.

getPaddingLeft() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the left padding.

getPaddingRight() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the right padding.

getPaddingTop() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the top padding.

getPageBody() - Method in interface org.eclipse.birt.report.engine.content.IPageContent

getPageBreakAfter() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the page break after.

getPageBreakBefore() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the page break before.

getPageBreakInside() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the page break inside.

getPageContent(long) - Method in interface org.eclipse.birt.report.engine.content.IReportContent

The page content in the report content.

getPageCount() - Method in interface org.eclipse.birt.report.engine.api.IRenderTask

Gets count of the pages that is output.

getPageCount() - Method in interface org.eclipse.birt.report.engine.api.IReportDocument

getPageFooter() - Method in interface org.eclipse.birt.report.engine.content.IPageContent

getPageFooterFloatFlag() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

Get page footer float flag.

getPageFooterFloatFlag() - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

Get page footer float flag.

getPageHeader() - Method in interface org.eclipse.birt.report.engine.content.IPageContent

getPageHeight() - Method in interface org.eclipse.birt.report.engine.content.IPageContent

getPageNumber(String) - Method in interface org.eclipse.birt.report.engine.api.IRenderTask

Given a bookmark in a report, find the (first) page that the bookmark appears in (for hyperlinks to a bookmark)

getPageNumber(InstanceID) - Method in interface org.eclipse.birt.report.engine.api.IReportDocument

Given a report item instance idD, returns the page number that the instance starts on (to support Reportlet).

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

getPagination() - Method in class org.eclipse.birt.report.engine.api.EmitterInfo

Get the pagination of the emitter.

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.IDrillThroughAction

Get a set of name/value pairs for running the target report in a drillthrough link.

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

getParameterDisplayText(String) - Method in interface org.eclipse.birt.report.engine.api.IEngineTask

Gets parameter display text by parameter name.

getParameterDisplayTexts() - Method in interface org.eclipse.birt.report.engine.api.IReportDocument

returns display texts 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.

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.

getParent() - Method in class org.eclipse.birt.report.engine.api.TOCNode

getParent() - Method in interface org.eclipse.birt.report.engine.content.IElement

Get the parent of the element object, or return null if the element is in top level.

getParent() - Method in interface org.eclipse.birt.report.engine.content.INode

Get the parent of the node, or return null if the node is in tree top level.

getParent() - Method in interface org.eclipse.birt.report.engine.extension.IBaseResultSet

getParent() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemExecutor

get parent report item executor

getParentID() - Method in class org.eclipse.birt.report.engine.api.DataSetID

parent data set if any.

getParentID() - Method in class org.eclipse.birt.report.engine.api.InstanceID

Get parent id of this report element instance.

getPluginId() - Method in exception org.eclipse.birt.report.engine.api.EngineException

getPreparationContext() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPreparationInfo

getPreparedRunnable() - Method in interface org.eclipse.birt.report.engine.api.IReportDocument

The report runnable is used to create the report document while writing.

getPresentationConfig() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation

getPrevious() - Method in interface org.eclipse.birt.report.engine.content.INode

Get the sibling node immediately preceding the specified node.

getPromptText() - Method in interface org.eclipse.birt.report.engine.api.IParameterDefnBase

getProperties() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get property.

getProperty(String) - Method in interface org.eclipse.birt.report.engine.api.IReportDocument

Get report document property.

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

getQueries(Object) - Method in interface org.eclipse.birt.report.engine.extension.IExecutorContext

get the queries of the handle

getQueryName() - Method in class org.eclipse.birt.report.engine.api.DataSetID

query name if any.

getQueryResults() - Method in interface org.eclipse.birt.report.engine.api.IDataIterator

Returns IExtractionResults from which this data iterator is obtained.

getQueryResults() - Method in interface org.eclipse.birt.report.engine.extension.IBaseResultSet

getQueryResults() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemExecutor

get QueryResults of the executor

getRawID() - Method in interface org.eclipse.birt.report.engine.extension.IBaseResultSet

return the Raw ID

getRawKey() - Method in interface org.eclipse.birt.report.engine.content.IForeignContent

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(IReportContext) - Method in class org.eclipse.birt.report.engine.api.HTMLActionHandler

Get render context.

getRenderContext(IReportContext) - Method in class org.eclipse.birt.report.engine.api.HTMLImageHandler

Get render context.

getRenderContext() - Method in interface org.eclipse.birt.report.engine.emitter.IEmitterServices

Deprecated. the user should use getReportContext().getRenderContext() to get the render options.

getRenderOption() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderContext

Deprecated.

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

return the report which contains/create this content.

getReportContent() - Method in interface org.eclipse.birt.report.engine.extension.IExecutorContext

return IReportContent.

getReportContext() - Method in interface org.eclipse.birt.report.engine.emitter.IEmitterServices

getReportContext() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemGenerationInfo

getReportContext() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentationInfo

getReportDesign() - Method in interface org.eclipse.birt.report.engine.api.IReportDocument

getReportDocumentLockManager() - Method in class org.eclipse.birt.report.engine.api.EngineConfig

return a lock manager.

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.IDrillThroughAction

Get the target report name if the action type is drillthrough which is predefined.

getReportName() - Method in interface org.eclipse.birt.report.engine.content.IHyperlinkAction

getReportName() - Method in interface org.eclipse.birt.report.engine.emitter.IEmitterServices

getReportQueries() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemGenerationInfo

getReportQueries() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentationInfo

getReportQueries(IBaseQueryDefinition) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemQuery

Deprecated. since 2.2

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

getResolution() - Method in interface org.eclipse.birt.report.engine.content.IImageContent

getResolution() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentationInfo

getResourceBundle(ULocale) - Static method in exception org.eclipse.birt.report.engine.api.EngineException

Get resource bundle.

getResourceLocator() - Method in class org.eclipse.birt.report.engine.api.EngineConfig

getResourcePath() - Method in class org.eclipse.birt.report.engine.api.EngineConfig

getResultIterator() - Method in interface org.eclipse.birt.report.engine.api.IDataIterator

return the IResultIterator directly

getResultIterator() - Method in interface org.eclipse.birt.report.engine.extension.IQueryResultSet

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.

getResultMetaData() - Method in interface org.eclipse.birt.report.engine.api.IResultSetItem

return the result meta data.

getResultMetaData() - Method in interface org.eclipse.birt.report.engine.extension.IQueryResultSet

Returns the metadata of this result set's detail row.

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.

getResultSetName() - Method in interface org.eclipse.birt.report.engine.api.IResultSetItem

return the result set name.

getRightWidth() - Method in interface org.eclipse.birt.report.engine.content.IPageContent

getRoot() - Method in interface org.eclipse.birt.report.engine.api.ITOCTree

Gets a TOC tree with specified format and locale.

getRoot() - Method in interface org.eclipse.birt.report.engine.content.IReportContent

return root content

getRootScope() - Method in interface org.eclipse.birt.report.engine.api.IReportEngine

Get the root scope used by the engine.

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

Return the row id.

getRowID() - Method in class org.eclipse.birt.report.engine.api.DataSetID

row id in the parent data set.

getRowID() - Method in interface org.eclipse.birt.report.engine.content.IRowContent

getRowIndex() - Method in interface org.eclipse.birt.report.engine.extension.IQueryResultSet

getRowSpan() - Method in interface org.eclipse.birt.report.engine.content.ICellContent

getScalarParameterType() - Method in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn

getScriptObjects() - Method in class org.eclipse.birt.report.engine.api.EngineConfig

Deprecated. use getAppContext() instead.

getSearchCriteria() - Method in interface org.eclipse.birt.report.engine.api.IAction

getSearchCriteria() - Method in interface org.eclipse.birt.report.engine.content.IDrillThroughAction

Get a set of name/value pairs for searching the target report in a drillthrough link.

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

getSelectionTreeForCascadingGroup(String) - Method in interface org.eclipse.birt.report.engine.api.IGetParameterDefinitionTask

Gets selection tree for a cascading parameter group.

getServletContext() - Method in class org.eclipse.birt.report.engine.api.EngineConfig

Deprecated. use getPlatformContext instead

getSeverity() - Method in exception org.eclipse.birt.report.engine.api.EngineException

getShowIfBlank() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Show if blank?

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.IQueryResultSet

Returns the 1-based index of the outermost group in which the current row is the last row.

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.

getStatus() - Method in interface org.eclipse.birt.report.engine.api.IEngineTask

get the status of task

getStatusHandler() - Method in class org.eclipse.birt.report.engine.api.EngineConfig

returns the status handler

getString(String) - Method in interface org.eclipse.birt.report.engine.extension.IQueryResultSet

Returns the value of a bound column as the String data type.

getStringFormat() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the string format

getStringFormat() - Method in interface org.eclipse.birt.report.engine.content.IStyle

getStringOption(String) - Method in class org.eclipse.birt.report.engine.api.TaskOption

Get option value by name.

getStyle() - Method in interface org.eclipse.birt.report.engine.content.IColumn

getStyleClass() - Method in interface org.eclipse.birt.report.engine.content.IColumn

getStyleClass() - Method in interface org.eclipse.birt.report.engine.content.IContent

getSummary() - Method in interface org.eclipse.birt.report.engine.content.ITableContent

getSupportedFormats() - Method in interface org.eclipse.birt.report.engine.api.IReportEngine

Returns all supported output formats through BIRT engine emitter extensions.

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.DOCRenderContext

getSupportedImageFormats() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderContext

Deprecated.

getSupportedImageFormats() - Method in interface org.eclipse.birt.report.engine.api.IRenderOption

getSupportedImageFormats() - Method in class org.eclipse.birt.report.engine.api.PDFRenderContext

Deprecated.

getSupportedImageFormats() - Method in class org.eclipse.birt.report.engine.api.RenderOption

getSupportedImageFormats() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentationInfo

getSystemId() - Method in interface org.eclipse.birt.report.engine.api.IAction

getTable() - Method in interface org.eclipse.birt.report.engine.content.IRowContent

getTargetFileType() - Method in interface org.eclipse.birt.report.engine.api.IAction

getTargetFileType() - Method in interface org.eclipse.birt.report.engine.content.IDrillThroughAction

Get the type of the target file.

getTargetWindow() - Method in interface org.eclipse.birt.report.engine.api.IAction

getTargetWindow() - Method in interface org.eclipse.birt.report.engine.content.IDrillThroughAction

Get the target window.

getTargetWindow() - Method in interface org.eclipse.birt.report.engine.content.IHyperlinkAction

getTaskType() - Method in interface org.eclipse.birt.report.engine.api.IEngineTask

Gets the type of the engine.

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

Get the string value of the Text Content.

getTextAlign() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the text alignment.

getTextIndent() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the text indent

getTextLineThrough() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the text line through

getTextLineThrough() - Method in interface org.eclipse.birt.report.engine.content.IStyle

getTextOverline() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the text overline

getTextOverline() - Method in interface org.eclipse.birt.report.engine.content.IStyle

getTextTransform() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the text transform.

getTextUnderline() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the text underline

getTextUnderline() - Method in interface org.eclipse.birt.report.engine.content.IStyle

getTimeFormat() - Method in interface org.eclipse.birt.report.engine.content.IStyle

getTOC() - Method in interface org.eclipse.birt.report.engine.content.IContent

getTOC() - Method in interface org.eclipse.birt.report.engine.content.IReportContent

Deprecated. This method shoule be substituted by:
getTOCTree( format, locale ).getTOCTree( );

getTOCStyle() - Method in class org.eclipse.birt.report.engine.api.TOCNode

Get toc style.

getTOCTree() - Method in interface org.eclipse.birt.report.engine.api.IRenderTask

Get the TOC tree

getTOCTree(String, ULocale) - Method in interface org.eclipse.birt.report.engine.api.IReportDocument

Get the TOC tree

getTOCTree(String, ULocale, TimeZone) - Method in interface org.eclipse.birt.report.engine.api.IReportDocument

Get the TOC tree

getTOCTree(String, ULocale) - Method in interface org.eclipse.birt.report.engine.content.IReportContent

Gets the toc tree of this report content.

getTooltip() - Method in interface org.eclipse.birt.report.engine.api.IAction

getTooltip() - Method in interface org.eclipse.birt.report.engine.content.IHyperlinkAction

getTotalPage() - Method in interface org.eclipse.birt.report.engine.api.IRenderTask

getTotalPage() - Method in interface org.eclipse.birt.report.engine.content.IReportContent

getType() - Method in interface org.eclipse.birt.report.engine.api.IAction

getType() - Method in interface org.eclipse.birt.report.engine.content.IAutoTextContent

Get the type of the AutoText Content.

getType() - Method in interface org.eclipse.birt.report.engine.content.IHyperlinkAction

getType() - Method in interface org.eclipse.birt.report.engine.extension.IBaseResultSet

getTypeName() - Method in interface org.eclipse.birt.report.engine.api.IParameterDefnBase

getULocale() - Method in interface org.eclipse.birt.report.engine.api.IEngineTask

returns the locale for running the task

getUniqueID() - Method in class org.eclipse.birt.report.engine.api.InstanceID

Get unique id of this report element instance.

getUnit() - Method in class org.eclipse.birt.report.engine.api.ImageSize

getURI() - Method in interface org.eclipse.birt.report.engine.content.IImageContent

getURL() - Method in class org.eclipse.birt.report.engine.api.CachedImage

get the URL of the cached image.

getURL(IAction, IReportContext) - Method in class org.eclipse.birt.report.engine.api.HTMLActionHandler

Get URL of the action.

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.

getURL(IAction, IReportContext) - Method in interface org.eclipse.birt.report.engine.api.IHTMLActionHandler

Generates a URL based on the action definition.

getUrlEncoding() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

getUrlEncoding() - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

getUserAgent() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

getUserAgent() - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

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

Get the value of the data content.

getValue(String) - Method in interface org.eclipse.birt.report.engine.extension.IQueryResultSet

Returns the value of a bound column.

getVersion() - Method in interface org.eclipse.birt.report.engine.api.IReportDocument

Get report document version.

getVerticalAlign() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the vertical alignment.

getVisibleFormat() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get format to hide in.

getVisibleFormat() - Method in interface org.eclipse.birt.report.engine.content.IColumn

getVisibleFormat() - Method in interface org.eclipse.birt.report.engine.content.IStyle

getWaterMark() - Method in interface org.eclipse.birt.report.engine.content.IPageContent

getWhiteSpace() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the whitespace.

getWidth() - Method in class org.eclipse.birt.report.engine.api.ImageSize

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

getWordSpacing() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the word spacing

getWrappingText() - Method in class org.eclipse.birt.report.engine.api.EXCELRenderOption

Get the flag which indicates if text wrapped.

getWrappingText() - Method in interface org.eclipse.birt.report.engine.api.IExcelRenderOption

getWrapTemplateTable() - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

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

GLOBAL_VARIABLE_OPTION_ALL - Static variable in interface org.eclipse.birt.report.engine.api.IReportDocument

GLOBAL_VARIABLE_OPTION_JAVA_ONLY - Static variable in interface org.eclipse.birt.report.engine.api.IReportDocument

GLOBAL_VARIABLE_OPTION_JS_ONLY - Static variable in interface org.eclipse.birt.report.engine.api.IReportDocument

GROUP_CONTENT - Static variable in interface org.eclipse.birt.report.engine.content.IContent

H

handle(IReportEvent) - Method in interface org.eclipse.birt.report.engine.extension.IReportEventHandler

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.HTMLServerImageHandler

Handle a temporary image .

hasDataItemsInDetail() - Method in interface org.eclipse.birt.report.engine.content.IColumn

hasNextChild() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemExecutor

does the executor has child executor

hasNextChild() - Method in class org.eclipse.birt.report.engine.layout.content.ItemExecutorWrapper

hasOption(String) - Method in interface org.eclipse.birt.report.engine.api.ITaskOption

if there exits an option named by name.

hasOption(String) - Method in class org.eclipse.birt.report.engine.api.TaskOption

Check if an option is defined.

height - Variable in class org.eclipse.birt.report.engine.api.ImageSize

HELP_GUIDE - Static variable in interface org.eclipse.birt.report.engine.api.IReportRunnable

HTML - Static variable in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

Output a complete HTML

HTML_DISPLAY_FILTER_ICON - Static variable in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

Should the output display the filter icon.

HTML_DISPLAY_GROUP_ICON - Static variable in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

Should the output display the group icon.

HTML_ENABLE_AGENTSTYLE_ENGINE - Static variable in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

Should the HTML emitter output the BIRT styles directly to the report.

HTML_ENABLE_METADATA - Static variable in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

Should the output contain metadata.

HTML_ID_NAMESPACE - Static variable in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

HTML_INCLUDE_SELECTION_HANDLE - Static variable in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

Deprecated. use METADATA

HTML_LAYOUT_PREFERENCE - Static variable in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

Should the table be outed as fixed.

HTML_NOCSS - Static variable in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

Output a HTML fragement without CSS defination.

HTML_OUTPUT_MASTER_PAGE_MARGINS - Static variable in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

Should the HTML emitter output the master page's margins.

HTML_PAGINATION - Static variable in interface org.eclipse.birt.report.engine.api.IRenderOption

Should the report contains paginations The value is a Boolean object, default is Boolean.FALSE.

HTML_RTL_FLAG - Static variable in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

Should we output HTML as RtL.

HTML_TITLE - Static variable in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

Output the HTML default title.

HTML_TYPE - Static variable in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

Define the type of the html content, it can be one of: HTML or HTML_NOCSS.

HTML_TYPE - Static variable in interface org.eclipse.birt.report.engine.content.IForeignContent

the content is an string which contains HTML content

HTML_WRAP_TEMPLATE_TABLE - Static variable in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

Should the top-level template table be wrapped.

HTMLActionHandler - Class in org.eclipse.birt.report.engine.api

Defines a default action handler for HTML output format

HTMLActionHandler() - Constructor for class org.eclipse.birt.report.engine.api.HTMLActionHandler

HTMLCompleteImageHandler - Class in org.eclipse.birt.report.engine.api

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 in org.eclipse.birt.report.engine.api

Deprecated. since 2.2, use HTMLRenderOption or RenderOption directly

HTMLEmitterConfig() - Constructor for class org.eclipse.birt.report.engine.api.HTMLEmitterConfig

Deprecated.

HTMLImageHandler - Class in org.eclipse.birt.report.engine.api

HTMLImageHandler() - Constructor for class org.eclipse.birt.report.engine.api.HTMLImageHandler

HTMLRenderContext - Class in org.eclipse.birt.report.engine.api

Deprecated. set the property to RenderOption directly.

HTMLRenderContext() - Constructor for class org.eclipse.birt.report.engine.api.HTMLRenderContext

Deprecated. dummy constrictor

HTMLRenderOption - Class in org.eclipse.birt.report.engine.api

output settings for HTML output format

HTMLRenderOption(IRenderOption) - Constructor for class org.eclipse.birt.report.engine.api.HTMLRenderOption

Constructor

HTMLRenderOption(HashMap) - Constructor for class org.eclipse.birt.report.engine.api.HTMLRenderOption

HTMLRenderOption() - Constructor for class org.eclipse.birt.report.engine.api.HTMLRenderOption

Default constructor.

HTMLServerImageHandler - Class in org.eclipse.birt.report.engine.api

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

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 in org.eclipse.birt.report.engine.api

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

IAutoTextContent - Interface in org.eclipse.birt.report.engine.content

Provides the interfaces for the AutoText Content.

IBandContent - Interface in org.eclipse.birt.report.engine.content

Provides the interface for the Band Content.

IBaseResultSet - Interface in org.eclipse.birt.report.engine.extension

ICascadingParameterGroup - Interface in org.eclipse.birt.report.engine.api

ICascadingParameterSelectionChoice - Interface in org.eclipse.birt.report.engine.api

ICellContent - Interface in org.eclipse.birt.report.engine.content

Provides the interfaces for Cell Content

IColumn - Interface in org.eclipse.birt.report.engine.content

column definition used by table content.

IContainerContent - Interface in org.eclipse.birt.report.engine.content

Provides the interface for container content in report.

IContent - Interface in org.eclipse.birt.report.engine.content

object created by report generator.

IContentEmitter - Interface in org.eclipse.birt.report.engine.emitter

used to pass the content object to following process.

IContentVisitor - Interface in org.eclipse.birt.report.engine.content

Defines the visitor interface used mainly by a buffered emitter

IContentWrapper - Interface in org.eclipse.birt.report.engine.layout.content

ICubeResultSet - Interface in org.eclipse.birt.report.engine.extension

IDataAction - Interface in org.eclipse.birt.report.engine.api

Data Action is used to generate a URL used to reterive the data from the data base.

IDataContent - Interface in org.eclipse.birt.report.engine.content

Provides the interface for the Data Content.

IDataExtractionExtension - Interface in org.eclipse.birt.report.engine.extension

IDataExtractionOption - Interface in org.eclipse.birt.report.engine.api

IDataExtractionTask - Interface in org.eclipse.birt.report.engine.api

an engine task that extracts data from a report.

IDataIterator - Interface in org.eclipse.birt.report.engine.api

An iterator on a result set from a prepared and executed query.

IDocumentWriter - Interface in org.eclipse.birt.report.engine.api

IDrillThroughAction - Interface in org.eclipse.birt.report.engine.content

Providers interface for the action process of drill through.

IElement - Interface in org.eclipse.birt.report.engine.content

Provides the interface of the element of the report.

IEmitterServices - Interface in org.eclipse.birt.report.engine.emitter

Defines interface to supply emitters with necessary information

IEngineConfig - Interface in org.eclipse.birt.report.engine.api

IEngineTask - Interface in org.eclipse.birt.report.engine.api

defines common features for an engine task.

IExcelRenderOption - Interface in org.eclipse.birt.report.engine.api

IExecutorContext - Interface in org.eclipse.birt.report.engine.extension

IExtendedItem - Interface in org.eclipse.birt.report.engine.extension

IExtendedItemFactory - Interface in org.eclipse.birt.report.engine.extension

IExtractionResults - Interface in org.eclipse.birt.report.engine.api

A handle used to retrieve data stored in a report.

IForeignContent - Interface in org.eclipse.birt.report.engine.content

The content of foreign object is not handle by report engine.

IGetParameterDefinitionTask - Interface in org.eclipse.birt.report.engine.api

an engine task that retrieves parameter definitions from a report.

IGroupContent - Interface in org.eclipse.birt.report.engine.content

Provides interfaces for Group Content.

IHTMLActionHandler - Interface in org.eclipse.birt.report.engine.api

Defines an interface for action handler used in HTML format

IHTMLImageHandler - Interface in org.eclipse.birt.report.engine.api

Defines the image handler interface for use in HTML format

IHTMLRenderOption - Interface in org.eclipse.birt.report.engine.api

Interface of constants of the HTML Render Opitons.

IHyperlinkAction - Interface in org.eclipse.birt.report.engine.content

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 in org.eclipse.birt.report.engine.api

Defines an interface to communicate info about an image to image handler

IImageContent - Interface in org.eclipse.birt.report.engine.content

Image content in the report.

IInlineStackingLayout - Interface in org.eclipse.birt.report.engine.layout.pdf.emitter

ILabelContent - Interface in org.eclipse.birt.report.engine.content

Provides the interface for the Label Content.

IListBandContent - Interface in org.eclipse.birt.report.engine.content

Provides the interface for the Band Content in List.

IListContent - Interface in org.eclipse.birt.report.engine.content

Provides interfaces for List Content.

IListGroupContent - Interface in org.eclipse.birt.report.engine.content

Provide the interfaces for the List Group Content.

IMAGE_CACHE_SIZE - Static variable in class org.eclipse.birt.report.engine.api.HTMLCompleteImageHandler

IMAGE_CACHE_SIZE - Static variable in class org.eclipse.birt.report.engine.api.HTMLServerImageHandler

IMAGE_CONTENT - Static variable in interface org.eclipse.birt.report.engine.content.IContent

IMAGE_DIRECTROY - Static variable in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

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 interface org.eclipse.birt.report.engine.api.IDataExtractionOption

IMAGE_HANDLER - Static variable in interface org.eclipse.birt.report.engine.api.IRenderOption

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

Deprecated. replaced by IMAGE_URL

IMAGE_URL - Static variable in interface org.eclipse.birt.report.engine.content.IImageContent

imageDirectory - Variable in class org.eclipse.birt.report.engine.api.HTMLRenderContext

Deprecated. directory to store image

ImageLayout - Class in org.eclipse.birt.report.engine.layout.pdf.emitter

ImageLayout(LayoutEngineContext, ContainerLayout, IContent) - Constructor for class org.eclipse.birt.report.engine.layout.pdf.emitter.ImageLayout

ImageSize - Class in org.eclipse.birt.report.engine.api

ImageSize(String, float, float) - Constructor for class org.eclipse.birt.report.engine.api.ImageSize

init(IReportItemGenerationInfo) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemGeneration

init(IReportItemPreparationInfo) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPreparation

init(IReportItemPresentationInfo) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation

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

initialize() - Method in class org.eclipse.birt.report.engine.layout.pdf.emitter.ImageLayout

initialize() - Method in class org.eclipse.birt.report.engine.layout.pdf.emitter.InlineBlockLayout

initialize() - Method in class org.eclipse.birt.report.engine.layout.pdf.emitter.InlineContainerLayout

initialize() - Method in class org.eclipse.birt.report.engine.layout.pdf.emitter.InlineStackingLayout

initilize(IReportContext, IDataExtractionOption) - Method in interface org.eclipse.birt.report.engine.extension.IDataExtractionExtension

InlineBlockLayout - Class in org.eclipse.birt.report.engine.layout.pdf.emitter

InlineBlockLayout(LayoutEngineContext, ContainerLayout, IContent) - Constructor for class org.eclipse.birt.report.engine.layout.pdf.emitter.InlineBlockLayout

InlineContainerLayout - Class in org.eclipse.birt.report.engine.layout.pdf.emitter

InlineContainerLayout(LayoutEngineContext, ContainerLayout, IContent) - Constructor for class org.eclipse.birt.report.engine.layout.pdf.emitter.InlineContainerLayout

InlineStackingLayout - Class in org.eclipse.birt.report.engine.layout.pdf.emitter

InlineStackingLayout(LayoutEngineContext, ContainerLayout, IContent) - Constructor for class org.eclipse.birt.report.engine.layout.pdf.emitter.InlineStackingLayout

InlineTextLayout - Class in org.eclipse.birt.report.engine.layout.pdf.emitter

InlineTextLayout(LayoutEngineContext, ContainerLayout, IContent) - Constructor for class org.eclipse.birt.report.engine.layout.pdf.emitter.InlineTextLayout

INode - Interface in org.eclipse.birt.report.engine.content

Tree interface.

INSTANCE_ID - Static variable in interface org.eclipse.birt.report.engine.api.IDataExtractionOption

INSTANCE_ID_LIST - Static variable in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

The list used to contain the active object ids.

InstanceID - Class in org.eclipse.birt.report.engine.api

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

Constructor.

InstanceID(InstanceID, InstanceID) - Constructor for class org.eclipse.birt.report.engine.api.InstanceID

InstanceID(InstanceID, long, long, DataID) - Constructor for class org.eclipse.birt.report.engine.api.InstanceID

Constructor.

INVALID_IMAGE - Static variable in interface org.eclipse.birt.report.engine.api.IImage

IOnCreateEvent - Interface in org.eclipse.birt.report.engine.extension

IOnPrepareEvent - Interface in org.eclipse.birt.report.engine.extension

IOnRenderEvent - Interface in org.eclipse.birt.report.engine.extension

IPage - Interface in org.eclipse.birt.report.engine.layout.emitter

IPageContent - Interface in org.eclipse.birt.report.engine.content

Page instance.

IPageDevice - Interface in org.eclipse.birt.report.engine.layout.emitter

IPageHandler - Interface in org.eclipse.birt.report.engine.api

An interface implemented by app developer to provide handler after each page is generated in factoery.

IParameterDefn - Interface in org.eclipse.birt.report.engine.api

base interface for a BIRT report parameter

IParameterDefnBase - Interface in org.eclipse.birt.report.engine.api

Captures properties shared by all types of parameters and parameter group, i.e., name, display name, help text and custom-defined properties.

IParameterGroupDefn - Interface in org.eclipse.birt.report.engine.api

The interface for objects which visually groups report parameters.

IParameterSelectionChoice - Interface in org.eclipse.birt.report.engine.api

defines one choice in a parameter selction value list

IPDFRenderOption - Interface in org.eclipse.birt.report.engine.api

Defines render options for PDF emitter.

IPreparationContext - Interface in org.eclipse.birt.report.engine.extension

IQueryContext - Interface in org.eclipse.birt.report.engine.extension

IQueryResultSet - Interface in org.eclipse.birt.report.engine.extension

IRenderOption - Interface in org.eclipse.birt.report.engine.api

Defines render options for emitters

IRenderTask - Interface in org.eclipse.birt.report.engine.api

An engine task that renders a Report Document to one of the output formats supported by the engine.

IReportContent - Interface in org.eclipse.birt.report.engine.content

The object represents the report content as a whole.

IReportDocument - Interface in org.eclipse.birt.report.engine.api

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.

IReportDocumentInfo - Interface in org.eclipse.birt.report.engine.api

the interface used to access the traisent informations of a report document.

IReportDocumentLock - Interface in org.eclipse.birt.report.engine.api

lock used to lock the report document.

IReportDocumentLockManager - Interface in org.eclipse.birt.report.engine.api

IReportEngine - Interface in org.eclipse.birt.report.engine.api

A report engine provides an entry point for reporting functionalities.

IReportEngineFactory - Interface in org.eclipse.birt.report.engine.api

a factory used to create the Report Engine.

IReportEvent - Interface in org.eclipse.birt.report.engine.extension

IReportEventContext - Interface in org.eclipse.birt.report.engine.extension

IReportEventHandler - Interface in org.eclipse.birt.report.engine.extension

IReportItemExecutor - Interface in org.eclipse.birt.report.engine.extension

IReportItemGeneration - Interface in org.eclipse.birt.report.engine.extension

Represents the extended item generation extension, which processes the report item at report geenration time.

IReportItemGenerationInfo - Interface in org.eclipse.birt.report.engine.extension

IReportItemPreparation - Interface in org.eclipse.birt.report.engine.extension

IReportItemPreparation is initially designed for extended item, which handles its nested items.

IReportItemPreparationInfo - Interface in org.eclipse.birt.report.engine.extension

IReportItemPresentation - Interface in org.eclipse.birt.report.engine.extension

Represents the extended item presentation time extension.

IReportItemPresentationInfo - Interface in org.eclipse.birt.report.engine.extension

IReportItemQuery - Interface in org.eclipse.birt.report.engine.extension

Defines the extended item query extension, which handles report query preparation.

IReportPart - Interface in org.eclipse.birt.report.engine.api

Base interface that provides accessible information for a report part

IReportRunnable - Interface in org.eclipse.birt.report.engine.api

A runnable report design (i.e., not modifiable) that can be run in the BIRT engine

IResultMetaData - Interface in org.eclipse.birt.report.engine.api

Describes the metadata of a detail row in an IResultIterator.

IResultSetItem - Interface in org.eclipse.birt.report.engine.api

IRowContent - Interface in org.eclipse.birt.report.engine.content

Provides the interfaces for the Row AbstractContent

IRowMetaData - Interface in org.eclipse.birt.report.engine.extension

Defines a row that the extension might receive.

IRowSet - Interface in org.eclipse.birt.report.engine.extension

defines an interface that wraps around a row set.

IRunAndRenderTask - Interface in org.eclipse.birt.report.engine.api

an engine task that runs a report and renders it to one of the output formats supported by the engine.

IRunTask - Interface in org.eclipse.birt.report.engine.api

An engine task that runs a report and generates a report document.

IS_EMBEDDED_FONT - Static variable in interface org.eclipse.birt.report.engine.api.IPDFRenderOption

Deprecated. should the true-type font be embedded into the generated PDF file.

isBeforeFirst() - Method in interface org.eclipse.birt.report.engine.extension.IQueryResultSet

Judges if the IResultSet's cursor on before the first row.

isBookmark() - Method in interface org.eclipse.birt.report.engine.api.IAction

Return the bookmark type set in the drillthrough action.

isBookmark() - Method in interface org.eclipse.birt.report.engine.content.IDrillThroughAction

Return the bookmark type set in the drillthrough action.

isBookmark() - Method in interface org.eclipse.birt.report.engine.content.IHyperlinkAction

Deprecated. replaced by IDrillThroughAction.isBookmark(); Return the bookmark type set in the drillthrough action. The return result indicated the target element is a toc or not.

IScalarParameterDefn - Interface in org.eclipse.birt.report.engine.api

Defines a scalar parameter

isColumnHeader() - Method in interface org.eclipse.birt.report.engine.content.IColumn

isComplete() - Method in interface org.eclipse.birt.report.engine.api.IReportDocument

isComplete() - Method in interface org.eclipse.birt.report.engine.api.IReportDocumentInfo

Check if the report document is completely read.

isDirectionRTL() - Method in interface org.eclipse.birt.report.engine.content.IContent

isEmbededFont - Variable in class org.eclipse.birt.report.engine.api.DOCRenderContext

isEmbededFont() - Method in class org.eclipse.birt.report.engine.api.DOCRenderContext

isEmbededFont() - Method in interface org.eclipse.birt.report.engine.api.IPDFRenderOption

Deprecated.

isEmbededFont - Variable in class org.eclipse.birt.report.engine.api.PDFRenderContext

Deprecated.

isEmbededFont() - Method in class org.eclipse.birt.report.engine.api.PDFRenderContext

Deprecated.

isEmbededFont() - Method in class org.eclipse.birt.report.engine.api.PDFRenderOption

isEmpty() - Method in interface org.eclipse.birt.report.engine.api.IDataIterator

see whether this iterator is empty

isEmpty() - Method in interface org.eclipse.birt.report.engine.content.IStyle

isEmpty() - Method in interface org.eclipse.birt.report.engine.extension.IQueryResultSet

Judges if the IResultSet is empty or not.

isEmpty() - Method in interface org.eclipse.birt.report.engine.extension.IRowSet

Judges if the IRowSet is empty or not

isEmptyLine() - Method in interface org.eclipse.birt.report.engine.layout.pdf.emitter.IInlineStackingLayout

isEmptyLine() - Method in class org.eclipse.birt.report.engine.layout.pdf.emitter.InlineContainerLayout

isEmptyLine() - Method in class org.eclipse.birt.report.engine.layout.pdf.emitter.InlineStackingLayout

isFirst() - Method in interface org.eclipse.birt.report.engine.extension.IQueryResultSet

Judges if the IResultSet is on the first row.

isHeaderRepeat() - Method in interface org.eclipse.birt.report.engine.content.IGroupContent

Return the indication that the group header is repeated or not.

isHeaderRepeat() - Method in interface org.eclipse.birt.report.engine.content.IListContent

Return the value if the list header is repeated.

isHeaderRepeat() - Method in interface org.eclipse.birt.report.engine.content.ITableContent

isHidden() - Method in class org.eclipse.birt.report.engine.api.DataExtractionFormatInfo

Get whether format could be shown

isHidden() - Method in class org.eclipse.birt.report.engine.api.EmitterInfo

get whether format is allowed to be shown

isHidden() - Method in interface org.eclipse.birt.report.engine.api.IParameterDefn

returns whether the parameter is a hidden parameter

isRepeated() - Method in interface org.eclipse.birt.report.engine.content.IColumn

isRequired() - Method in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn

isRTL() - Method in interface org.eclipse.birt.report.engine.content.IContent

IStatusHandler - Interface in org.eclipse.birt.report.engine.api

Interface that defines several status handler callback functions.

IStyle - Interface in org.eclipse.birt.report.engine.content

Provides the interfaces for the ROM style the properties must be string as the user may change them in script.

isValueConcealed() - Method in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn

ITableBandContent - Interface in org.eclipse.birt.report.engine.content

Provides the interfaces for the Table Band Content

ITableContent - Interface in org.eclipse.birt.report.engine.content

Provides the interfaces for the Table Content

ITableGroupContent - Interface in org.eclipse.birt.report.engine.content

Provide the interfaces for the Table Group Content.

ITaskOption - Interface in org.eclipse.birt.report.engine.api

ItemExecutorWrapper - Class in org.eclipse.birt.report.engine.layout.content

ItemExecutorWrapper(IReportItemExecutor, IContent) - Constructor for class org.eclipse.birt.report.engine.layout.content.ItemExecutorWrapper

ITextContent - Interface in org.eclipse.birt.report.engine.content

Provides the interfaces for the Text Content Text content contains several paragraphs which shares the same style properties.

ITOCTree - Interface in org.eclipse.birt.report.engine.api

Represents a whole TOC tree.

L

LABEL_CONTENT - Static variable in interface org.eclipse.birt.report.engine.content.IContent

layout() - Method in class org.eclipse.birt.report.engine.layout.pdf.emitter.ImageLayout

layout() - Method in class org.eclipse.birt.report.engine.layout.pdf.emitter.InlineTextLayout

LAYOUT_EXTENSION - Static variable in interface org.eclipse.birt.report.engine.content.IContent

LAYOUT_PREFERENCE_AUTO - Static variable in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

LAYOUT_PREFERENCE_FIXED - Static variable in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

LEFT - Static variable in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn

LETTER_SPACING - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

LINE_HEIGHT - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

LIST_BAND_CONTENT - Static variable in interface org.eclipse.birt.report.engine.content.IContent

LIST_BOX - Static variable in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn

LIST_CONTENT - Static variable in interface org.eclipse.birt.report.engine.content.IContent

LIST_GROUP_CONTENT - Static variable in interface org.eclipse.birt.report.engine.content.IContent

LIST_PARAMETER - Static variable in interface org.eclipse.birt.report.engine.api.IParameterDefnBase

LOCALE - Static variable in interface org.eclipse.birt.report.engine.api.IDataExtractionOption

LOCALE - Static variable in interface org.eclipse.birt.report.engine.api.IRenderOption

locale - Variable in class org.eclipse.birt.report.engine.api.ReportRunner

the output locale, used in Run and RunAndRender modes.

lock(String) - Method in interface org.eclipse.birt.report.engine.api.IReportDocumentLockManager

try to lock a file, onece the user get the lock of the file, it should synchronize the locker to read/write the report document.

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

LOG_DESTINATION - Static variable in interface org.eclipse.birt.report.engine.api.IEngineConfig

LOG_FILE - Static variable in interface org.eclipse.birt.report.engine.api.IEngineConfig

LOG_LEVEL - Static variable in interface org.eclipse.birt.report.engine.api.IEngineConfig

logger - Static variable in class org.eclipse.birt.report.engine.api.ReportEngine

the logger

logger - Static variable in class org.eclipse.birt.report.engine.api.ReportRunner

M

main(String[]) - Static method in class org.eclipse.birt.report.engine.api.ReportRunner

Main function.

MARGIN_BOTTOM - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

MARGIN_LEFT - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

MARGIN_RIGHT - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

MARGIN_TOP - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

MASTER_PAGE - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

MASTER_PAGE_CONTENT - Static variable in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

Should the report contains page header and footer The value is a Boolean object, default is Boolean.TRUE Only effect if the HTML_Pagination is true

MAX_ROWS_PER_QUERY - Static variable in interface org.eclipse.birt.report.engine.api.IEngineConfig

The max rows per query

mode - Variable in class org.eclipse.birt.report.engine.api.ReportRunner

execution mode, one of the Run, RunAndRender and Render.

N

needCloseOutputStreamOnExit() - Method in class org.eclipse.birt.report.engine.api.RenderOption

If the output stream needs to be closed on exit.

needSerialization() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemGeneration

returns whether the extended item needs serialization of state information at generation time

newPage(int, int, Color) - Method in interface org.eclipse.birt.report.engine.layout.emitter.IPageDevice

Creates a new page with specified width and height.

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.IQueryResultSet

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

NUMBER_FORMAT - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

O

OFFICE_VERSION - Static variable in interface org.eclipse.birt.report.engine.api.IExcelRenderOption

This is the option to decide in which office version will you output the excel file

ON_CREATE_EVENT - Static variable in interface org.eclipse.birt.report.engine.extension.IReportEvent

ON_PAGEBREAK_EVENT - Static variable in interface org.eclipse.birt.report.engine.extension.IReportEvent

ON_PREPARE_EVENT - Static variable in interface org.eclipse.birt.report.engine.extension.IReportEvent

ON_RENDER_EVENT - Static variable in interface org.eclipse.birt.report.engine.extension.IReportEvent

onCustomImage(IImage, Object) - Method in class org.eclipse.birt.report.engine.api.HTMLCompleteImageHandler

Deprecated.

onCustomImage(IImage, Object) - Method in class org.eclipse.birt.report.engine.api.HTMLImageHandler

Deprecated.

onCustomImage(IImage, IReportContext) - Method in class org.eclipse.birt.report.engine.api.HTMLImageHandler

onCustomImage(IImage, Object) - Method in class org.eclipse.birt.report.engine.api.HTMLServerImageHandler

Deprecated.

onCustomImage(IImage, Object) - Method in interface org.eclipse.birt.report.engine.api.IHTMLImageHandler

Deprecated.

onCustomImage(IImage, IReportContext) - Method in interface org.eclipse.birt.report.engine.api.IHTMLImageHandler

onDesignImage(IImage, Object) - Method in class org.eclipse.birt.report.engine.api.HTMLCompleteImageHandler

Deprecated.

onDesignImage(IImage, Object) - Method in class org.eclipse.birt.report.engine.api.HTMLImageHandler

Deprecated.

onDesignImage(IImage, IReportContext) - Method in class org.eclipse.birt.report.engine.api.HTMLImageHandler

onDesignImage(IImage, Object) - Method in class org.eclipse.birt.report.engine.api.HTMLServerImageHandler

Deprecated.

onDesignImage(IImage, Object) - Method in interface org.eclipse.birt.report.engine.api.IHTMLImageHandler

Deprecated.

onDesignImage(IImage, IReportContext) - Method in interface org.eclipse.birt.report.engine.api.IHTMLImageHandler

onDocImage(IImage, Object) - Method in class org.eclipse.birt.report.engine.api.HTMLCompleteImageHandler

Deprecated.

onDocImage(IImage, Object) - Method in class org.eclipse.birt.report.engine.api.HTMLImageHandler

Deprecated.

onDocImage(IImage, IReportContext) - Method in class org.eclipse.birt.report.engine.api.HTMLImageHandler

onDocImage(IImage, Object) - Method in class org.eclipse.birt.report.engine.api.HTMLServerImageHandler

Deprecated.

onDocImage(IImage, Object) - Method in interface org.eclipse.birt.report.engine.api.IHTMLImageHandler

Deprecated.

onDocImage(IImage, IReportContext) - Method in interface org.eclipse.birt.report.engine.api.IHTMLImageHandler

onFileImage(IImage, Object) - Method in class org.eclipse.birt.report.engine.api.HTMLCompleteImageHandler

Deprecated.

onFileImage(IImage, Object) - Method in class org.eclipse.birt.report.engine.api.HTMLImageHandler

Deprecated.

onFileImage(IImage, IReportContext) - Method in class org.eclipse.birt.report.engine.api.HTMLImageHandler

onFileImage(IImage, Object) - Method in class org.eclipse.birt.report.engine.api.HTMLServerImageHandler

Deprecated.

onFileImage(IImage, Object) - Method in interface org.eclipse.birt.report.engine.api.IHTMLImageHandler

Deprecated.

onFileImage(IImage, IReportContext) - Method in interface org.eclipse.birt.report.engine.api.IHTMLImageHandler

onPage(int, boolean, IReportDocumentInfo) - Method in interface org.eclipse.birt.report.engine.api.IPageHandler

onRowSets(IRowSet[]) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemGeneration

Deprecated. since BIRT 2.3

onRowSets(IBaseResultSet[]) - 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

Deprecated. since BIRT 2.3

onRowSets(IBaseResultSet[]) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation

Process the extended item.

onURLImage(IImage, Object) - Method in class org.eclipse.birt.report.engine.api.HTMLCompleteImageHandler

Deprecated.

onURLImage(IImage, Object) - Method in class org.eclipse.birt.report.engine.api.HTMLImageHandler

Deprecated.

onURLImage(IImage, IReportContext) - Method in class org.eclipse.birt.report.engine.api.HTMLImageHandler

onURLImage(IImage, Object) - Method in class org.eclipse.birt.report.engine.api.HTMLServerImageHandler

Deprecated.

onURLImage(IImage, Object) - Method in interface org.eclipse.birt.report.engine.api.IHTMLImageHandler

Deprecated.

onURLImage(IImage, IReportContext) - Method in interface org.eclipse.birt.report.engine.api.IHTMLImageHandler

openDocumentWriter(IArchiveFile) - Method in interface org.eclipse.birt.report.engine.api.IReportEngine

creates a document writer that can write this archive file

openDocumentWriter(IArchiveFile) - Method in class org.eclipse.birt.report.engine.api.ReportEngine

creates a document writer that can write this archive file

openReportDesign(String) - Method in interface org.eclipse.birt.report.engine.api.IReportEngine

Opens a report design file and creates a report design runnable.

openReportDesign(String, IResourceLocator) - Method in interface org.eclipse.birt.report.engine.api.IReportEngine

Opens a report design file and creates a report design runnable.

openReportDesign(ReportDesignHandle) - Method in interface org.eclipse.birt.report.engine.api.IReportEngine

Opens a report designHandle and creates a report design runnable.

openReportDesign(InputStream) - Method in interface org.eclipse.birt.report.engine.api.IReportEngine

Opens a report design stream and creates a report design runnable.

openReportDesign(String, InputStream) - Method in interface org.eclipse.birt.report.engine.api.IReportEngine

Opens a report design stream and creates a report design runnable.

openReportDesign(String, InputStream, IResourceLocator) - Method in interface org.eclipse.birt.report.engine.api.IReportEngine

Opens a report design stream and creates a report design runnable.

openReportDesign(String, InputStream, Map) - Method in interface org.eclipse.birt.report.engine.api.IReportEngine

Open the report design and return the runnable.

openReportDesign(String) - Method in class org.eclipse.birt.report.engine.api.ReportEngine

opens a report design file and creates a report design runnable.

openReportDesign(ReportDesignHandle) - Method in class org.eclipse.birt.report.engine.api.ReportEngine

opens a report designHandle 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

opens a report design stream and creates a report design runnable.

openReportDesign(String, IResourceLocator) - Method in class org.eclipse.birt.report.engine.api.ReportEngine

opens a report design file and creates a report design runnable.

openReportDesign(String, InputStream, IResourceLocator) - Method in class org.eclipse.birt.report.engine.api.ReportEngine

opens a report design stream and creates a report design runnable.

openReportDesign(String, InputStream, Map) - Method in class org.eclipse.birt.report.engine.api.ReportEngine

open the report design and return the runnable

openReportDocument() - Method in interface org.eclipse.birt.report.engine.api.IReportDocumentInfo

Open a report document.

openReportDocument(String) - Method in interface org.eclipse.birt.report.engine.api.IReportEngine

Opens a report document and returns an IReportDocument object, from which further information can be retrieved.

openReportDocument(String, IResourceLocator) - Method in interface org.eclipse.birt.report.engine.api.IReportEngine

Opens a report document and returns an IReportDocument object, from which further information can be retrieved.

openReportDocument(String, String) - Method in interface org.eclipse.birt.report.engine.api.IReportEngine

Opens a report document and returns an IReportDocument object, from which further information can be retrieved.

openReportDocument(String, String, IResourceLocator) - Method in interface org.eclipse.birt.report.engine.api.IReportEngine

Opens a report document and returns an IReportDocument object, from which further information can be retrieved.

openReportDocument(String, String, Map) - Method in interface org.eclipse.birt.report.engine.api.IReportEngine

Opens a report document and returns an IReportDocument object, from which further information can be retrieved.

openReportDocument(String, IDocArchiveReader, Map) - Method in interface org.eclipse.birt.report.engine.api.IReportEngine

Opens a report document and returns an IReportDocument object, from which further information can be retrieved.

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.

openReportDocument(String, 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.

openReportDocument(String, IResourceLocator) - 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.

openReportDocument(String, String, IResourceLocator) - 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.

openReportDocument(String, String, Map) - 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.

openReportDocument(String, IDocArchiveReader, Map) - 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.TaskOption

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.

org.eclipse.birt.report.engine.layout.content - package org.eclipse.birt.report.engine.layout.content

org.eclipse.birt.report.engine.layout.emitter - package org.eclipse.birt.report.engine.layout.emitter

org.eclipse.birt.report.engine.layout.pdf.emitter - package org.eclipse.birt.report.engine.layout.pdf.emitter

output(IExtractionResults) - Method in interface org.eclipse.birt.report.engine.extension.IDataExtractionExtension

Outputs data defined in the result set.

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_DISPLAY_NONE - Static variable in interface org.eclipse.birt.report.engine.api.IRenderOption

OUTPUT_EMITTERID_HTML - Static variable in interface org.eclipse.birt.report.engine.api.IRenderOption

OUTPUT_EMITTERID_PDF - Static variable in interface org.eclipse.birt.report.engine.api.IRenderOption

OUTPUT_FILE_NAME - Static variable in interface org.eclipse.birt.report.engine.api.IDataExtractionOption

OUTPUT_FILE_NAME - Static variable in interface org.eclipse.birt.report.engine.api.IRenderOption

OUTPUT_FORMAT - Static variable in interface org.eclipse.birt.report.engine.api.IDataExtractionOption

OUTPUT_FORMAT - Static variable in interface org.eclipse.birt.report.engine.api.IRenderOption

OUTPUT_FORMAT_FO - Static variable in interface org.eclipse.birt.report.engine.api.IRenderOption

OUTPUT_FORMAT_HTML - Static variable in interface org.eclipse.birt.report.engine.api.IRenderOption

OUTPUT_FORMAT_PDF - Static variable in interface org.eclipse.birt.report.engine.api.IRenderOption

OUTPUT_NONE - Static variable in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation

OUTPUT_STREAM - Static variable in interface org.eclipse.birt.report.engine.api.IDataExtractionOption

OUTPUT_STREAM - Static variable in interface org.eclipse.birt.report.engine.api.IRenderOption

OUTPUT_TO_MULTIPLE_PAGES - Static variable in interface org.eclipse.birt.report.engine.api.IPDFRenderOption

P

PADDING_BOTTOM - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

PADDING_LEFT - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

PADDING_RIGHT - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

PADDING_TOP - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

PAGE_BREAK_AFTER - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

PAGE_BREAK_BEFORE - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

PAGE_BREAK_INSIDE - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

PAGE_CONTENT - Static variable in interface org.eclipse.birt.report.engine.content.IContent

PAGE_NUMBER - Static variable in interface org.eclipse.birt.report.engine.content.IAutoTextContent

PAGE_OVERFLOW - Static variable in interface org.eclipse.birt.report.engine.api.IPDFRenderOption

Properties to control how to output the content if the content exceeds the page-size.

PAGEBREAK_PAGINATION_ONLY - Static variable in interface org.eclipse.birt.report.engine.api.IPDFRenderOption

Deprecated. The flag to indicate whether PDF layout use auto page break or not. if it is set to true, then auto page break will not take effect. This property has been deprecated, please set PAGE_OVERFLOW = OUTPUT_TO_MULTIPLE_PAGES instead.

PAGEFOOTER_FLOAT_FLAG - Static variable in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

Floating the page footer.

pageNumber - Variable in class org.eclipse.birt.report.engine.api.ReportRunner

output page number, used in Render mode.

PARAMETER_GROUP - Static variable in interface org.eclipse.birt.report.engine.api.IParameterDefnBase

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.DataID

create a new data id instance from the string.

parse(String) - Static method in class org.eclipse.birt.report.engine.api.DataSetID

Parse the dataSetID of a String

parse(char[], int, int) - Static method in class org.eclipse.birt.report.engine.api.DataSetID

Parse dataSetID.

parse(String) - Static method in class org.eclipse.birt.report.engine.api.InstanceID

Parse the input string into an InstanceId object.

parse(char[], int, int) - Static method in class org.eclipse.birt.report.engine.api.InstanceID

Parse the input char buffer into an InstanceId object.

parse(String, int) - Method in class org.eclipse.birt.report.engine.api.ReportParameterConverter

Convert report parameter from string into object.

parseConfigurationOptions() - Method in class org.eclipse.birt.report.engine.api.ReportRunner

paraser the config/paramter/renderoption command line inputs.

parseDateTime(String) - Method in class org.eclipse.birt.report.engine.api.ReportParameterConverter

Parse the input string to an object.

parseOptions() - Method in class org.eclipse.birt.report.engine.api.ReportRunner

parse the arguments.

parseRenderOptions() - Method in class org.eclipse.birt.report.engine.api.ReportRunner

Parse render options.

parseRunAndRenderOptions() - Method in class org.eclipse.birt.report.engine.api.ReportRunner

Parse run and render options.

parseRunOptions() - Method in class org.eclipse.birt.report.engine.api.ReportRunner

Parse running options.

PDF_BIDI_PROCESSING - Static variable in interface org.eclipse.birt.report.engine.api.IPDFRenderOption

If it is set to false, no BIDI processing is used.

PDF_FONT_SUBSTITUTION - Static variable in interface org.eclipse.birt.report.engine.api.IPDFRenderOption

If it is set to false, we needn't check if the character exists in the selected font.

PDF_HYPHENATION - Static variable in interface org.eclipse.birt.report.engine.api.IPDFRenderOption

If it is set to false, no hyphenation is used.

PDF_TEXT_WRAPPING - Static variable in interface org.eclipse.birt.report.engine.api.IPDFRenderOption

If it is set to false, all the text should be displayed into one line, the text which can not be displayed in the line will be clipped.

PDFRenderContext - Class in org.eclipse.birt.report.engine.api

Deprecated. set the option to RenderOption directly.

PDFRenderContext() - Constructor for class org.eclipse.birt.report.engine.api.PDFRenderContext

Deprecated. dummy constructor

PDFRenderOption - Class in org.eclipse.birt.report.engine.api

Defines render options for emitters

PDFRenderOption() - Constructor for class org.eclipse.birt.report.engine.api.PDFRenderOption

dummy constructor

PDFRenderOption(IRenderOption) - Constructor for class org.eclipse.birt.report.engine.api.PDFRenderOption

Constructor.

pluginId - Static variable in exception org.eclipse.birt.report.engine.api.EngineException

prepare(DesignElementHandle) - Method in interface org.eclipse.birt.report.engine.extension.IPreparationContext

prepare() - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPreparation

printUsage() - Method in class org.eclipse.birt.report.engine.api.ReportRunner

print out the command line usage.

PROJECT_CLASSPATH_KEY - Static variable in class org.eclipse.birt.report.engine.api.EngineConstants

PROPERTY_EXTENDED_ITEM_MAX_ROW - Static variable in class org.eclipse.birt.report.engine.api.EngineConstants

This property is a key for putting max row number of extended item in app context or global variables.

PROPERTYSEPARATOR - Static variable in class org.eclipse.birt.report.engine.api.EngineConstants

Q

QUERY_RESULTSET - Static variable in interface org.eclipse.birt.report.engine.extension.IBaseResultSet

R

RADIO_BUTTON - Static variable in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn

read(DataInputStream) - Method in interface org.eclipse.birt.report.engine.content.IStyle

readConfigurationFile(String, HashMap) - Method in class org.eclipse.birt.report.engine.api.ReportRunner

read Config-Parameter-Render file

readContent(DataInputStream, ClassLoader) - Method in interface org.eclipse.birt.report.engine.content.IContent

readParamString(String, HashMap) - Method in class org.eclipse.birt.report.engine.api.ReportRunner

read paramters from the param and add it into the params.

refresh() - Method in interface org.eclipse.birt.report.engine.api.IReportDocument

check the current readed checkpoint and the current writed check point.

REFRESH_RATE - Static variable in interface org.eclipse.birt.report.engine.api.IReportRunnable

release() - Method in interface org.eclipse.birt.report.engine.extension.IDataExtractionExtension

Releases all resources allocated in the extension.

release() - Method in interface org.eclipse.birt.report.engine.extension.IExtendedItem

release() - Method in interface org.eclipse.birt.report.engine.extension.IExtendedItemFactory

removeChildren() - Method in interface org.eclipse.birt.report.engine.content.INode

Remove all children of the node.

render() - Method in interface org.eclipse.birt.report.engine.api.IRenderTask

render the whole report document or an output format

render(long) - Method in interface org.eclipse.birt.report.engine.api.IRenderTask

Deprecated. A page with speicfic page number can be rendered like this:
setPageNumber( pageNumber );
render( );

render(String) - Method in interface org.eclipse.birt.report.engine.api.IRenderTask

Deprecated. A range of pages can be rendered like this:
setPageRange( pageRange );
render( );

render(InstanceID) - Method in interface org.eclipse.birt.report.engine.api.IRenderTask

Deprecated. A page which contains the instance can be rendered like this:
setInstanceID( instanceID );
render( );

renderOption - Variable in class org.eclipse.birt.report.engine.api.HTMLRenderContext

Deprecated. HTML render option

RenderOption - Class in org.eclipse.birt.report.engine.api

Settings for rendering a report to an output format.

RenderOption() - Constructor for class org.eclipse.birt.report.engine.api.RenderOption

constructor

RenderOption(Map) - Constructor for class org.eclipse.birt.report.engine.api.RenderOption

Constructor.

RenderOption(IRenderOption) - Constructor for class org.eclipse.birt.report.engine.api.RenderOption

Constructor.

RenderOptionBase - Class in org.eclipse.birt.report.engine.api

Deprecated. use RenderOption instead

RenderOptionBase() - Constructor for class org.eclipse.birt.report.engine.api.RenderOptionBase

Deprecated.

renderReport() - Method in class org.eclipse.birt.report.engine.api.ReportRunner

render the report.

REPORT_DOCUMENT_LOCK_MANAGER - Static variable in interface org.eclipse.birt.report.engine.api.IEngineConfig

REPORTDOC_IMAGE - Static variable in interface org.eclipse.birt.report.engine.api.IImage

ReportEngine - Class in org.eclipse.birt.report.engine.api

This is a wrapper class for the IReportEngine.

ReportEngine(EngineConfig) - Constructor for class org.eclipse.birt.report.engine.api.ReportEngine

Constructor.

ReportParameterConverter - Class in org.eclipse.birt.report.engine.api

Utilites class to convert report paramete value between object and string.

ReportParameterConverter(String, Locale) - Constructor for class org.eclipse.birt.report.engine.api.ReportParameterConverter

ReportParameterConverter(String, ULocale) - Constructor for class org.eclipse.birt.report.engine.api.ReportParameterConverter

Constructor.

ReportParameterConverter(String, ULocale, TimeZone) - Constructor for class org.eclipse.birt.report.engine.api.ReportParameterConverter

Constructor.

ReportRunner - Class in org.eclipse.birt.report.engine.api

Defines a standalone reporting application that uses StandaloneReportEngine class.

ReportRunner(String[]) - Constructor for class org.eclipse.birt.report.engine.api.ReportRunner

Constructor of ReportRunner

RESOURCE_LOCATOR - Static variable in interface org.eclipse.birt.report.engine.api.IEngineConfig

resource locator used by design engine

RESOURCE_PATH - Static variable in interface org.eclipse.birt.report.engine.api.IEngineConfig

resource path used by design engine

resourceBundles - Static variable in exception org.eclipse.birt.report.engine.api.EngineException

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

rowId - Variable in class org.eclipse.birt.report.engine.api.DataID

Id of the row.

RTL_FLAG - Static variable in interface org.eclipse.birt.report.engine.api.IRenderOption

bidi_hcg: Should we output report as RTL.

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

run(FolderArchive) - Method in interface org.eclipse.birt.report.engine.api.IRunTask

Deprecated.

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

SCRIPT_OBJECTS - Static variable in interface org.eclipse.birt.report.engine.api.IEngineConfig

selectColumns(String[]) - Method in interface org.eclipse.birt.report.engine.api.IDataExtractionTask

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

SELECTION_LIST_TYPE_DYNAMIC - Static variable in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn

SELECTION_LIST_TYPE_STATIC - Static variable in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn

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.

SERIALIZE_CONTENT - Static variable in interface org.eclipse.birt.report.engine.content.IContent

setACL(String) - Method in interface org.eclipse.birt.report.engine.content.IContent

setACL(String) - Method in interface org.eclipse.birt.report.engine.content.IReportContent

setActionHandle(IHTMLActionHandler) - Method in interface org.eclipse.birt.report.engine.api.IRenderOption

Deprecated.

setActionHandle(IHTMLActionHandler) - Method in class org.eclipse.birt.report.engine.api.RenderOption

Deprecated.

setActionHandler(IHTMLActionHandler) - Method in class org.eclipse.birt.report.engine.api.DataExtractionOption

setActionHandler(IHTMLActionHandler) - Method in interface org.eclipse.birt.report.engine.api.IDataExtractionOption

setActionHandler(IHTMLActionHandler) - Method in interface org.eclipse.birt.report.engine.api.IRenderOption

setActionHandler(IHTMLActionHandler) - Method in class org.eclipse.birt.report.engine.api.RenderOption

setActionHandler(IHTMLActionHandler) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation

Deprecated. implement #init(IReportItemPresentationInfo) instead.

setAltText(String) - Method in interface org.eclipse.birt.report.engine.content.IForeignContent

setAltText(String) - Method in interface org.eclipse.birt.report.engine.content.IImageContent

setAltTextKey(String) - Method in interface org.eclipse.birt.report.engine.content.IForeignContent

setAltTextKey(String) - Method in interface org.eclipse.birt.report.engine.content.IImageContent

setAppBaseURL(String) - Method in interface org.eclipse.birt.report.engine.api.IRenderOption

Set app base url

setAppBaseURL(String) - Method in class org.eclipse.birt.report.engine.api.RenderOption

Set app base url

setAppContext(HashMap) - Method in class org.eclipse.birt.report.engine.api.EngineConfig

Set appContext

setAppContext(Map) - Method in interface org.eclipse.birt.report.engine.api.IEngineTask

sets the task context.

setApplicationClassLoader(ClassLoader) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemGeneration

Deprecated. implement #init(IReportItemGenerationInfo) instead

setApplicationClassLoader(ClassLoader) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation

Deprecated. implement #init(IReportItemPresentationInfo) instead.

setBackgroundAttachement(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

setBackgroundAttachment(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the attachment type (either SCROLL or FIXED)

setBackgroundColor(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the background color

setBackgroundImage(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the background image URI

setBackgroundPositionX(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the X (horizontal) position of the background image

setBackgroundPositionX(String) - Method in interface org.eclipse.birt.report.engine.content.IStyle

setBackgroundPositionY(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the Y (vertical) position of the background image

setBackgroundPositionY(String) - Method in interface org.eclipse.birt.report.engine.content.IStyle

setBackgroundRepeat(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the background repeat type (valid types are REPEAT, REPEAT_X, REPEAT_Y and NO_REPEAT)

setBandType(int) - Method in interface org.eclipse.birt.report.engine.content.IBandContent

Set the type of the band content.

setBaseImageURL(String) - Method in class org.eclipse.birt.report.engine.api.HTMLRenderContext

Deprecated. sets the base image URL for image handling

setBaseImageURL(String) - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

sets the base image URL for image handling

setBaseImageURL(String) - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

sets the base image URL for image handling

setBaseURL(String) - Method in class org.eclipse.birt.report.engine.api.DOCRenderContext

sets the base url for action handling

setBaseURL(String) - Method in class org.eclipse.birt.report.engine.api.HTMLRenderContext

Deprecated. sets the base url for action handling

setBaseURL(String) - Method in interface org.eclipse.birt.report.engine.api.IRenderOption

sets the base url for action handling

setBaseURL(String) - Method in class org.eclipse.birt.report.engine.api.PDFRenderContext

Deprecated. sets the base URL for action handling

setBaseURL(String) - Method in class org.eclipse.birt.report.engine.api.RenderOption

sets the base url for action handling

setBookmark(String) - Method in interface org.eclipse.birt.report.engine.api.IRenderTask

Sets bookmark.

setBookmark(String) - Method in class org.eclipse.birt.report.engine.api.TOCNode

Set bookmark

setBookmark(String) - Method in interface org.eclipse.birt.report.engine.content.IContent

setBookmark(String) - Method in interface org.eclipse.birt.report.engine.content.IDrillThroughAction

Set the bookmark type of this drillthrough action.

setBookmark(String) - Method in interface org.eclipse.birt.report.engine.content.IHyperlinkAction

setBookmarkType(boolean) - Method in interface org.eclipse.birt.report.engine.content.IDrillThroughAction

Set the type of bookmark.

setBookmarkType(boolean) - Method in interface org.eclipse.birt.report.engine.content.IHyperlinkAction

setBorderBottomColor(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the bottom border color

setBorderBottomStyle(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the bottom border style.

setBorderBottomWidth(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the bottom border width.

setBorderLeftColor(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the left border color

setBorderLeftStyle(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the left border style.

setBorderLeftWidth(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the left border width.

setBorderRightColor(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the right border color

setBorderRightStyle(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the right border style.

setBorderRightWidth(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the right border width.

setBorderTopColor(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the top border color

setBorderTopStyle(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Get the top border style.

setBorderTopWidth(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the top border width.

setCanShrink(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Can this element shrink?

setCanShrink(String) - Method in interface org.eclipse.birt.report.engine.content.IStyle

setCaption(String) - Method in interface org.eclipse.birt.report.engine.content.ITableContent

setCaptionKey(String) - Method in interface org.eclipse.birt.report.engine.content.ITableContent

setColor(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the font color

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

Deprecated. use setProperty() instead.

setContext(IExecutorContext) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemExecutor

set executor context to the extension executor

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

setDataSource(IDocArchiveReader) - Method in interface org.eclipse.birt.report.engine.api.IEngineTask

set the data source used by the engine task.

setDataSource(IDocArchiveReader, String) - Method in interface org.eclipse.birt.report.engine.api.IEngineTask

set the data source used by the engine task.

setDateFormat(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the date format

setDateFormat(String) - Method in interface org.eclipse.birt.report.engine.content.IStyle

setDefualtEmitter(String, String) - Method in class org.eclipse.birt.report.engine.api.EngineConfig

Sets default emitter for an output format.

setDesignHandle(ReportDesignHandle) - Method in interface org.eclipse.birt.report.engine.api.IReportRunnable

sets a new report design handle before rendering the report

setDirection(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

setDisplay(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the display type (valid types are BLOCK, INLINE and NONE)

setDisplayFilterIcon(boolean) - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

Sets the flag indicationg that if filter icons should be displayed.

setDisplayFilterIcon(boolean) - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

Sets the flag indicationg that if filter icons should be displayed.

setDisplayGroupIcon(boolean) - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

Sets the flag indicationg that if group expand/collapse icons should be displayed.

setDisplayGroupIcon(boolean) - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

Sets the flag indicationg that if group expand/collapse icons should be displayed.

setDisplayGroupIcon(boolean) - Method in interface org.eclipse.birt.report.engine.content.ICellContent

setDisplayString(String) - Method in class org.eclipse.birt.report.engine.api.TOCNode

setDistinctValuesOnly(boolean) - Method in interface org.eclipse.birt.report.engine.api.IDataExtractionTask

whether gets distinct values

setDrillThrough(String, boolean, String, Map, Map, String, String) - Method in interface org.eclipse.birt.report.engine.content.IHyperlinkAction

Deprecated.

setDrillThrough(String, boolean, String, Map, Map, String, String, String) - Method in interface org.eclipse.birt.report.engine.content.IHyperlinkAction

setDrillThrough(IDrillThroughAction) - Method in interface org.eclipse.birt.report.engine.content.IHyperlinkAction

setDynamicStyle(IStyle) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation

Deprecated. implement #init(IReportItemPresentationInfo) instead. Set dynamic style.

setElementID(long) - Method in exception org.eclipse.birt.report.engine.api.EngineException

Set element id.

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

setEmbeddable(boolean) - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

sets whether the HTML output can be embedded directly into an HTML page

setEmbededFont(boolean) - Method in class org.eclipse.birt.report.engine.api.DOCRenderContext

setEmbededFont(boolean) - Method in interface org.eclipse.birt.report.engine.api.IPDFRenderOption

Deprecated.

setEmbededFont(boolean) - Method in class org.eclipse.birt.report.engine.api.PDFRenderContext

Deprecated. Set flag indicates if the font needs to be embedded.

setEmbededFont(boolean) - Method in class org.eclipse.birt.report.engine.api.PDFRenderOption

Set flag indicates if the font needs to be embedded.

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.IRenderOption

sets the emitter id

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.

setEmitterID(String) - Method in class org.eclipse.birt.report.engine.api.RenderOption

Set emitter id.

setEnableAgentStyleEngine(boolean) - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

Sets the flag indicationg that agentStyleEngine is enabled or not.

setEnableMetadata(boolean) - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

Sets the flag which indicating if metadata should be output.

setEnableMetadata(boolean) - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

Sets the flag which indicating if metadata should be output.

setEngineContext(IPlatformContext) - Method in class org.eclipse.birt.report.engine.api.EngineConfig

Deprecated. use setPlatformContext instead.

setEngineHome(String) - Method in class org.eclipse.birt.report.engine.api.EngineConfig

set the BIRT_HOME system property

setErrorHandlingOption(int) - Method in interface org.eclipse.birt.report.engine.api.IEngineTask

set the error handling mode for the first error.

setExtendedItemContent(IContent) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemGeneration

Deprecated. implement #init(IReportItemGenerationInfo) instead

setExtendedItemContent(IContent) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation

Deprecated. implement #init(IReportItemPresentationInfo) instead.

setExtension(String) - Method in class org.eclipse.birt.report.engine.api.DataExtractionOption

Set extension id.

setExtension(String) - Method in interface org.eclipse.birt.report.engine.api.IDataExtractionOption

Set extension id.

setExtension(int, Object) - Method in interface org.eclipse.birt.report.engine.content.IContent

Set the extension of the content.

setExtension(String) - Method in interface org.eclipse.birt.report.engine.content.IImageContent

setFilters(IFilterDefinition[]) - Method in interface org.eclipse.birt.report.engine.api.IDataExtractionTask

setFontDirectory(String) - Method in class org.eclipse.birt.report.engine.api.DOCRenderContext

setFontDirectory(String) - Method in interface org.eclipse.birt.report.engine.api.IPDFRenderOption

Deprecated.

setFontDirectory(String) - Method in class org.eclipse.birt.report.engine.api.PDFRenderContext

Deprecated.

setFontDirectory(String) - Method in class org.eclipse.birt.report.engine.api.PDFRenderOption

Deprecated.

setFontFamily(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the font family

setFontSize(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the font size

setFontStyle(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the font style

setFontVariant(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the font variant

setFontWeight(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the font weight

setFormat(String) - Method in interface org.eclipse.birt.report.engine.content.IDrillThroughAction

set the format of the output report.

setGenerateBy(Object) - Method in interface org.eclipse.birt.report.engine.content.IColumn

setGenerateBy(Object) - Method in interface org.eclipse.birt.report.engine.content.IContent

setGroupID(String) - Method in interface org.eclipse.birt.report.engine.content.IGroupContent

Set the unique id of the group.

setGroupId(String) - Method in interface org.eclipse.birt.report.engine.content.IRowContent

setHeaderRepeat(boolean) - Method in interface org.eclipse.birt.report.engine.content.IGroupContent

Set the value if the group header is repeated.

setHeaderRepeat(boolean) - Method in interface org.eclipse.birt.report.engine.content.IListContent

Set the value if the list header is repeated.

setHeaderRepeat(boolean) - Method in interface org.eclipse.birt.report.engine.content.ITableContent

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

Set the help text string of the label content.

setHTMLIDNamespace(String) - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

sets the HTML ID namespace.

setHtmlPagination(boolean) - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

Set html pagination.

setHtmlPagination(boolean) - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

Set Html pagination.

setHtmlRtLFlag(boolean) - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

Set Html RTL flag.

setHtmlRtLFlag(boolean) - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

Set Html RTL flag.

setHtmlTitle(String) - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

setHtmlTitle(String) - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

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

setID(String) - Method in class org.eclipse.birt.report.engine.api.CachedImage

set the id of the cached image.

setImageDirectory(String) - Method in class org.eclipse.birt.report.engine.api.HTMLRenderContext

Deprecated. sets the image directory that engine stores images and charts into

setImageDirectory(String) - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

sets the image directory that engine stores images and charts into

setImageDirectory(String) - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

sets the image directory that engine stores images and charts into

setImageHandle(IHTMLImageHandler) - Method in interface org.eclipse.birt.report.engine.api.IRenderOption

Deprecated.

setImageHandle(IHTMLImageHandler) - Method in class org.eclipse.birt.report.engine.api.RenderOption

Deprecated.

setImageHandler(IHTMLImageHandler) - Method in class org.eclipse.birt.report.engine.api.DataExtractionOption

setImageHandler(IHTMLImageHandler) - Method in interface org.eclipse.birt.report.engine.api.IDataExtractionOption

setImageHandler(IHTMLImageHandler) - Method in interface org.eclipse.birt.report.engine.api.IRenderOption

setImageHandler(IHTMLImageHandler) - Method in class org.eclipse.birt.report.engine.api.RenderOption

setImageMap(String) - Method in class org.eclipse.birt.report.engine.api.CachedImage

set the image map of the image.

setImageMap(Object) - Method in interface org.eclipse.birt.report.engine.content.IImageContent

setImageSize(ImageSize) - Method in class org.eclipse.birt.report.engine.api.CachedImage

set the image size

setImageSource(int) - Method in interface org.eclipse.birt.report.engine.content.IImageContent

setIncludeSelectionHandle(boolean) - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

Deprecated. includeSelectionHandle is replaced by eanableMetadata flag.

setIncludeSelectionHandle(boolean) - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

Deprecated. includeSelectionHandle is replaced by eanableMetadata flag.

setInlineStyle(IStyle) - Method in interface org.eclipse.birt.report.engine.content.IColumn

setInlineStyle(IStyle) - Method in interface org.eclipse.birt.report.engine.content.IContent

setInstanceID(InstanceID) - Method in class org.eclipse.birt.report.engine.api.DataExtractionOption

setInstanceID(InstanceID) - Method in interface org.eclipse.birt.report.engine.api.IDataExtractionOption

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.api.IRenderTask

Sets id of instance.

setInstanceID(String) - Method in interface org.eclipse.birt.report.engine.api.IRenderTask

Sets id of instance which is a string type.

setInstanceID(InstanceID) - Method in interface org.eclipse.birt.report.engine.content.IContent

set the instace id of the content.

setInstanceIDs(List) - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

setInstanceIDs(List) - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

setLabelKey(String) - Method in interface org.eclipse.birt.report.engine.content.IDataContent

Set the label key of the data content.

setLabelKey(String) - Method in interface org.eclipse.birt.report.engine.content.ILabelContent

Set the label key string of the label content.

setLabelText(String) - Method in interface org.eclipse.birt.report.engine.content.IDataContent

Set the label text of the data content.

setLabelText(String) - Method in interface org.eclipse.birt.report.engine.content.ILabelContent

Set the text string of label content.

setLayoutPreference(String) - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

Sets the flag indicationg that if the table should be outed as fixed.

setLetterSpacing(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the letter spacing

setLineHeight(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the line height

setLocale(Locale) - Method in interface org.eclipse.birt.report.engine.api.IEngineTask

sets the task locale

setLocale(ULocale) - 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

Deprecated. implement #init(IReportItemPresentationInfo) instead.

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

setLogFile(String) - Method in class org.eclipse.birt.report.engine.api.EngineConfig

Set the name of the log file.

setLogger(Logger) - Method in class org.eclipse.birt.report.engine.api.EngineConfig

set the logger used by the report engine.

setLogger(Logger) - Method in interface org.eclipse.birt.report.engine.api.IEngineTask

set the logger used by the task.

setLogger(Logger) - Method in interface org.eclipse.birt.report.engine.api.IReportEngine

Set the logger used the engine.

setLogger(Logger) - Method in class org.eclipse.birt.report.engine.api.ReportEngine

set the logger used by report engine.

setMarginBottom(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the bottom margin

setMarginLeft(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the left margin

setMarginRight(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the right margin

setMarginTop(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the top margin

setMasterPage(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the master page

setMasterPage(String) - Method in interface org.eclipse.birt.report.engine.content.IStyle

setMasterPageContent(boolean) - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

Set master page content.

setMasterPageContent(boolean) - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

Set master page content.

setMaxRows(int) - Method in interface org.eclipse.birt.report.engine.api.IDataExtractionTask

setMaxRowsPerQuery(int) - Method in class org.eclipse.birt.report.engine.api.EngineConfig

Deprecated.

setMaxRowsPerQuery(int) - Method in interface org.eclipse.birt.report.engine.api.IRunAndRenderTask

set the max rows per query

setMaxRowsPerQuery(int) - Method in interface org.eclipse.birt.report.engine.api.IRunTask

set the max rows per query

setMIMEType(String) - Method in class org.eclipse.birt.report.engine.api.CachedImage

set the mime type of the image.

setMIMEType(String) - Method in interface org.eclipse.birt.report.engine.content.IImageContent

setModelObject(Object) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemExecutor

set extended report item model handle to the extension executor *

setModelObject(ExtendedItemHandle) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemGeneration

Deprecated. implement #init(IReportItemGenerationInfo) instead

setModelObject(ExtendedItemHandle) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation

Deprecated. implement #init(IReportItemPresentationInfo) instead

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

setNext(INode) - Method in interface org.eclipse.birt.report.engine.content.INode

Set the sibling node immediately following the specified node.

setNodeID(String) - Method in class org.eclipse.birt.report.engine.api.TOCNode

Set Node id

setNumberAlign(String) - Method in interface org.eclipse.birt.report.engine.content.IStyle

setNumberFormat(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the number format

setNumberFormat(String) - Method in interface org.eclipse.birt.report.engine.content.IStyle

setOfficeVersion(String) - Method in class org.eclipse.birt.report.engine.api.EXCELRenderOption

Set office version.

setOfficeVersion(String) - Method in interface org.eclipse.birt.report.engine.api.IExcelRenderOption

setOption(String, Object) - Method in interface org.eclipse.birt.report.engine.api.ITaskOption

set the option value.

setOption(String, Object) - Method in class org.eclipse.birt.report.engine.api.TaskOption

set value for one rendering option

setOutputFile(String) - Method in class org.eclipse.birt.report.engine.api.DataExtractionOption

Set output file.

setOutputFile(String) - Method in interface org.eclipse.birt.report.engine.api.IDataExtractionOption

Set output file.

setOutputFileName(String) - Method in interface org.eclipse.birt.report.engine.api.IRenderOption

Set name of the output file.

setOutputFileName(String) - Method in class org.eclipse.birt.report.engine.api.RenderOption

Set name of the output file.

setOutputFormat(String) - Method in class org.eclipse.birt.report.engine.api.DataExtractionOption

Set output format.

setOutputFormat(String) - Method in interface org.eclipse.birt.report.engine.api.IDataExtractionOption

Set output format.

setOutputFormat(String) - Method in interface org.eclipse.birt.report.engine.api.IRenderOption

Set output format.

setOutputFormat(String) - Method in class org.eclipse.birt.report.engine.api.RenderOption

setOutputFormat(String) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation

Deprecated. implement #init(IReportItemPresentationInfo) instead.

setOutputMasterPageMargins(boolean) - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

Sets the flag indicationg that output the master page's margins for the auto layout report or not.

setOutputStream(OutputStream) - Method in class org.eclipse.birt.report.engine.api.DataExtractionOption

Set output stream.

setOutputStream(OutputStream) - Method in interface org.eclipse.birt.report.engine.api.IDataExtractionOption

Set output stream.

setOutputStream(OutputStream) - Method in interface org.eclipse.birt.report.engine.api.IRenderOption

Set output stream.

setOutputStream(OutputStream) - Method in class org.eclipse.birt.report.engine.api.RenderOption

setPaddingBottom(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the bottom padding.

setPaddingLeft(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the left padding.

setPaddingRight(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the right padding.

setPaddingTop(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the top padding.

setPageBody(IContent) - Method in interface org.eclipse.birt.report.engine.content.IPageContent

setPageBreakAfter(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the page break after

setPageBreakBefore(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the page break before

setPageBreakInside(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the page break inside

setPageFooter(IContent) - Method in interface org.eclipse.birt.report.engine.content.IPageContent

setPageFooterFloatFlag(boolean) - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

Set page footer float flag.

setPageFooterFloatFlag(boolean) - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

Set page footer float flag.

setPageHandler(IPageHandler) - Method in interface org.eclipse.birt.report.engine.api.IRunAndRenderTask

set user defined IPageHandler

setPageHandler(IPageHandler) - Method in interface org.eclipse.birt.report.engine.api.IRunTask

set up event handler to be called after each page is generated

setPageHeader(IContent) - Method in interface org.eclipse.birt.report.engine.content.IPageContent

setPageNumber(long) - Method in interface org.eclipse.birt.report.engine.api.IRenderTask

Sets number of the page to be rendered.

setPageNumber(long) - Method in interface org.eclipse.birt.report.engine.content.IPageContent

setPageRange(String) - Method in interface org.eclipse.birt.report.engine.api.IRenderTask

Sets range of the pages to be rendered.

setParameter(String, Object, String) - Method in interface org.eclipse.birt.report.engine.api.IEngineTask

Sets parameter value and display text.

setParameterBindings(Map) - Method in interface org.eclipse.birt.report.engine.content.IDrillThroughAction

Set a set of name/value pairs for running the target report in a drillthrough link.

setParameterDisplayText(String, String) - Method in interface org.eclipse.birt.report.engine.api.IEngineTask

Sets display text of a parameter with specified name.

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

Set parent toc.

setParent(IElement) - Method in interface org.eclipse.birt.report.engine.content.IElement

Set the parent of the element.

setParent(INode) - Method in interface org.eclipse.birt.report.engine.content.INode

Set the parent of the node.

setParent(IReportItemExecutor) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemExecutor

set parent report item executor

setPrevious(INode) - Method in interface org.eclipse.birt.report.engine.content.INode

Set the sibling node immediately preceding the specified node.

setProperties(IStyle) - Method in interface org.eclipse.birt.report.engine.content.IStyle

setProperty(String, String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set property.

setProperty(int, CSSValue) - Method in interface org.eclipse.birt.report.engine.content.IStyle

setQueryContext(IQueryContext) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemQuery

set query context

setRawKey(String) - Method in interface org.eclipse.birt.report.engine.content.IForeignContent

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 class org.eclipse.birt.report.engine.api.HTMLRenderContext

Deprecated.

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

setRepeated(boolean) - Method in interface org.eclipse.birt.report.engine.content.IColumn

setReportContent(IReportContent) - Method in interface org.eclipse.birt.report.engine.content.IContent

set the report content.

setReportDocumentLockManager(IReportDocumentLockManager) - Method in class org.eclipse.birt.report.engine.api.EngineConfig

Set report document lock manager

setReportlet(String) - Method in interface org.eclipse.birt.report.engine.api.IRenderTask

Sets reportlet by bookmark.

setReportName(String) - Method in interface org.eclipse.birt.report.engine.content.IDrillThroughAction

Set the target report name if the action type is drillthrough which is predefined.

setReportName(String) - Method in interface org.eclipse.birt.report.engine.content.IHyperlinkAction

setReportQueries(IDataQueryDefinition[]) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemGeneration

Deprecated. implement #init(IReportItemGenerationInfo) instead

setReportQueries(IDataQueryDefinition[]) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation

Deprecated. implement #init(IReportItemPresentationInfo) instead. 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.content.IImageContent

setResolution(int) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation

Deprecated. implement #init(IReportItemPresentationInfo) instead.

setResourceLocator(IResourceLocator) - Method in class org.eclipse.birt.report.engine.api.EngineConfig

setResourcePath(String) - Method in class org.eclipse.birt.report.engine.api.EngineConfig

setRowID(int) - Method in interface org.eclipse.birt.report.engine.content.IRowContent

setRowSpan(int) - Method in interface org.eclipse.birt.report.engine.content.ICellContent

setRunnable(IReportRunnable) - Method in interface org.eclipse.birt.report.engine.api.IDocumentWriter

set a report runnable which can be used to update a report document

setScalarParameterType(String) - Method in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn

Set parameter type.

setScriptContext(IReportContext) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemGeneration

Deprecated. implement #init(IReportItemGenerationInfo) instead

setScriptContext(IReportContext) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation

Deprecated. implement #init(IReportItemPresentationInfo) instead.

setSearchCriteria(Map) - Method in interface org.eclipse.birt.report.engine.content.IDrillThroughAction

Set a set of name/value pairs for searching the target report in a drillthrough link.

setSeverity(int) - Method in exception org.eclipse.birt.report.engine.api.EngineException

setShowIfBlank(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set show if blank

setShowIfBlank(String) - Method in interface org.eclipse.birt.report.engine.content.IStyle

setSorts(ISortDefinition[]) - Method in interface org.eclipse.birt.report.engine.api.IDataExtractionTask

setStartRow(int) - Method in interface org.eclipse.birt.report.engine.api.IDataExtractionTask

Sets start row of the result.

setStatusHandler(IStatusHandler) - Method in class org.eclipse.birt.report.engine.api.EngineConfig

sets the handler for reporting report running status.

setStringFormat(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the string format

setStringFormat(String) - Method in interface org.eclipse.birt.report.engine.content.IStyle

setStyleClass(String) - Method in interface org.eclipse.birt.report.engine.content.IContent

setSummary(String) - Method in interface org.eclipse.birt.report.engine.content.ITableContent

setSupportedImageFormats(String) - Method in class org.eclipse.birt.report.engine.api.DOCRenderContext

setSupportedImageFormats(String) - Method in class org.eclipse.birt.report.engine.api.HTMLRenderContext

Deprecated.

setSupportedImageFormats(String) - Method in interface org.eclipse.birt.report.engine.api.IRenderOption

setSupportedImageFormats(String) - Method in class org.eclipse.birt.report.engine.api.PDFRenderContext

Deprecated.

setSupportedImageFormats(String) - Method in class org.eclipse.birt.report.engine.api.RenderOption

setSupportedImageFormats(String) - Method in interface org.eclipse.birt.report.engine.extension.IReportItemPresentation

Deprecated. implement #init(IReportItemPresentationInfo) instead.

setTargetFileType(String) - Method in interface org.eclipse.birt.report.engine.content.IDrillThroughAction

Sets the type of target report file for a drill-through action.

setTargetWindow(String) - Method in interface org.eclipse.birt.report.engine.content.IDrillThroughAction

Set the target window in string format.

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

Set the value of the text of the Text Content.

setTextAlign(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the text alignment.

setTextIndent(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the text indent

setTextIndent(ITextContent) - Method in interface org.eclipse.birt.report.engine.layout.pdf.emitter.IInlineStackingLayout

setTextIndent(ITextContent) - Method in class org.eclipse.birt.report.engine.layout.pdf.emitter.InlineContainerLayout

setTextIndent(ITextContent) - Method in class org.eclipse.birt.report.engine.layout.pdf.emitter.InlineStackingLayout

setTextLineThrough(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the text line through

setTextLineThrough(String) - Method in interface org.eclipse.birt.report.engine.content.IStyle

setTextOverline(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the text overline

setTextOverline(String) - Method in interface org.eclipse.birt.report.engine.content.IStyle

setTextTransform(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the text transform.

setTextUnderline(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the text underline

setTextUnderline(String) - Method in interface org.eclipse.birt.report.engine.content.IStyle

setTimeZone(TimeZone) - Method in interface org.eclipse.birt.report.engine.api.IEngineTask

Set the time zone information for the task.

setTOC(Object) - Method in interface org.eclipse.birt.report.engine.content.IContent

setTOCStyle(IScriptStyle) - Method in class org.eclipse.birt.report.engine.api.TOCNode

Set toc style.

setTooltip(String) - Method in interface org.eclipse.birt.report.engine.content.IHyperlinkAction

setType(int) - Method in interface org.eclipse.birt.report.engine.content.IAutoTextContent

Set the type of the AutoText Content.

setULocale(ULocale) - Static method in exception org.eclipse.birt.report.engine.api.EngineException

Set locale.

setURI(String) - Method in interface org.eclipse.birt.report.engine.content.IImageContent

setURL(String) - Method in class org.eclipse.birt.report.engine.api.CachedImage

set the image URL.

setUrlEncoding(String) - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

Set the URL encoding for the request.

setUrlEncoding(String) - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

setUserACL(String[]) - Method in interface org.eclipse.birt.report.engine.api.IEngineTask

set user's ACL.

setUserAgent(String) - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

setUserAgent(String) - Method in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

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

Set the value of the data content.

setVerticalAlign(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the vertical alignment.

setVisibleFormat(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set format to hide in.

setVisibleFormat(String) - Method in interface org.eclipse.birt.report.engine.content.IStyle

setWhiteSpace(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the whitespace.

setWidth(DimensionType) - Method in interface org.eclipse.birt.report.engine.content.IContent

setWordSpacing(String) - Method in class org.eclipse.birt.report.engine.api.TOCStyle

Set the word spacing

setWrappingText(boolean) - Method in class org.eclipse.birt.report.engine.api.EXCELRenderOption

Set wrapping text.

setWrappingText(boolean) - Method in interface org.eclipse.birt.report.engine.api.IExcelRenderOption

setWrapTemplateTable(boolean) - Method in class org.eclipse.birt.report.engine.api.HTMLRenderOption

Sets the flag indicationg that if the top-level table should be wrapped.

setX(DimensionType) - Method in interface org.eclipse.birt.report.engine.content.IContent

setY(DimensionType) - Method in interface org.eclipse.birt.report.engine.content.IContent

SHOW_IF_BLANK - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

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 interface org.eclipse.birt.report.engine.api.IReportEngine

Deprecated. Use destroy() instead.

shutdown() - Method in class org.eclipse.birt.report.engine.api.ReportEngine

Deprecated.

skipTo(String) - Method in interface org.eclipse.birt.report.engine.extension.ICubeResultSet

skipTo(long) - Method in interface org.eclipse.birt.report.engine.extension.IQueryResultSet

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

startAutoText(IAutoTextContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter

startCell(ICellContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter

startClip(int, int, int, int) - Method in interface org.eclipse.birt.report.engine.layout.emitter.IPage

Saves last graphic state, and clips a rectangle area.

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

startGroup(IGroupContent) - 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

startList(IListContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter

startListBand(IListBandContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter

startListGroup(IListGroupContent) - 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

startTableBand(ITableBandContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter

startTableGroup(ITableGroupContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter

startText(ITextContent) - Method in interface org.eclipse.birt.report.engine.emitter.IContentEmitter

STATUS_CANCELLED - Static variable in interface org.eclipse.birt.report.engine.api.IEngineTask

the task is finished by cancled

STATUS_FAILED - Static variable in interface org.eclipse.birt.report.engine.api.IEngineTask

the task is finished with errors

STATUS_HANDLER - Static variable in interface org.eclipse.birt.report.engine.api.IEngineConfig

STATUS_NOT_STARTED - Static variable in interface org.eclipse.birt.report.engine.api.IEngineTask

the task is not running yet

STATUS_RUNNING - Static variable in interface org.eclipse.birt.report.engine.api.IEngineTask

the task is running

STATUS_SUCCEEDED - Static variable in interface org.eclipse.birt.report.engine.api.IEngineTask

the task is finished with sucessful

STRING_FORMAT - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

stringToObject(int, String) - Method in class org.eclipse.birt.report.engine.api.ReportRunner

SUPPORTED_IMAGE_FORMATS - Static variable in interface org.eclipse.birt.report.engine.api.IRenderOption

supportedImageFormats - Variable in class org.eclipse.birt.report.engine.api.DOCRenderContext

the image formats supported by the browser

supportedImageFormats - Variable in class org.eclipse.birt.report.engine.api.HTMLRenderContext

Deprecated. the image formats supported by the browser

supportedImageFormats - Variable in class org.eclipse.birt.report.engine.api.PDFRenderContext

Deprecated. 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_GROUP_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

targetFile - Variable in class org.eclipse.birt.report.engine.api.ReportRunner

The target file name

TASK_DATAEXTRACTION - Static variable in interface org.eclipse.birt.report.engine.api.IEngineTask

TASK_GETPARAMETERDEFINITION - Static variable in interface org.eclipse.birt.report.engine.api.IEngineTask

TASK_RENDER - Static variable in interface org.eclipse.birt.report.engine.api.IEngineTask

TASK_RUN - Static variable in interface org.eclipse.birt.report.engine.api.IEngineTask

TASK_RUNANDRENDER - Static variable in interface org.eclipse.birt.report.engine.api.IEngineTask

TASK_UNKNOWN - Static variable in interface org.eclipse.birt.report.engine.api.IEngineTask

TaskOption - Class in org.eclipse.birt.report.engine.api

TaskOption() - Constructor for class org.eclipse.birt.report.engine.api.TaskOption

constructor

TaskOption(Map) - Constructor for class org.eclipse.birt.report.engine.api.TaskOption

Constructor.

TEMP_DIR - Static variable in interface org.eclipse.birt.report.engine.api.IEngineConfig

TEMPLATE_TYPE - Static variable in interface org.eclipse.birt.report.engine.content.IForeignContent

the content is an template.

TEXT_ALIGN - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

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_INDENT - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

TEXT_LINE_THROUGH - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

TEXT_OVERLINE - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

TEXT_TRANSFORM - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

TEXT_TYPE - Static variable in interface org.eclipse.birt.report.engine.content.IForeignContent

the content is an string which contains plain text

TEXT_UNDERLINE - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

threadLocal - Static variable in exception org.eclipse.birt.report.engine.api.EngineException

TITLE - Static variable in interface org.eclipse.birt.report.engine.api.IReportRunnable

TOCNode - Class in org.eclipse.birt.report.engine.api

A node that wraps around a TOC entry.

TOCNode() - Constructor for class org.eclipse.birt.report.engine.api.TOCNode

Constructor.

TOCNode(TOCNode) - Constructor for class org.eclipse.birt.report.engine.api.TOCNode

Constructor.

tocStyle - Variable in class org.eclipse.birt.report.engine.api.TOCNode

The TOC's style

TOCStyle - Class in org.eclipse.birt.report.engine.api

TOCStyle() - Constructor for class org.eclipse.birt.report.engine.api.TOCStyle

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.EngineConfig

Output properties for debug tracing

toString() - Method in class org.eclipse.birt.report.engine.api.InstanceID

toString() - Method in class org.eclipse.birt.report.engine.api.TOCStyle

TOTAL_PAGE - Static variable in interface org.eclipse.birt.report.engine.content.IAutoTextContent

toUniqueString() - Method in class org.eclipse.birt.report.engine.api.InstanceID

Returns a string representation of the uniqueID.

triggerEvent(DesignElementHandle) - Method in interface org.eclipse.birt.report.engine.extension.IPreparationContext

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 - 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_FLASH_OBJECT - Static variable in class org.eclipse.birt.report.engine.layout.pdf.emitter.ImageLayout

TYPE_FLOAT - Static variable in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn

TYPE_IMAGE_OBJECT - Static variable in class org.eclipse.birt.report.engine.layout.pdf.emitter.ImageLayout

TYPE_INTEGER - Static variable in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn

TYPE_STRING - Static variable in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn

TYPE_TIME - Static variable in interface org.eclipse.birt.report.engine.api.IScalarParameterDefn

U

uid - Variable in class org.eclipse.birt.report.engine.api.InstanceID

UNFILTERED_PAGE_NUMBER - Static variable in interface org.eclipse.birt.report.engine.content.IAutoTextContent

UNFILTERED_TOTAL_PAGE - Static variable in interface org.eclipse.birt.report.engine.content.IAutoTextContent

unit - Variable in class org.eclipse.birt.report.engine.api.ImageSize

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

unlock() - Method in interface org.eclipse.birt.report.engine.api.IReportDocumentLock

release this lock

UnsupportedFormatException - Exception in org.eclipse.birt.report.engine.api

UnsupportedFormatException(String, Object) - Constructor for exception org.eclipse.birt.report.engine.api.UnsupportedFormatException

constructor

URL_ENCODING - Static variable in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

for some case, the user needs to define the resource encoding.

URL_IMAGE - Static variable in interface org.eclipse.birt.report.engine.api.IImage

USER_ACL_KEY - Static variable in class org.eclipse.birt.report.engine.api.EngineConstants

USER_AGENT - Static variable in interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

The agent used to render the html output.

V

validateParameters() - Method in interface org.eclipse.birt.report.engine.api.IEngineTask

VALUE_TYPE - Static variable in interface org.eclipse.birt.report.engine.content.IForeignContent

the object value

VERTICAL_ALIGN - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

verticalAlign() - Method in class org.eclipse.birt.report.engine.layout.pdf.emitter.InlineStackingLayout

VISIBLE_FORMAT - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

visit(IContent, Object) - Method in interface org.eclipse.birt.report.engine.content.IContentVisitor

visitAutoText(IAutoTextContent, 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

visitGroup(IGroupContent, Object) - Method in interface org.eclipse.birt.report.engine.content.IContentVisitor

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

visitList(IListContent, Object) - Method in interface org.eclipse.birt.report.engine.content.IContentVisitor

visit list content

visitListBand(IListBandContent, Object) - Method in interface org.eclipse.birt.report.engine.content.IContentVisitor

visit list band content

visitListGroup(IListGroupContent, 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

visitTableGroup(ITableGroupContent, Object) - Method in interface org.eclipse.birt.report.engine.content.IContentVisitor

visitText(ITextContent, Object) - Method in interface org.eclipse.birt.report.engine.content.IContentVisitor

visit the text content object

W

WEBAPP_CLASSPATH_KEY - Static variable in class org.eclipse.birt.report.engine.api.EngineConstants

WHITE_SPACE - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

width - Variable in class org.eclipse.birt.report.engine.api.ImageSize

WORD_SPACING - Static variable in class org.eclipse.birt.report.engine.api.TOCStyle

WORKSPACE_CLASSPATH_KEY - Static variable in class org.eclipse.birt.report.engine.api.EngineConstants

WRAPPING_TEXT - Static variable in interface org.eclipse.birt.report.engine.api.IExcelRenderOption

The option to decide if the text out will be wrapped

write(DataOutputStream) - Method in interface org.eclipse.birt.report.engine.content.IStyle

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 Q R S T U V W