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 TypeMethodDescriptionvoidaddDataBinding(IDataBinding binding) Add ComputedColumn.name , expression of IDataBinding are required.voidaddFilterCondition(IFilterCondition condition) Adds filter condition.expr of IFilterCondition is required.voidaddHideRule(IHideRule rule) Add HideRulevoidAdds high light rule.voidaddSortCondition(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.voidremoveDataBinding(String bindingName) Removes special column bindingvoidRemoves all column bindingsvoidremoveFilterCondition(IFilterCondition condition) Removes filter condition.voidRemoves filter condition.voidremoveHideRule(IHideRule rule) Removes all hide rules that matches formatType.voidRemoves all hide rulesvoidRemoves high light rule.voidRemoves all high light rules.voidremoveSortCondition(ISortCondition condition) Removes sort condition.voidRemoves all sort conditionsvoidsetBookmark(String value) Sets the bookmark of the report item.voidsetComments(String theComments) Sets the comments of the report element.voidsetCurrentView(IDesignElement viewElement) Sets the view to be used.voidsetCustomXml(String customXml) Sets the custom XML.voidsetDisplayName(String displayName) Sets the display name.voidsetDisplayNameKey(String displayNameKey) Sets the resource key of the display name.voidsetHeight(double dimension) Sets the item's height to a value in default units.voidSets the item's height using a dimension string with optional unit suffix such as "10" or "10pt".voidSets the name of this element.voidsetNamedExpression(String name, String exp) Sets name of user property defined in this element.voidsetTocExpression(String expression) Sets a table of contents entry for this item.voidsetUserProperty(String name, Object value, String type) Sets user property defined in this element.voidsetUserProperty(String name, String value) Sets user property defined in this element.voidsetWidth(double dimension) Sets the item's width to a value in default units.voidSets the item's width using a dimension string with optional unit suffix such as "10" or "10pt".voidsetX(double dimension) Sets the item's x position to a value in default units.voidSets the item's x position using a dimension string with optional unit suffix such as "10" or "10pt".voidsetY(double dimension) Sets the item's y position to a value in default units.voidSets 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:IMultiRowItemAdds filter condition.expr of IFilterCondition is required.- Specified by:
addFilterConditionin interfaceIMultiRowItem- Throws:
SemanticException
-
addSortCondition
Description copied from interface:IMultiRowItemAdds sort condition.key of ISortCondition is required.- Specified by:
addSortConditionin interfaceIMultiRowItem- Throws:
SemanticException
-
getFilterConditions
Description copied from interface:IMultiRowItemReturns all filter conditions- Specified by:
getFilterConditionsin interfaceIMultiRowItem- Returns:
- all filter conditions
-
getSortConditions
Description copied from interface:IMultiRowItemReturns all sort conditions.- Specified by:
getSortConditionsin interfaceIMultiRowItem- Returns:
- all sort conditions.
-
removeFilterCondition
Description copied from interface:IMultiRowItemRemoves filter condition.- Specified by:
removeFilterConditionin interfaceIMultiRowItem- Throws:
SemanticException
-
removeFilterConditions
Description copied from interface:IMultiRowItemRemoves filter condition.- Specified by:
removeFilterConditionsin interfaceIMultiRowItem- Throws:
SemanticException
-
removeSortCondition
Description copied from interface:IMultiRowItemRemoves sort condition.- Specified by:
removeSortConditionin interfaceIMultiRowItem- Throws:
SemanticException
-
removeSortConditions
Description copied from interface:IMultiRowItemRemoves all sort conditions- Specified by:
removeSortConditionsin interfaceIMultiRowItem- Throws:
SemanticException
-
addDataBinding
Description copied from interface:IReportItemAdd ComputedColumn.name , expression of IDataBinding are required.- Specified by:
addDataBindingin interfaceIReportItem- Throws:
SemanticException
-
addHideRule
Description copied from interface:IReportItemAdd HideRule- Specified by:
addHideRulein interfaceIReportItem- Throws:
SemanticException
-
addHighlightRule
Description copied from interface:IReportItemAdds high light rule.- Specified by:
addHighlightRulein interfaceIReportItem- Throws:
SemanticException
-
getBookmark
Description copied from interface:IReportItemReturns the bookmark of the report item. The bookmark value is evaluated as an expression.- Specified by:
getBookmarkin interfaceIReportItem- Returns:
- the book mark as a string
-
getDataBinding
Description copied from interface:IReportItemReturns column binding.- Specified by:
getDataBindingin interfaceIReportItem- Returns:
- column binding expression.
-
getDataBindings
Description copied from interface:IReportItemReturns array of all column bindings- Specified by:
getDataBindingsin interfaceIReportItem- Returns:
- all column bindings
-
getHeight
Description copied from interface:IReportItemGets the item's height.- Specified by:
getHeightin interfaceIReportItem- Returns:
- the item's height.
-
getHideRules
Description copied from interface:IReportItemReturns array of hide rule expression- Specified by:
getHideRulesin interfaceIReportItem- Returns:
- array of hide rule expression
-
getHighlightRules
Description copied from interface:IReportItemGets all high light rules.- Specified by:
getHighlightRulesin interfaceIReportItem- Returns:
- all high light rules
-
getTocExpression
Description copied from interface:IReportItemReturns the expression evalueated as a table of contents entry for this item.- Specified by:
getTocExpressionin interfaceIReportItem- Returns:
- the expression evaluated as a table of contents entry for this item
- See Also:
-
getWidth
Description copied from interface:IReportItemGets a the item's width.- Specified by:
getWidthin interfaceIReportItem- Returns:
- a the item's width.
-
getX
Description copied from interface:IReportItemGets the item's x (horizontal) position.- Specified by:
getXin interfaceIReportItem- Returns:
- The item's x position.
-
getY
Description copied from interface:IReportItemGets the item's y (vertical) position.- Specified by:
getYin interfaceIReportItem- Returns:
- The item's y position.
-
setX
Description copied from interface:IReportItemSets 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:
setXin interfaceIReportItem- Parameters:
dimension- the new value in application units.- Throws:
SemanticException- if the property is locked.
-
setX
Description copied from interface:IReportItemSets 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:
setXin interfaceIReportItem- Parameters:
dimension- dimension string with optional unit suffix.- Throws:
SemanticException- if the string is not valid
-
setY
Description copied from interface:IReportItemSets 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:
setYin interfaceIReportItem- Parameters:
dimension- the new value in application units.- Throws:
SemanticException- if the property is locked.
-
setY
Description copied from interface:IReportItemSets 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:
setYin interfaceIReportItem- Parameters:
dimension- dimension string with optional unit suffix.- Throws:
SemanticException- if the string is not valid
-
removeDataBinding
Description copied from interface:IReportItemRemoves special column binding- Specified by:
removeDataBindingin interfaceIReportItem- Throws:
SemanticException
-
removeDataBindings
Description copied from interface:IReportItemRemoves all column bindings- Specified by:
removeDataBindingsin interfaceIReportItem- Throws:
SemanticException
-
removeHideRule
Description copied from interface:IReportItemRemoves all hide rules that matches formatType.- Specified by:
removeHideRulein interfaceIReportItem- Throws:
SemanticException
-
removeHideRules
Description copied from interface:IReportItemRemoves all hide rules- Specified by:
removeHideRulesin interfaceIReportItem- Throws:
SemanticException
-
removeHighlightRule
Description copied from interface:IReportItemRemoves high light rule.- Specified by:
removeHighlightRulein interfaceIReportItem- Throws:
SemanticException
-
removeHighlightRules
Description copied from interface:IReportItemRemoves all high light rules.- Specified by:
removeHighlightRulesin interfaceIReportItem- Throws:
SemanticException
-
setBookmark
Description copied from interface:IReportItemSets 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:
setBookmarkin interfaceIReportItem- Parameters:
value- the bookmark expression- Throws:
SemanticException- if the property is locked.
-
setHeight
Description copied from interface:IReportItemSets 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:
setHeightin interfaceIReportItem- Parameters:
dimension- the new value in application units.- Throws:
SemanticException- if the property is locked.
-
setHeight
Description copied from interface:IReportItemSets 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:
setHeightin interfaceIReportItem- Parameters:
dimension- dimension string with optional unit suffix.- Throws:
SemanticException- if the string is not valid
-
setTocExpression
Description copied from interface:IReportItemSets 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:
setTocExpressionin 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:IReportItemSets 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:
setWidthin interfaceIReportItem- Parameters:
dimension- the new value in application units.- Throws:
SemanticException- if the property is locked.
-
setWidth
Description copied from interface:IReportItemSets 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:
setWidthin interfaceIReportItem- Parameters:
dimension- dimension string with optional unit suffix.- Throws:
SemanticException- if the string is not valid
-
getComments
Description copied from interface:IReportElementGets the comments of the report element.- Specified by:
getCommentsin interfaceIReportElement- Returns:
- the comments of the report element
-
getCustomXml
Description copied from interface:IReportElementGets the custom XML.- Specified by:
getCustomXmlin interfaceIReportElement- Returns:
- the custom XML
-
getDisplayName
Description copied from interface:IReportElementGets the display name.- Specified by:
getDisplayNamein interfaceIReportElement- Returns:
- the display name
-
getDisplayNameKey
Description copied from interface:IReportElementGets the resource key of the display name.- Specified by:
getDisplayNameKeyin interfaceIReportElement- Returns:
- the resource key of the display name
-
getName
Description copied from interface:IReportElementReturns the name of this element. Returnsnullif 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:
getNamein interfaceIReportElement- Returns:
- the element name, or null if the name is not set
-
setComments
Description copied from interface:IReportElementSets the comments of the report element.- Specified by:
setCommentsin 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:IReportElementSets the custom XML.- Specified by:
setCustomXmlin 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:IReportElementSets the display name.- Specified by:
setDisplayNamein 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:IReportElementSets the resource key of the display name.- Specified by:
setDisplayNameKeyin 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:IReportElementSets the name of this element. If the name isnull, then the name is cleared if this element does not require a name.- Specified by:
setNamein interfaceIReportElement- Parameters:
name- the new name- Throws:
SemanticException- if the name is duplicate, or if the name isnulland this element requires a name.
-
getNamedExpression
Description copied from interface:IDesignElementReturns name of user property defined in this element.- Specified by:
getNamedExpressionin interfaceIDesignElement- Returns:
- name of user property
-
getParent
Description copied from interface:IDesignElementReturn the parent of this element- Specified by:
getParentin interfaceIDesignElement- Returns:
- the parent
-
getQualifiedName
Description copied from interface:IDesignElementGets 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:
getQualifiedNamein interfaceIDesignElement- Returns:
- the qualified name of thie element.
-
getStyle
Description copied from interface:IDesignElementGets design element style.- Specified by:
getStylein interfaceIDesignElement- Returns:
- style
-
getUserProperty
Description copied from interface:IDesignElementReturns user property defined in this element.- Specified by:
getUserPropertyin interfaceIDesignElement- Returns:
- user property
-
setNamedExpression
Description copied from interface:IDesignElementSets name of user property defined in this element.- Specified by:
setNamedExpressionin interfaceIDesignElement- Parameters:
name- name of user propertyexp- name expression- Throws:
SemanticException
-
setUserProperty
Description copied from interface:IDesignElementSets user property defined in this element.- Specified by:
setUserPropertyin interfaceIDesignElement- Throws:
SemanticException
-
setUserProperty
Description copied from interface:IDesignElementSets user property defined in this element.- Specified by:
setUserPropertyin interfaceIDesignElement- Throws:
SemanticException
-
setCurrentView
Description copied from interface:IReportItemSets 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:
setCurrentViewin 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:IDesignElementGets the report.- Specified by:
getReportin 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:IDesignElementReturns user property as an expression defined in this element.- Specified by:
getUserPropertyExpressionin interfaceIDesignElement- Parameters:
name- the user property name- Returns:
- user property as an expression
-