|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Represents a the design of a report item in the scripting environment
Method Summary | |
java.lang.String |
getBookmark()
Returns the bookmark of the report item. |
java.lang.String |
getColumnBinding(java.lang.String bindingName)
Returns column binding. |
IDataBinding[] |
getColumnBindings()
Returns array of all column bindings |
java.lang.String |
getHeight()
Gets the item's height. |
java.lang.String[] |
getHideRuleExpression(java.lang.String formatType)
Returns array of hide rule expression |
IHighLightRule[] |
getHighLightRule()
Returns all highlightrule |
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 |
removeColumnBinding(java.lang.String bindingName)
Removes special column binding |
void |
removeHideRule(java.lang.String formatType)
Removes all hide rules that matches formatType. |
void |
setBookmark(java.lang.String value)
Sets the bookmark of the report item. |
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". |
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 |
public java.lang.String getX()
public java.lang.String getY()
public void setX(java.lang.String dimension) throws ScriptException
dimension
- dimension string with optional unit suffix.
ScriptException
- if the string is not validpublic void setX(double dimension) throws ScriptException
dimension
- the new value in application units.
ScriptException
- if the property is locked.public void setY(java.lang.String dimension) throws ScriptException
dimension
- dimension string with optional unit suffix.
ScriptException
- if the string is not validpublic void setY(double dimension) throws ScriptException
dimension
- the new value in application units.
ScriptException
- if the property is locked.public void setHeight(java.lang.String dimension) throws ScriptException
dimension
- dimension string with optional unit suffix.
ScriptException
- if the string is not validpublic void setHeight(double dimension) throws ScriptException
dimension
- the new value in application units.
ScriptException
- if the property is locked.public void setWidth(java.lang.String dimension) throws ScriptException
dimension
- dimension string with optional unit suffix.
ScriptException
- if the string is not validpublic void setWidth(double dimension) throws ScriptException
dimension
- the new value in application units.
ScriptException
- if the property is locked.public java.lang.String getWidth()
public java.lang.String getHeight()
public java.lang.String getBookmark()
public void setBookmark(java.lang.String value) throws ScriptException
value
- the bookmark expression
ScriptException
- if the property is locked.public void setTocExpression(java.lang.String expression) throws ScriptException
expression
- the expression that returns a string
ScriptException
- if the TOC property is locked by the property mask.getTocExpression()
public java.lang.String getTocExpression()
setTocExpression(String)
public IDataBinding[] getColumnBindings()
public java.lang.String getColumnBinding(java.lang.String bindingName)
bindingName
-
public void removeColumnBinding(java.lang.String bindingName) throws ScriptException
bindingName
-
ScriptException
public IHighLightRule[] getHighLightRule()
public void removeHideRule(java.lang.String formatType) throws ScriptException
formatType
-
ScriptException
public java.lang.String[] getHideRuleExpression(java.lang.String formatType)
formatType
-
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |