Interface IListing
- All Superinterfaces:
IDesignElement
,IReportElement
,IReportItem
Represents the design of an Listing in the scripting environment
-
Field Summary
Fields inherited from interface org.eclipse.birt.report.engine.api.script.element.IReportItem
constants
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addFilterCondition
(IFilterCondition condition) Adds filter condition.expr of IFilterCondition is required.void
addSortCondition
(ISortCondition condition) Adds sort condition.key of ISortCondition is required.Returns all filter conditionsReturns all sort conditions.void
removeFilterCondition
(IFilterCondition condition) Removes filter condition.void
Removes filter condition.void
removeSortCondition
(ISortCondition condition) Removes sort condition.void
Removes all sort conditionsMethods inherited from interface org.eclipse.birt.report.engine.api.script.element.IDesignElement
getNamedExpression, getParent, getQualifiedName, getReport, getStyle, getUserProperty, getUserPropertyExpression, setNamedExpression, setUserProperty, setUserProperty
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.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
-
Method Details
-
getFilterConditions
IFilterCondition[] getFilterConditions()Returns all filter conditions- Returns:
- all filter conditions
-
addFilterCondition
Adds filter condition.expr of IFilterCondition is required.- Parameters:
condition
-- Throws:
ScriptException
-
removeFilterConditions
Removes filter condition.- Throws:
ScriptException
-
removeFilterCondition
Removes filter condition.- Parameters:
condition
-- Throws:
ScriptException
-
getSortConditions
ISortCondition[] getSortConditions()Returns all sort conditions.- Returns:
- all sort conditions.
-
addSortCondition
Adds sort condition.key of ISortCondition is required.- Parameters:
condition
-- Throws:
ScriptException
-
removeSortConditions
Removes all sort conditions- Throws:
ScriptException
-
removeSortCondition
Removes sort condition.- Parameters:
condition
-- Throws:
ScriptException
-