Class MultiRowItem
java.lang.Object
org.eclipse.birt.report.model.api.extension.MultiRowItem
- All Implemented Interfaces:
IDesignElement
,IMultiRowItem
,IReportElement
,IReportItem
Implements of multi row report item. Used for extension multi row items. The
constructor in sub class must call super(ExtendedItemHandle).
-
Field Summary
Fields inherited from interface org.eclipse.birt.report.model.api.simpleapi.IReportItem
constants
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addDataBinding
(IDataBinding binding) Add ComputedColumn.name , expression of IDataBinding are required.void
addFilterCondition
(IFilterCondition condition) Adds filter condition.expr of IFilterCondition is required.void
addHideRule
(IHideRule rule) Add HideRulevoid
Adds high light rule.void
addSortCondition
(ISortCondition condition) Adds sort condition.key of ISortCondition is required.Returns the bookmark of the report item.Gets the comments of the report element.Gets the custom XML.getDataBinding
(String bindingName) Returns column binding.Returns array of all column bindingsGets the display name.Gets the resource key of the display name.Gets the corresponding extension item that is wrapped by theMultiRowItem
.Returns all filter conditionsGets the item's height.Returns array of hide rule expressionGets all high light rules.getName()
Returns the name of this element.getNamedExpression
(String name) Returns name of user property defined in this element.Return the parent of this elementGets the name of this element.Gets the report.Returns all sort conditions.getStyle()
Gets design element style.Returns the expression evalueated as a table of contents entry for this item.getUserProperty
(String name) Returns user property defined in this element.Returns user property as an expression defined in this element.getWidth()
Gets a the item's width.getX()
Gets the item's x (horizontal) position.getY()
Gets the item's y (vertical) position.void
removeDataBinding
(String bindingName) Removes special column bindingvoid
Removes all column bindingsvoid
removeFilterCondition
(IFilterCondition condition) Removes filter condition.void
Removes filter condition.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
removeSortCondition
(ISortCondition condition) Removes sort condition.void
Removes all sort conditionsvoid
setBookmark
(String value) Sets the bookmark of the report item.void
setComments
(String theComments) Sets the comments of the report element.void
setCurrentView
(IDesignElement viewElement) Sets the view to be used.void
setCustomXml
(String customXml) Sets the custom XML.void
setDisplayName
(String displayName) Sets the display name.void
setDisplayNameKey
(String displayNameKey) Sets the resource key of the display name.void
setHeight
(double dimension) Sets the item's height to a value in default units.void
Sets the item's height using a dimension string with optional unit suffix such as "10" or "10pt".void
Sets the name of this element.void
setNamedExpression
(String name, String exp) Sets name of user property defined in this element.void
setTocExpression
(String expression) Sets a table of contents entry for this item.void
setUserProperty
(String name, Object value, String type) Sets user property defined in this element.void
setUserProperty
(String name, String value) Sets user property defined in this element.void
setWidth
(double dimension) Sets the item's width to a value in default units.void
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
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
Sets the item's y position using a dimension string with optional unit suffix such as "10" or "10pt".
-
Constructor Details
-
MultiRowItem
Constructors.- Parameters:
item
-
-
-
Method Details
-
addFilterCondition
Description copied from interface:IMultiRowItem
Adds filter condition.expr of IFilterCondition is required.- Specified by:
addFilterCondition
in interfaceIMultiRowItem
- Throws:
SemanticException
-
addSortCondition
Description copied from interface:IMultiRowItem
Adds sort condition.key of ISortCondition is required.- Specified by:
addSortCondition
in interfaceIMultiRowItem
- Throws:
SemanticException
-
getFilterConditions
Description copied from interface:IMultiRowItem
Returns all filter conditions- Specified by:
getFilterConditions
in interfaceIMultiRowItem
- Returns:
- all filter conditions
-
getSortConditions
Description copied from interface:IMultiRowItem
Returns all sort conditions.- Specified by:
getSortConditions
in interfaceIMultiRowItem
- Returns:
- all sort conditions.
-
removeFilterCondition
Description copied from interface:IMultiRowItem
Removes filter condition.- Specified by:
removeFilterCondition
in interfaceIMultiRowItem
- Throws:
SemanticException
-
removeFilterConditions
Description copied from interface:IMultiRowItem
Removes filter condition.- Specified by:
removeFilterConditions
in interfaceIMultiRowItem
- Throws:
SemanticException
-
removeSortCondition
Description copied from interface:IMultiRowItem
Removes sort condition.- Specified by:
removeSortCondition
in interfaceIMultiRowItem
- Throws:
SemanticException
-
removeSortConditions
Description copied from interface:IMultiRowItem
Removes all sort conditions- Specified by:
removeSortConditions
in interfaceIMultiRowItem
- Throws:
SemanticException
-
addDataBinding
Description copied from interface:IReportItem
Add ComputedColumn.name , expression of IDataBinding are required.- Specified by:
addDataBinding
in interfaceIReportItem
- Throws:
SemanticException
-
addHideRule
Description copied from interface:IReportItem
Add HideRule- Specified by:
addHideRule
in interfaceIReportItem
- Throws:
SemanticException
-
addHighlightRule
Description copied from interface:IReportItem
Adds high light rule.- Specified by:
addHighlightRule
in interfaceIReportItem
- Throws:
SemanticException
-
getBookmark
Description copied from interface:IReportItem
Returns the bookmark of the report item. The bookmark value is evaluated as an expression.- Specified by:
getBookmark
in interfaceIReportItem
- Returns:
- the book mark as a string
-
getDataBinding
Description copied from interface:IReportItem
Returns column binding.- Specified by:
getDataBinding
in interfaceIReportItem
- Returns:
- column binding expression.
-
getDataBindings
Description copied from interface:IReportItem
Returns array of all column bindings- Specified by:
getDataBindings
in interfaceIReportItem
- Returns:
- all column bindings
-
getHeight
Description copied from interface:IReportItem
Gets the item's height.- Specified by:
getHeight
in interfaceIReportItem
- Returns:
- the item's height.
-
getHideRules
Description copied from interface:IReportItem
Returns array of hide rule expression- Specified by:
getHideRules
in interfaceIReportItem
- Returns:
- array of hide rule expression
-
getHighlightRules
Description copied from interface:IReportItem
Gets all high light rules.- Specified by:
getHighlightRules
in interfaceIReportItem
- Returns:
- all high light rules
-
getTocExpression
Description copied from interface:IReportItem
Returns the expression evalueated as a table of contents entry for this item.- Specified by:
getTocExpression
in interfaceIReportItem
- Returns:
- the expression evaluated as a table of contents entry for this item
- See Also:
-
getWidth
Description copied from interface:IReportItem
Gets a the item's width.- Specified by:
getWidth
in interfaceIReportItem
- Returns:
- a the item's width.
-
getX
Description copied from interface:IReportItem
Gets the item's x (horizontal) position.- Specified by:
getX
in interfaceIReportItem
- Returns:
- The item's x position.
-
getY
Description copied from interface:IReportItem
Gets the item's y (vertical) position.- Specified by:
getY
in interfaceIReportItem
- Returns:
- The item's y position.
-
setX
Description copied from interface:IReportItem
Sets the item's x position to a value in default units. The default unit may be defined by the property in BIRT or the application unit defined in the design session.- Specified by:
setX
in interfaceIReportItem
- Parameters:
dimension
- the new value in application units.- Throws:
SemanticException
- if the property is locked.
-
setX
Description copied from interface:IReportItem
Sets the item's x position using a dimension string with optional unit suffix such as "10" or "10pt". If no suffix is provided, then the units are assumed to be in the design's default units. Call this method to set a string typed in by the user.- Specified by:
setX
in interfaceIReportItem
- Parameters:
dimension
- dimension string with optional unit suffix.- Throws:
SemanticException
- if the string is not valid
-
setY
Description copied from interface:IReportItem
Sets the item's y position to a value in default units. The default unit may be defined by the property in BIRT or the application unit defined in the design session.- Specified by:
setY
in interfaceIReportItem
- Parameters:
dimension
- the new value in application units.- Throws:
SemanticException
- if the property is locked.
-
setY
Description copied from interface:IReportItem
Sets the item's y position using a dimension string with optional unit suffix such as "10" or "10pt". If no suffix is provided, then the units are assumed to be in the design's default units. Call this method to set a string typed in by the user.- Specified by:
setY
in interfaceIReportItem
- Parameters:
dimension
- dimension string with optional unit suffix.- Throws:
SemanticException
- if the string is not valid
-
removeDataBinding
Description copied from interface:IReportItem
Removes special column binding- Specified by:
removeDataBinding
in interfaceIReportItem
- Throws:
SemanticException
-
removeDataBindings
Description copied from interface:IReportItem
Removes all column bindings- Specified by:
removeDataBindings
in interfaceIReportItem
- Throws:
SemanticException
-
removeHideRule
Description copied from interface:IReportItem
Removes all hide rules that matches formatType.- Specified by:
removeHideRule
in interfaceIReportItem
- Throws:
SemanticException
-
removeHideRules
Description copied from interface:IReportItem
Removes all hide rules- Specified by:
removeHideRules
in interfaceIReportItem
- Throws:
SemanticException
-
removeHighlightRule
Description copied from interface:IReportItem
Removes high light rule.- Specified by:
removeHighlightRule
in interfaceIReportItem
- Throws:
SemanticException
-
removeHighlightRules
Description copied from interface:IReportItem
Removes all high light rules.- Specified by:
removeHighlightRules
in interfaceIReportItem
- Throws:
SemanticException
-
setBookmark
Description copied from interface:IReportItem
Sets the bookmark of the report item. 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");- Specified by:
setBookmark
in interfaceIReportItem
- Parameters:
value
- the bookmark expression- Throws:
SemanticException
- if the property is locked.
-
setHeight
Description copied from interface:IReportItem
Sets the item's height to a value in default units. The default unit may be defined by the property in BIRT or the application unit defined in the design session.- Specified by:
setHeight
in interfaceIReportItem
- Parameters:
dimension
- the new value in application units.- Throws:
SemanticException
- if the property is locked.
-
setHeight
Description copied from interface:IReportItem
Sets the item's height using a dimension string with optional unit suffix such as "10" or "10pt". If no suffix is provided, then the units are assumed to be in the design's default units. Call this method to set a string typed in by the user.- Specified by:
setHeight
in interfaceIReportItem
- Parameters:
dimension
- dimension string with optional unit suffix.- Throws:
SemanticException
- if the string is not valid
-
setTocExpression
Description copied from interface:IReportItem
Sets a table of contents entry for this item. The TOC property defines an expression that returns a string that is to appear in the Table of Contents for this item or its container.- Specified by:
setTocExpression
in interfaceIReportItem
- Parameters:
expression
- the expression that returns a string- Throws:
SemanticException
- if the TOC property is locked by the property mask.- See Also:
-
setWidth
Description copied from interface:IReportItem
Sets the item's width to a value in default units. The default unit may be defined by the property in BIRT or the application unit defined in the design session.- Specified by:
setWidth
in interfaceIReportItem
- Parameters:
dimension
- the new value in application units.- Throws:
SemanticException
- if the property is locked.
-
setWidth
Description copied from interface:IReportItem
Sets the item's width using a dimension string with optional unit suffix such as "10" or "10pt". If no suffix is provided, then the units are assumed to be in the design's default units. Call this method to set a string typed in by the user.- Specified by:
setWidth
in interfaceIReportItem
- Parameters:
dimension
- dimension string with optional unit suffix.- Throws:
SemanticException
- if the string is not valid
-
getComments
Description copied from interface:IReportElement
Gets the comments of the report element.- Specified by:
getComments
in interfaceIReportElement
- Returns:
- the comments of the report element
-
getCustomXml
Description copied from interface:IReportElement
Gets the custom XML.- Specified by:
getCustomXml
in interfaceIReportElement
- Returns:
- the custom XML
-
getDisplayName
Description copied from interface:IReportElement
Gets the display name.- Specified by:
getDisplayName
in interfaceIReportElement
- Returns:
- the display name
-
getDisplayNameKey
Description copied from interface:IReportElement
Gets the resource key of the display name.- Specified by:
getDisplayNameKey
in interfaceIReportElement
- Returns:
- the resource key of the display name
-
getName
Description copied from interface:IReportElement
Returns the name of this element. Returnsnull
if the element does not have a name. Many elements do not require a name. The name does not inherit. If this element does not have a name, it will not inherit the name of its parent element.- Specified by:
getName
in interfaceIReportElement
- Returns:
- the element name, or null if the name is not set
-
setComments
Description copied from interface:IReportElement
Sets the comments of the report element.- Specified by:
setComments
in interfaceIReportElement
- Parameters:
theComments
- the comments to set- Throws:
SemanticException
- if the comments property is locked or not defined on this element.
-
setCustomXml
Description copied from interface:IReportElement
Sets the custom XML.- Specified by:
setCustomXml
in interfaceIReportElement
- Parameters:
customXml
- the custom XML to set- Throws:
SemanticException
- if the custom XML is locked or not defined on this element.
-
setDisplayName
Description copied from interface:IReportElement
Sets the display name.- Specified by:
setDisplayName
in interfaceIReportElement
- Parameters:
displayName
- the display name- Throws:
SemanticException
- if the display name property is locked or not defined on this element.
-
setDisplayNameKey
Description copied from interface:IReportElement
Sets the resource key of the display name.- Specified by:
setDisplayNameKey
in interfaceIReportElement
- Parameters:
displayNameKey
- the resource key of the display name- Throws:
SemanticException
- if the display name resource-key property is locked or not defined on this element.
-
setName
Description copied from interface:IReportElement
Sets the name of this element. If the name isnull
, then the name is cleared if this element does not require a name.- Specified by:
setName
in interfaceIReportElement
- Parameters:
name
- the new name- Throws:
SemanticException
- if the name is duplicate, or if the name isnull
and this element requires a name.
-
getNamedExpression
Description copied from interface:IDesignElement
Returns name of user property defined in this element.- Specified by:
getNamedExpression
in interfaceIDesignElement
- Returns:
- name of user property
-
getParent
Description copied from interface:IDesignElement
Return the parent of this element- Specified by:
getParent
in interfaceIDesignElement
- Returns:
- the parent
-
getQualifiedName
Description copied from interface:IDesignElement
Gets the name of this element. The returned element name will be the same asgetName()
, plus the namespace of the module that the elment is contained, if any. If the element is existed in the current module,this method andgetName()
will return identical results.- Specified by:
getQualifiedName
in interfaceIDesignElement
- Returns:
- the qualified name of thie element.
-
getStyle
Description copied from interface:IDesignElement
Gets design element style.- Specified by:
getStyle
in interfaceIDesignElement
- Returns:
- style
-
getUserProperty
Description copied from interface:IDesignElement
Returns user property defined in this element.- Specified by:
getUserProperty
in interfaceIDesignElement
- Returns:
- user property
-
setNamedExpression
Description copied from interface:IDesignElement
Sets name of user property defined in this element.- Specified by:
setNamedExpression
in interfaceIDesignElement
- Parameters:
name
- name of user propertyexp
- name expression- Throws:
SemanticException
-
setUserProperty
Description copied from interface:IDesignElement
Sets user property defined in this element.- Specified by:
setUserProperty
in interfaceIDesignElement
- Throws:
SemanticException
-
setUserProperty
Description copied from interface:IDesignElement
Sets user property defined in this element.- Specified by:
setUserProperty
in interfaceIDesignElement
- Throws:
SemanticException
-
setCurrentView
Description copied from interface:IReportItem
Sets the view to be used. If the given element is not in the multiple view, it will be added and set as the active view.- Specified by:
setCurrentView
in interfaceIReportItem
- Parameters:
viewElement
- the view element, must not bethis
. Can benull
.- Throws:
SemanticException
- if the given element resides in the other elements.
-
getReport
Description copied from interface:IDesignElement
Gets the report.- Specified by:
getReport
in interfaceIDesignElement
- Returns:
- the report
-
getExtensionElement
Gets the corresponding extension item that is wrapped by theMultiRowItem
.- Returns:
- the corresponding extension item in
simpleapi.IReportItem
-
getUserPropertyExpression
Description copied from interface:IDesignElement
Returns user property as an expression defined in this element.- Specified by:
getUserPropertyExpression
in interfaceIDesignElement
- Parameters:
name
- the user property name- Returns:
- user property as an expression
-