org.eclipse.birt.report.engine.api.script.element
Interface IDynamicText

All Superinterfaces:
IDesignElement, IReportElement, IReportItem

public interface IDynamicText
extends IReportItem

Represents a the design of a multi line text item in the scripting environment


Method Summary
 java.lang.String getContentType()
          Returns the expression that that defines the type of text the multi-line data item holds.
 java.lang.String getValueExpr()
          Returns the expression that gives the text that the multi-line data item displays.
 void setContentType(java.lang.String contentType)
          Sets the expression that defines the text type this multi-line data item holds.
 void setValueExpr(java.lang.String expr)
          Sets the expression that gives the text that this multi-line data item displays.
 
Methods inherited from interface org.eclipse.birt.report.engine.api.script.element.IReportItem
getBookmark, getHeight, getTocExpression, getWidth, getX, getY, setBookmark, setHeight, setHeight, setTocExpression, setWidth, setWidth, setX, setX, setY, setY
 
Methods inherited from interface org.eclipse.birt.report.engine.api.script.element.IReportElement
getComments, getCustomXml, getDisplayName, getDisplayNameKey, setComments, setCustomXml, setDisplayName, setDisplayNameKey
 
Methods inherited from interface org.eclipse.birt.report.engine.api.script.element.IDesignElement
getName, getNamedExpression, getParent, getQualifiedName, getStyle, getUserProperty, setName, setNamedExpression, setUserProperty, setUserProperty
 

Method Detail

getValueExpr

public java.lang.String getValueExpr()
Returns the expression that gives the text that the multi-line data item displays.

Returns:
the value expression

setValueExpr

public void setValueExpr(java.lang.String expr)
                  throws ScriptException
Sets the expression that gives the text that this multi-line data item displays.

Parameters:
expr - the new expression for the value expression
Throws:
ScriptException - if the expression contains errors, or the property is locked.

getContentType

public java.lang.String getContentType()
Returns the expression that that defines the type of text the multi-line data item holds. The content type can be one of:

Returns:
the text type

setContentType

public void setContentType(java.lang.String contentType)
                    throws ScriptException
Sets the expression that defines the text type this multi-line data item holds. The content type can be one of

Parameters:
contentType - the new text type
Throws:
ScriptException - if the property is locked or the contentType is not one of the above.


Copyright © 2005 Actuate Corp. All rights reserved.