Interface IImageInstance
-
- All Superinterfaces:
IReportElementInstance,IReportItemInstance
public interface IImageInstance extends IReportItemInstance
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description IActionInstancecreateAction()Create a new action instance, witch can be bookmark, hyperlink or drillThrough.IActionInstancegetAction()Get the action instance.java.lang.StringgetAltText()Get the alt textjava.lang.StringgetAltTextKey()Get the alt textbyte[]getData()Returns the data for a named imagejava.lang.StringgetFile()get the image url, if the source type is notIMAGE_REF_TYPE_FILEreturn null.java.lang.StringgetImageName()Get the image nameintgetImageSource()Returns the type of image source Can be one of the following: org.eclipse.birt.report.engine.content.IImageContent.IMAGE_FILE org.eclipse.birt.report.engine.content.IImageContent.IMAGE_NAME org.eclipse.birt.report.engine.content.IImageContent.IMAGE_EXPRESSION org.eclipse.birt.report.engine.content.IImageContent.IMAGE_URLjava.lang.StringgetMimeType()Get the MIME Typejava.lang.StringgetURI()Get the image URIjava.lang.StringgetURL()get the image url, if the source type is notIMAGE_REF_TYPE_URLreturn null.voidsetAction(IActionInstance actionInstance)set the actionInstancevoidsetAltText(java.lang.String altText)Set the alt textvoidsetAltTextKey(java.lang.String altTextKey)Set the alt textvoidsetData(byte[] data)Set the data for a named imagevoidsetFile(java.lang.String file)Sets the image file.voidsetImageName(java.lang.String imageName)Set the image namevoidsetMimeType(java.lang.String type)Set the MIME TypevoidsetURI(java.lang.String uri)Deprecated.Set the image URIvoidsetURL(java.lang.String url)Sets the image url.-
Methods inherited from interface org.eclipse.birt.report.engine.api.script.instance.IReportElementInstance
getHeight, getHorizontalPosition, getNamedExpressionValue, getParent, getRowData, getStyle, getUserPropertyValue, getVerticalPosition, getWidth, setHeight, setHorizontalPosition, setUserPropertyValue, setVerticalPosition, setWidth
-
Methods inherited from interface org.eclipse.birt.report.engine.api.script.instance.IReportItemInstance
getHelpText, getHyperlink, getName, setHelpText, setName
-
-
-
-
Method Detail
-
getAltText
java.lang.String getAltText()
Get the alt text
-
setAltText
void setAltText(java.lang.String altText)
Set the alt text- Parameters:
altText-
-
getAltTextKey
java.lang.String getAltTextKey()
Get the alt text
-
setAltTextKey
void setAltTextKey(java.lang.String altTextKey)
Set the alt text- Parameters:
altText-
-
getURI
java.lang.String getURI()
Get the image URI
-
setURI
@Deprecated void setURI(java.lang.String uri)
Deprecated.Set the image URI
-
getImageSource
int getImageSource()
Returns the type of image source Can be one of the following: org.eclipse.birt.report.engine.content.IImageContent.IMAGE_FILE org.eclipse.birt.report.engine.content.IImageContent.IMAGE_NAME org.eclipse.birt.report.engine.content.IImageContent.IMAGE_EXPRESSION org.eclipse.birt.report.engine.content.IImageContent.IMAGE_URL
-
getImageName
java.lang.String getImageName()
Get the image name
-
setImageName
void setImageName(java.lang.String imageName)
Set the image name
-
getData
byte[] getData()
Returns the data for a named image
-
setData
void setData(byte[] data)
Set the data for a named image
-
getMimeType
java.lang.String getMimeType()
Get the MIME Type
-
setMimeType
void setMimeType(java.lang.String type)
Set the MIME Type
-
setURL
void setURL(java.lang.String url)
Sets the image url. The source type isIMAGE_REF_TYPE_URL, and will automatically set in this method.
-
getURL
java.lang.String getURL()
get the image url, if the source type is notIMAGE_REF_TYPE_URLreturn null.
-
setFile
void setFile(java.lang.String file)
Sets the image file. The source type isIMAGE_REF_TYPE_FILE, and will automatically set in this method.
-
getFile
java.lang.String getFile()
get the image url, if the source type is notIMAGE_REF_TYPE_FILEreturn null.
-
createAction
IActionInstance createAction()
Create a new action instance, witch can be bookmark, hyperlink or drillThrough. The default action instance type is NULL.
-
getAction
IActionInstance getAction()
Get the action instance.
-
setAction
void setAction(IActionInstance actionInstance)
set the actionInstance- Parameters:
actionInstance-
-
-