public interface IReportItem extends IReportElement
Modifier and Type | Field and Description |
---|---|
static org.eclipse.birt.report.model.api.simpleapi.ScriptConstants |
constants |
Modifier and Type | Method and Description |
---|---|
void |
addDataBinding(IDataBinding binding)
Add ComputedColumn.name , expression of IDataBinding are required.
|
void |
addHideRule(IHideRule rule)
Add HideRule
|
void |
addHighlightRule(IHighlightRule rule)
Adds high light rule.
|
java.lang.String |
getBookmark()
Returns the bookmark of the report item.
|
java.lang.String |
getDataBinding(java.lang.String bindingName)
Returns column binding.
|
IDataBinding[] |
getDataBindings()
Returns array of all column bindings
|
java.lang.String |
getHeight()
Gets the item's height.
|
IHideRule[] |
getHideRules()
Returns array of hide rule expression
|
IHighlightRule[] |
getHighlightRules()
Gets all high light rules.
|
java.lang.String |
getTocExpression()
Returns the expression evalueated as a table of contents entry for this
item.
|
java.lang.String |
getWidth()
Gets a the item's width.
|
java.lang.String |
getX()
Gets the item's x (horizontal) position.
|
java.lang.String |
getY()
Gets the item's y (vertical) position.
|
void |
removeDataBinding(java.lang.String bindingName)
Removes special column binding
|
void |
removeDataBindings()
Removes all column bindings
|
void |
removeHideRule(IHideRule rule)
Removes all hide rules that matches formatType.
|
void |
removeHideRules()
Removes all hide rules
|
void |
removeHighlightRule(IHighlightRule rule)
Removes high light rule.
|
void |
removeHighlightRules()
Removes all high light rules.
|
void |
setBookmark(java.lang.String value)
Sets the bookmark of the report item.
|
void |
setCurrentView(IDesignElement viewElement)
Sets the view to be used.
|
void |
setHeight(double dimension)
Sets the item's height to a value in default units.
|
void |
setHeight(java.lang.String dimension)
Sets the item's height using a dimension string with optional unit suffix
such as "10" or "10pt".
|
void |
setTocExpression(java.lang.String expression)
Sets a table of contents entry for this item.
|
void |
setWidth(double dimension)
Sets the item's width to a value in default units.
|
void |
setWidth(java.lang.String dimension)
Sets the item's width using a dimension string with optional unit suffix
such as "10" or "10pt".
|
void |
setX(double dimension)
Sets the item's x position to a value in default units.
|
void |
setX(java.lang.String dimension)
Sets the item's x position using a dimension string with optional unit
suffix such as "10" or "10pt".
|
void |
setY(double dimension)
Sets the item's y position to a value in default units.
|
void |
setY(java.lang.String dimension)
Sets the item's y position using a dimension string with optional unit
suffix such as "10" or "10pt".
|
getComments, getCustomXml, getDisplayName, getDisplayNameKey, getName, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setName
getNamedExpression, getParent, getQualifiedName, getReport, getStyle, getUserProperty, getUserPropertyExpression, setNamedExpression, setUserProperty, setUserProperty
static final org.eclipse.birt.report.model.api.simpleapi.ScriptConstants constants
java.lang.String getX()
java.lang.String getY()
void setX(java.lang.String dimension) throws ScriptException
dimension
- dimension string with optional unit suffix.ScriptException
- if the string is not validvoid setX(double dimension) throws ScriptException
dimension
- the new value in application units.ScriptException
- if the property is locked.void setY(java.lang.String dimension) throws ScriptException
dimension
- dimension string with optional unit suffix.ScriptException
- if the string is not validvoid setY(double dimension) throws ScriptException
dimension
- the new value in application units.ScriptException
- if the property is locked.void setHeight(java.lang.String dimension) throws ScriptException
dimension
- dimension string with optional unit suffix.ScriptException
- if the string is not validvoid setHeight(double dimension) throws ScriptException
dimension
- the new value in application units.ScriptException
- if the property is locked.void setWidth(java.lang.String dimension) throws ScriptException
dimension
- dimension string with optional unit suffix.ScriptException
- if the string is not validvoid setWidth(double dimension) throws ScriptException
dimension
- the new value in application units.ScriptException
- if the property is locked.java.lang.String getWidth()
java.lang.String getHeight()
java.lang.String getBookmark()
void setBookmark(java.lang.String value) throws ScriptException
value
- the bookmark expressionScriptException
- if the property is locked.void setTocExpression(java.lang.String expression) throws ScriptException
expression
- the expression that returns a stringScriptException
- if the TOC property is locked by the property mask.getTocExpression()
java.lang.String getTocExpression()
setTocExpression(String)
IDataBinding[] getDataBindings()
java.lang.String getDataBinding(java.lang.String bindingName)
bindingName
- void removeDataBinding(java.lang.String bindingName) throws ScriptException
bindingName
- ScriptException
void removeDataBindings() throws ScriptException
ScriptException
void addDataBinding(IDataBinding binding) throws ScriptException
binding
- ScriptException
IHighlightRule[] getHighlightRules()
void addHighlightRule(IHighlightRule rule) throws ScriptException
rule
- ScriptException
void removeHighlightRules() throws ScriptException
ScriptException
void removeHighlightRule(IHighlightRule rule) throws ScriptException
rule
- ScriptException
void removeHideRule(IHideRule rule) throws ScriptException
rule
- ScriptException
void removeHideRules() throws ScriptException
ScriptException
IHideRule[] getHideRules()
void addHideRule(IHideRule rule) throws ScriptException
rule
- ScriptException
void setCurrentView(IDesignElement viewElement) throws ScriptException
viewElement
- the view element, must not be this
. Can be
null
.ScriptException
- if the given element resides in the other elements.Copyright © 2008 Actuate Corp. All rights reserved.