Class EmitterInfo
java.lang.Object
org.eclipse.birt.report.engine.api.EmitterInfo
The descriptor of the plugin emitter.
-
Constructor Summary
ConstructorsConstructorDescriptionEmitterInfo
(String format, String id, String pagination, String mimeType, String icon, String namespace, String fileExt, Boolean outputDisplayNone, Boolean isHidden, String supportedImageFormats, boolean needOutputResultSet, org.eclipse.birt.core.framework.IConfigurationElement emitter) -
Method Summary
Modifier and TypeMethodDescriptionorg.eclipse.birt.core.framework.IConfigurationElement
Get the emitter instance of the emitter.get the file extension of this emitter's output, "." not includedGet the format of the emitter.getIcon()
Get the icon of the emitter.getID()
Get the id of the emitter.Get the mimeType of the emitter.Get the namespace of the emitter.Get the outputDisplayNone of the emitter.int
Get the emitter override priority.Get the pagination of the emitter.get the image formats the emitter supportsboolean
Get if the emitter format is deprecatedisHidden()
get whether format is allowed to be shownboolean
If the emitter needs output query result set.void
setFormatDeprecated
(boolean isFormatDeprecated) Set if the emitter format is deprecatedvoid
setNeedOutputResultSet
(boolean needOutputResultSet) Set needOutputResultSet.void
setOverridePriority
(int overridePriority) Set the emitter override priority.
-
Constructor Details
-
EmitterInfo
-
-
Method Details
-
getNamespace
Get the namespace of the emitter.- Returns:
- namespace of the emitter
-
getIcon
Get the icon of the emitter.- Returns:
-
getFormat
Get the format of the emitter.- Returns:
- format of the emitter
-
getID
Get the id of the emitter.- Returns:
- id of the emitter
-
getEmitter
public org.eclipse.birt.core.framework.IConfigurationElement getEmitter()Get the emitter instance of the emitter.- Returns:
- emitter instance
-
getMimeType
Get the mimeType of the emitter.- Returns:
- mimeType of the emitter
-
getPagination
Get the pagination of the emitter.- Returns:
- pagination of the emitter
-
getOutputDisplayNone
Get the outputDisplayNone of the emitter.- Returns:
- outputDisplayNone of the emitter
-
getFileExtension
get the file extension of this emitter's output, "." not included- Returns:
- file extension
-
isHidden
get whether format is allowed to be shown- Returns:
- hideFormat
-
getSupportedImageFormats
get the image formats the emitter supports- Returns:
- the supported image formats.
-
needOutputResultSet
public boolean needOutputResultSet()If the emitter needs output query result set.- Returns:
-
setNeedOutputResultSet
public void setNeedOutputResultSet(boolean needOutputResultSet) Set needOutputResultSet.- Parameters:
needOutputResultSet
-
-
getOverridePriority
public int getOverridePriority()Get the emitter override priority.- Returns:
- the override priority.
-
setOverridePriority
public void setOverridePriority(int overridePriority) Set the emitter override priority.- Parameters:
overridePriority
-
-
isFormatDeprecated
public boolean isFormatDeprecated()Get if the emitter format is deprecated- Returns:
-
setFormatDeprecated
public void setFormatDeprecated(boolean isFormatDeprecated) Set if the emitter format is deprecated- Parameters:
isFormatDeprecated
-
-