Interface IRow
- All Superinterfaces:
IDesignElement
Represents a row in the scripting environment
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addHideRule
(IHideRule rule) Add HideRulevoid
Adds high light rule.Returns the bookmark of the row.Gets a handle to deal with the row's height.Returns array of hide rule expressionGets all high light rules.void
removeHideRule
(IHideRule rule) Removes all hide rules that matches formatType.void
Removes all hide rulesvoid
Removes high light rule.void
Removes all high light rules.void
setBookmark
(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 Details
-
getHeight
String getHeight()Gets a handle to deal with the row's height.- Returns:
- the row's height.
-
getBookmark
String getBookmark()Returns the bookmark of the row. The bookmark value is evaluated as an expression.- Returns:
- the book mark as a string
-
setBookmark
Sets 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
Removes all hide rules that matches formatType.- Parameters:
rule
-- Throws:
ScriptException
-
removeHideRules
Removes all hide rules- Throws:
ScriptException
-
getHideRules
IHideRule[] getHideRules()Returns array of hide rule expression- Returns:
- array of hide rule expression
-
addHideRule
Add HideRule- Parameters:
rule
-- Throws:
ScriptException
-
getHighlightRules
IHighlightRule[] getHighlightRules()Gets all high light rules.- Returns:
- all high light rules
-
addHighlightRule
Adds high light rule.- Parameters:
rule
-- Throws:
ScriptException
-
removeHighlightRules
Removes all high light rules.- Throws:
ScriptException
-
removeHighlightRule
Removes high light rule.- Parameters:
rule
-- Throws:
ScriptException
-