Class SimpleRowItem
- java.lang.Object
-
- org.eclipse.birt.report.model.api.extension.SimpleRowItem
-
- All Implemented Interfaces:
IDesignElement,IReportElement,IReportItem
public class SimpleRowItem extends java.lang.Object implements IReportItem
Implements of simple item that has no data rows.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 Constructor Description SimpleRowItem(ExtendedItemHandle item)Constructors.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddDataBinding(IDataBinding binding)Add ComputedColumn.name , expression of IDataBinding are required.voidaddHideRule(IHideRule rule)Add HideRulevoidaddHighlightRule(IHighlightRule rule)Adds high light rule.java.lang.StringgetBookmark()Returns the bookmark of the report item.java.lang.StringgetComments()Gets the comments of the report element.java.lang.StringgetCustomXml()Gets the custom XML.java.lang.StringgetDataBinding(java.lang.String bindingName)Returns column binding.IDataBinding[]getDataBindings()Returns array of all column bindingsjava.lang.StringgetDisplayName()Gets the display name.java.lang.StringgetDisplayNameKey()Gets the resource key of the display name.java.lang.StringgetHeight()Gets the item's height.IHideRule[]getHideRules()Returns array of hide rule expressionIHighlightRule[]getHighlightRules()Gets all high light rules.java.lang.StringgetName()Returns the name of this element.java.lang.StringgetNamedExpression(java.lang.String name)Returns name of user property defined in this element.IDesignElementgetParent()Return the parent of this elementjava.lang.StringgetQualifiedName()Gets the name of this element.IReportDesigngetReport()Gets the report.IStylegetStyle()Gets design element style.java.lang.StringgetTocExpression()Returns the expression evalueated as a table of contents entry for this item.java.lang.ObjectgetUserProperty(java.lang.String name)Returns user property defined in this element.java.lang.ObjectgetUserPropertyExpression(java.lang.String name)Returns user property as an expression defined in this element.java.lang.StringgetWidth()Gets a the item's width.java.lang.StringgetX()Gets the item's x (horizontal) position.java.lang.StringgetY()Gets the item's y (vertical) position.voidremoveDataBinding(java.lang.String bindingName)Removes special column bindingvoidremoveDataBindings()Removes all column bindingsvoidremoveHideRule(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 report item.voidsetComments(java.lang.String theComments)Sets the comments of the report element.voidsetCurrentView(IDesignElement viewElement)Sets the view to be used.voidsetCustomXml(java.lang.String customXml)Sets the custom XML.voidsetDisplayName(java.lang.String displayName)Sets the display name.voidsetDisplayNameKey(java.lang.String displayNameKey)Sets the resource key of the display name.voidsetHeight(double dimension)Sets the item's height to a value in default units.voidsetHeight(java.lang.String dimension)Sets the item's height using a dimension string with optional unit suffix such as "10" or "10pt".voidsetName(java.lang.String name)Sets the name of this element.voidsetNamedExpression(java.lang.String name, java.lang.String exp)Sets name of user property defined in this element.voidsetTocExpression(java.lang.String expression)Sets a table of contents entry for this item.voidsetUserProperty(java.lang.String name, java.lang.Object value, java.lang.String type)Sets user property defined in this element.voidsetUserProperty(java.lang.String name, java.lang.String value)Sets user property defined in this element.voidsetWidth(double dimension)Sets the item's width to a value in default units.voidsetWidth(java.lang.String dimension)Sets 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.voidsetX(java.lang.String dimension)Sets 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.voidsetY(java.lang.String dimension)Sets the item's y position using a dimension string with optional unit suffix such as "10" or "10pt".
-
-
-
Constructor Detail
-
SimpleRowItem
public SimpleRowItem(ExtendedItemHandle item)
Constructors.- Parameters:
item-
-
-
Method Detail
-
addDataBinding
public void addDataBinding(IDataBinding binding) throws SemanticException
Description copied from interface:IReportItemAdd ComputedColumn.name , expression of IDataBinding are required.- Specified by:
addDataBindingin interfaceIReportItem- Throws:
SemanticException
-
addHideRule
public void addHideRule(IHideRule rule) throws SemanticException
Description copied from interface:IReportItemAdd HideRule- Specified by:
addHideRulein interfaceIReportItem- Throws:
SemanticException
-
addHighlightRule
public void addHighlightRule(IHighlightRule rule) throws SemanticException
Description copied from interface:IReportItemAdds high light rule.- Specified by:
addHighlightRulein interfaceIReportItem- Throws:
SemanticException
-
getBookmark
public java.lang.String 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
public java.lang.String getDataBinding(java.lang.String bindingName)
Description copied from interface:IReportItemReturns column binding.- Specified by:
getDataBindingin interfaceIReportItem- Returns:
- column binding expression.
-
getDataBindings
public IDataBinding[] getDataBindings()
Description copied from interface:IReportItemReturns array of all column bindings- Specified by:
getDataBindingsin interfaceIReportItem- Returns:
- all column bindings
-
getHeight
public java.lang.String getHeight()
Description copied from interface:IReportItemGets the item's height.- Specified by:
getHeightin interfaceIReportItem- Returns:
- the item's height.
-
getHideRules
public IHideRule[] getHideRules()
Description copied from interface:IReportItemReturns array of hide rule expression- Specified by:
getHideRulesin interfaceIReportItem- Returns:
- array of hide rule expression
-
getHighlightRules
public IHighlightRule[] getHighlightRules()
Description copied from interface:IReportItemGets all high light rules.- Specified by:
getHighlightRulesin interfaceIReportItem- Returns:
- all high light rules
-
getTocExpression
public java.lang.String 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:
IReportItem.setTocExpression(String)
-
getWidth
public java.lang.String getWidth()
Description copied from interface:IReportItemGets a the item's width.- Specified by:
getWidthin interfaceIReportItem- Returns:
- a the item's width.
-
getX
public java.lang.String getX()
Description copied from interface:IReportItemGets the item's x (horizontal) position.- Specified by:
getXin interfaceIReportItem- Returns:
- The item's x position.
-
getY
public java.lang.String getY()
Description copied from interface:IReportItemGets the item's y (vertical) position.- Specified by:
getYin interfaceIReportItem- Returns:
- The item's y position.
-
removeDataBinding
public void removeDataBinding(java.lang.String bindingName) throws SemanticExceptionDescription copied from interface:IReportItemRemoves special column binding- Specified by:
removeDataBindingin interfaceIReportItem- Throws:
SemanticException
-
removeDataBindings
public void removeDataBindings() throws SemanticExceptionDescription copied from interface:IReportItemRemoves all column bindings- Specified by:
removeDataBindingsin interfaceIReportItem- Throws:
SemanticException
-
removeHideRule
public void removeHideRule(IHideRule rule) throws SemanticException
Description copied from interface:IReportItemRemoves all hide rules that matches formatType.- Specified by:
removeHideRulein interfaceIReportItem- Throws:
SemanticException
-
removeHideRules
public void removeHideRules() throws SemanticExceptionDescription copied from interface:IReportItemRemoves all hide rules- Specified by:
removeHideRulesin interfaceIReportItem- Throws:
SemanticException
-
removeHighlightRule
public void removeHighlightRule(IHighlightRule rule) throws SemanticException
Description copied from interface:IReportItemRemoves high light rule.- Specified by:
removeHighlightRulein interfaceIReportItem- Throws:
SemanticException
-
removeHighlightRules
public void removeHighlightRules() throws SemanticExceptionDescription copied from interface:IReportItemRemoves all high light rules.- Specified by:
removeHighlightRulesin interfaceIReportItem- Throws:
SemanticException
-
setBookmark
public void setBookmark(java.lang.String value) throws SemanticExceptionDescription 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
public void setHeight(double dimension) throws SemanticExceptionDescription 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
public void setHeight(java.lang.String dimension) throws SemanticExceptionDescription 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
public void setTocExpression(java.lang.String expression) throws SemanticExceptionDescription 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:
IReportItem.getTocExpression()
-
setWidth
public void setWidth(double dimension) throws SemanticExceptionDescription 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
public void setWidth(java.lang.String dimension) throws SemanticExceptionDescription 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
-
setX
public void setX(double dimension) throws SemanticExceptionDescription 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
public void setX(java.lang.String dimension) throws SemanticExceptionDescription 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
public void setY(double dimension) throws SemanticExceptionDescription 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
public void setY(java.lang.String dimension) throws SemanticExceptionDescription 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
-
getComments
public java.lang.String getComments()
Description copied from interface:IReportElementGets the comments of the report element.- Specified by:
getCommentsin interfaceIReportElement- Returns:
- the comments of the report element
-
getCustomXml
public java.lang.String getCustomXml()
Description copied from interface:IReportElementGets the custom XML.- Specified by:
getCustomXmlin interfaceIReportElement- Returns:
- the custom XML
-
getDisplayName
public java.lang.String getDisplayName()
Description copied from interface:IReportElementGets the display name.- Specified by:
getDisplayNamein interfaceIReportElement- Returns:
- the display name
-
getDisplayNameKey
public java.lang.String 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
public java.lang.String 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
public void setComments(java.lang.String theComments) throws SemanticExceptionDescription 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
public void setCustomXml(java.lang.String customXml) throws SemanticExceptionDescription 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
public void setDisplayName(java.lang.String displayName) throws SemanticExceptionDescription 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
public void setDisplayNameKey(java.lang.String displayNameKey) throws SemanticExceptionDescription 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
public void setName(java.lang.String name) throws SemanticExceptionDescription 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
public java.lang.String getNamedExpression(java.lang.String name)
Description copied from interface:IDesignElementReturns name of user property defined in this element.- Specified by:
getNamedExpressionin interfaceIDesignElement- Returns:
- name of user property
-
getParent
public IDesignElement getParent()
Description copied from interface:IDesignElementReturn the parent of this element- Specified by:
getParentin interfaceIDesignElement- Returns:
- the parent
-
getQualifiedName
public java.lang.String 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
public IStyle getStyle()
Description copied from interface:IDesignElementGets design element style.- Specified by:
getStylein interfaceIDesignElement- Returns:
- style
-
getUserProperty
public java.lang.Object getUserProperty(java.lang.String name)
Description copied from interface:IDesignElementReturns user property defined in this element.- Specified by:
getUserPropertyin interfaceIDesignElement- Returns:
- user property
-
setNamedExpression
public void setNamedExpression(java.lang.String name, java.lang.String exp) throws SemanticExceptionDescription 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
public void setUserProperty(java.lang.String name, java.lang.Object value, java.lang.String type) throws SemanticExceptionDescription copied from interface:IDesignElementSets user property defined in this element.- Specified by:
setUserPropertyin interfaceIDesignElement- Throws:
SemanticException
-
setUserProperty
public void setUserProperty(java.lang.String name, java.lang.String value) throws SemanticExceptionDescription copied from interface:IDesignElementSets user property defined in this element.- Specified by:
setUserPropertyin interfaceIDesignElement- Throws:
SemanticException
-
setCurrentView
public void setCurrentView(IDesignElement viewElement) throws SemanticException
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
public IReportDesign getReport()
Description copied from interface:IDesignElementGets the report.- Specified by:
getReportin interfaceIDesignElement- Returns:
- the report
-
getUserPropertyExpression
public java.lang.Object getUserPropertyExpression(java.lang.String name)
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
-
-