|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IImage
Represents a the design of an Image in the scripting environment
Method Summary | |
---|---|
IAction |
getAction()
Returns a handle to work with the action property, action is a structure that defines a hyperlink. |
java.lang.String |
getAltText()
Returns the alternate text of this image. |
java.lang.String |
getAltTextKey()
Returns the resource key of the alternate text of this image. |
java.lang.String |
getFile()
Returns the image file, if the source type is not IMAGE_REF_TYPE_FILE return null. |
java.lang.String |
getHelpText()
Returns the help text of this image item. |
java.lang.String |
getHelpTextKey()
Returns the resource key of the help text of this image item. |
java.lang.String |
getImageName()
Returns the embedded image name that this image refers, if the image source type is IMAGE_REF_TYPE_EMBED . |
double |
getScale()
Returns the image scale. |
java.lang.String |
getSize()
Returns the image size. |
java.lang.String |
getSource()
Returns the image source type. |
java.lang.String |
getTypeExpression()
Returns the type expression of the image item if the image source type is IMAGE_REF_TYPE_EXPR . |
java.lang.String |
getURI()
Returns the image URI if the image source type is IMAGE_REF_TYPE_URL or IMAGE_REF_TYPE_FILE . |
java.lang.String |
getURL()
Gets the image url, if the source type is not IMAGE_REF_TYPE_URL return null. |
java.lang.String |
getValueExpression()
Returns the value expression of the image if the image source type is IMAGE_REF_TYPE_EXPR . |
void |
setAltText(java.lang.String altText)
Sets the alternate text of this image. |
void |
setAltTextKey(java.lang.String altTextKey)
Sets the resource key of the alternate text of this image. |
void |
setFile(java.lang.String file)
Sets the image file. |
void |
setHelpText(java.lang.String helpText)
Sets the help text of this image item. |
void |
setHelpTextKey(java.lang.String helpTextKey)
Sets the resource key of help text of this image item. |
void |
setImageName(java.lang.String name)
Sets the embedded image name that this image refers, if the image source type is IMAGE_REF_TYPE_EMBED . |
void |
setScale(double scale)
Sets the image scale property. |
void |
setSize(java.lang.String size)
Sets the image size property. |
void |
setSource(java.lang.String source)
Returns the image source type. |
void |
setTypeExpression(java.lang.String value)
Sets the type expression value. |
void |
setURI(java.lang.String uri)
Deprecated. Sets the image uri property. The source type is automatically set in this method. Whether IMAGE_REF_TYPE_FILE
or IMAGE_REF_TYPE_URL depends on the uri to
set. |
void |
setURL(java.lang.String url)
Sets the image url. |
void |
setValueExpression(java.lang.String value)
Sets the value expression value. |
Methods inherited from interface org.eclipse.birt.report.model.api.simpleapi.IReportItem |
---|
addDataBinding, addHideRule, addHighlightRule, getBookmark, getDataBinding, getDataBindings, getHeight, getHideRules, getHighlightRules, getTocExpression, getWidth, getX, getY, removeDataBinding, removeDataBindings, removeHideRule, removeHideRules, removeHighlightRule, removeHighlightRules, setBookmark, setCurrentView, setHeight, setHeight, setTocExpression, setWidth, setWidth, setX, setX, setY, setY |
Methods inherited from interface org.eclipse.birt.report.model.api.simpleapi.IReportElement |
---|
getComments, getCustomXml, getDisplayName, getDisplayNameKey, getName, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setName |
Methods inherited from interface org.eclipse.birt.report.model.api.simpleapi.IDesignElement |
---|
getNamedExpression, getParent, getQualifiedName, getReport, getStyle, getUserProperty, setNamedExpression, setUserProperty, setUserProperty |
Method Detail |
---|
double getScale()
java.lang.String getSize()
DesignChoiceConstants
:
IMAGE_SIZE_SIZE_TO_IMAGE
IMAGE_SIZE_SCALE_TO_ITEM
IMAGE_SIZE_CLIP
java.lang.String getAltText()
void setAltText(java.lang.String altText) throws SemanticException
altText
- the alternate text of the image item.
SemanticException
java.lang.String getAltTextKey()
void setAltTextKey(java.lang.String altTextKey) throws SemanticException
altTextKey
- the alternate text of the image item.
SemanticException
java.lang.String getSource()
DesignChoiceConstants
:
IMAGE_REF_TYPE_NONE
IMAGE_REF_TYPE_URL
IMAGE_REF_TYPE_FILE
IMAGE_REF_TYPE_EXPR
IMAGE_REF_TYPE_EMBED
void setSource(java.lang.String source) throws SemanticException
DesignChoiceConstants
:
IMAGE_REF_TYPE_NONE
IMAGE_REF_TYPE_URL
IMAGE_REF_TYPE_FILE
IMAGE_REF_TYPE_EXPR
IMAGE_REF_TYPE_EMBED
source
- the image source type.
SemanticException
- if the source
is not one of the above.java.lang.String getURI()
IMAGE_REF_TYPE_URL
or IMAGE_REF_TYPE_FILE
.
IMAGE_REF_TYPE_URL
or
IMAGE_REF_TYPE_FILE
. Otherwise, return
null
.java.lang.String getTypeExpression()
IMAGE_REF_TYPE_EXPR
.
IMAGE_REF_TYPE_EXPR
. Otherwise, return
null
.java.lang.String getValueExpression()
IMAGE_REF_TYPE_EXPR
.
IMAGE_REF_TYPE_EXPR
. Otherwise, return
null
.java.lang.String getImageName()
IMAGE_REF_TYPE_EMBED
. This is not the same
as DesignElementHandle.getName()
of this image item.
IMAGE_REF_TYPE_EMBED
. Otherwise, return
null
.void setImageName(java.lang.String name) throws SemanticException
IMAGE_REF_TYPE_EMBED
. The reference type is
automatically set in this method. This is not the same as
DesignElementHandle.setName( String )
.
name
- the embedded image name
SemanticException
- if the property is locked.void setURI(java.lang.String uri) throws SemanticException
IMAGE_REF_TYPE_FILE
or IMAGE_REF_TYPE_URL
depends on the uri to
set.
uri
- the uri to be set.
SemanticException
- if the property is locked.void setScale(double scale) throws SemanticException
scale
- the scale value to be set.
SemanticException
- if the property is locked.void setSize(java.lang.String size) throws SemanticException
DesignChoiceConstants
:
IMAGE_SIZE_SIZE_TO_IMAGE
IMAGE_SIZE_SCALE_TO_ITEM
IMAGE_SIZE_CLIP
size
- the size value to be set.
SemanticException
- if the input size is not one of the above, or if the property
is locked.void setTypeExpression(java.lang.String value) throws SemanticException
IMAGE_REF_TYPE_EXPR
.
value
- the type expression value.
SemanticException
- if the property is locked.void setValueExpression(java.lang.String value) throws SemanticException
IMAGE_REF_TYPE_EXPR
.
value
- the value expression.
SemanticException
- if the property is locked.IAction getAction()
null
if
the action has not been set on the image.ActionHandle
java.lang.String getHelpText()
void setHelpText(java.lang.String helpText) throws SemanticException
helpText
- the help text
SemanticException
- if the property is locked.java.lang.String getHelpTextKey()
void setHelpTextKey(java.lang.String helpTextKey) throws SemanticException
helpTextKey
- the help text
SemanticException
- if the property is locked.void setURL(java.lang.String url) throws SemanticException
IMAGE_REF_TYPE_URL
,
and will automatically set in this method.
url
-
SemanticException
java.lang.String getURL()
IMAGE_REF_TYPE_URL
return null.
void setFile(java.lang.String file) throws SemanticException
IMAGE_REF_TYPE_FILE
,
and will automatically set in this method.
file
-
SemanticException
java.lang.String getFile()
IMAGE_REF_TYPE_FILE
return null.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |