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

All Superinterfaces:
IDesignElement, IReportElement, IReportItem

public interface IDataItem
extends IReportItem

Represents a the design of a DataItem 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 getHelpText()
          Returns the help text of this data item.
 java.lang.String getHelpTextKey()
          Returns the help text resource key of this data item.
 java.lang.String getValueExpr()
          Returns the expression that gives the value that the data item displays.
 void setHelpText(java.lang.String value)
          Sets the help text of this data item.
 void setHelpTextKey(java.lang.String value)
          Sets the resource key of the help text of this data item.
 void setValueExpr(java.lang.String expr)
          Sets the expression for the value that the data item is to display.
 
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

getAction

public IAction getAction()
Returns a handle to work with the action property, action is a structure that defines a hyperlink.

Returns:
a handle to the action property, return null if the action has not been set on the data item.
See Also:
ActionHandle

getValueExpr

public java.lang.String getValueExpr()
Returns the expression that gives the value that the data item displays.

Returns:
the value expression

setValueExpr

public void setValueExpr(java.lang.String expr)
                  throws ScriptException
Sets the expression for the value that the data item is to display.

Parameters:
expr - the expression to set
Throws:
ScriptException - If the property is locked.

getHelpText

public java.lang.String getHelpText()
Returns the help text of this data item.

Returns:
the help text

setHelpText

public void setHelpText(java.lang.String value)
                 throws ScriptException
Sets the help text of this data item.

Parameters:
value - the help text
Throws:
ScriptException - if the property is locked.

getHelpTextKey

public java.lang.String getHelpTextKey()
Returns the help text resource key of this data item.

Returns:
the help text key

setHelpTextKey

public void setHelpTextKey(java.lang.String value)
                    throws ScriptException
Sets the resource key of the help text of this data item.

Parameters:
value - the resource key of the help text
Throws:
ScriptException - if the property is locked.


Copyright © 2005 Actuate Corp. All rights reserved.