|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IDataItem
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 | |
---|---|
void |
addAction(IAction action)
Adds the action structure to this data item. |
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 |
getResultSetColumn()
Gets the value of the result set column name property on this data item. |
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 |
setResultSetColumn(java.lang.String columnName)
Sets the value of the column name property. |
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 |
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.IDesignElement |
---|
getNamedExpression, getParent, getQualifiedName, getReport, getStyle, getUserProperty, getUserPropertyExpression, setNamedExpression, setUserProperty, setUserProperty |
Method Detail |
---|
IAction getAction()
null
if
the action has not been set on the data item.ActionHandle
java.lang.String getHelpText()
void setHelpText(java.lang.String value) throws ScriptException
value
- the help text
ScriptException
- if the property is locked.java.lang.String getHelpTextKey()
void setHelpTextKey(java.lang.String value) throws ScriptException
value
- the resource key of the help text
ScriptException
- if the property is locked.void addAction(IAction action)
action
- action structurejava.lang.String getResultSetColumn()
void setResultSetColumn(java.lang.String columnName) throws ScriptException
columnName
- the value to set.
ScriptException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |