Interface IDataItem
- All Superinterfaces:
IDesignElement
,IReportElement
,IReportItem
Represents a the design of a DataItem in the scripting environment
-
Field Summary
Fields inherited from interface org.eclipse.birt.report.engine.api.script.element.IReportItem
constants
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds the action structure to this data item.Returns a handle to work with the action property, action is a structure that defines a hyperlink.Returns the help text of this data item.Returns the help text resource key of this data item.Gets the value of the result set column name property on this data item.void
setHelpText
(String value) Sets the help text of this data item.void
setHelpTextKey
(String value) Sets the resource key of the help text of this data item.void
setResultSetColumn
(String columnName) Sets the value of the column name property.Methods inherited from interface org.eclipse.birt.report.engine.api.script.element.IDesignElement
getNamedExpression, getParent, getQualifiedName, getReport, getStyle, getUserProperty, getUserPropertyExpression, setNamedExpression, setUserProperty, setUserProperty
Methods inherited from interface org.eclipse.birt.report.engine.api.script.element.IReportElement
getComments, getCustomXml, getDisplayName, getDisplayNameKey, getName, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setName
Methods inherited from interface org.eclipse.birt.report.engine.api.script.element.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
-
Method Details
-
getAction
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
-
getHelpText
String getHelpText()Returns the help text of this data item.- Returns:
- the help text
-
setHelpText
Sets the help text of this data item.- Parameters:
value
- the help text- Throws:
ScriptException
- if the property is locked.
-
getHelpTextKey
String getHelpTextKey()Returns the help text resource key of this data item.- Returns:
- the help text key
-
setHelpTextKey
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.
-
addAction
Adds the action structure to this data item.- Parameters:
action
- action structure
-
getResultSetColumn
String getResultSetColumn()Gets the value of the result set column name property on this data item.- Returns:
- the value of the property.
-
setResultSetColumn
Sets the value of the column name property.- Parameters:
columnName
- the value to set.- Throws:
ScriptException
-