Interface IRow
-
- All Superinterfaces:
IDesignElement
public interface IRow extends IDesignElement
Represents a row in the scripting environment
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddHideRule(IHideRule rule)Add HideRulevoidaddHighlightRule(IHighlightRule rule)Adds high light rule.java.lang.StringgetBookmark()Returns the bookmark of the row.java.lang.StringgetHeight()Gets a handle to deal with the row's height.IHideRule[]getHideRules()Returns array of hide rule expressionIHighlightRule[]getHighlightRules()Gets all high light rules.voidremoveHideRule(IHideRule rule)Removes all hide rules that matches formatType.voidremoveHideRules()Removes all hide rulesvoidremoveHighlightRule(IHighlightRule rule)Removes high light rule.voidremoveHighlightRules()Removes all high light rules.voidsetBookmark(java.lang.String value)Sets the bookmark of the row.-
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
-
getHeight
java.lang.String getHeight()
Gets a handle to deal with the row's height.- Returns:
- the row's height.
-
getBookmark
java.lang.String getBookmark()
Returns the bookmark of the row. The bookmark value is evaluated as an expression.- Returns:
- the book mark as a string
-
setBookmark
void setBookmark(java.lang.String value) throws ScriptExceptionSets the bookmark of the row. The bookmark value is evaluated as an expression. If you want the bookmark to be the string "bookmark", you need to use setBookmark("\"bookmark\""); If bookmark is a JavaScript variable, use setBookmark("bookmark");- Parameters:
value- the bookmark expression- Throws:
ScriptException- if the property is locked.
-
removeHideRule
void removeHideRule(IHideRule rule) throws ScriptException
Removes all hide rules that matches formatType.- Parameters:
rule-- Throws:
ScriptException
-
removeHideRules
void removeHideRules() throws ScriptExceptionRemoves all hide rules- Throws:
ScriptException
-
getHideRules
IHideRule[] getHideRules()
Returns array of hide rule expression- Returns:
- array of hide rule expression
-
addHideRule
void addHideRule(IHideRule rule) throws ScriptException
Add HideRule- Parameters:
rule-- Throws:
ScriptException
-
getHighlightRules
IHighlightRule[] getHighlightRules()
Gets all high light rules.- Returns:
- all high light rules
-
addHighlightRule
void addHighlightRule(IHighlightRule rule) throws ScriptException
Adds high light rule.- Parameters:
rule-- Throws:
ScriptException
-
removeHighlightRules
void removeHighlightRules() throws ScriptExceptionRemoves all high light rules.- Throws:
ScriptException
-
removeHighlightRule
void removeHighlightRule(IHighlightRule rule) throws ScriptException
Removes high light rule.- Parameters:
rule-- Throws:
ScriptException
-
-