|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.model.api.extension.MultiRowItem
public class MultiRowItem
Implements of multi row report item. Used for extension multi row items. The constructor in sub class must call super(ExtendedItemHandle).
Constructor Summary | |
---|---|
MultiRowItem(ExtendedItemHandle item)
Constructors. |
Method Summary | |
---|---|
void |
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 HideRule |
void |
addHighlightRule(IHighlightRule rule)
Adds high light rule. |
void |
addSortCondition(ISortCondition condition)
Adds sort condition.key of ISortCondition is required. |
java.lang.String |
getBookmark()
Returns the bookmark of the report item. |
java.lang.String |
getComments()
Gets the comments of the report element. |
java.lang.String |
getCustomXml()
Gets the custom XML. |
java.lang.String |
getDataBinding(java.lang.String bindingName)
Returns column binding. |
IDataBinding[] |
getDataBindings()
Returns array of all column bindings |
java.lang.String |
getDisplayName()
Gets the display name. |
java.lang.String |
getDisplayNameKey()
Gets the resource key of the display name. |
IReportItem |
getExtensionElement()
Gets the corresponding extension item that is wrapped by the MultiRowItem . |
IFilterCondition[] |
getFilterConditions()
Returns all filter conditions |
java.lang.String |
getHeight()
Gets the item's height. |
IHideRule[] |
getHideRules()
Returns array of hide rule expression |
IHighlightRule[] |
getHighlightRules()
Gets all high light rules. |
java.lang.String |
getName()
Returns the name of this element. |
java.lang.String |
getNamedExpression(java.lang.String name)
Returns name of user property defined in this element. |
IDesignElement |
getParent()
Return the parent of this element |
java.lang.String |
getQualifiedName()
Gets the name of this element. |
IReportDesign |
getReport()
Gets the report. |
ISortCondition[] |
getSortConditions()
Returns all sort conditions. |
IStyle |
getStyle()
Gets design element style. |
java.lang.String |
getTocExpression()
Returns the expression evalueated as a table of contents entry for this item. |
java.lang.Object |
getUserProperty(java.lang.String name)
Returns user property defined in this element. |
java.lang.String |
getWidth()
Gets a the item's width. |
java.lang.String |
getX()
Gets the item's x (horizontal) position. |
java.lang.String |
getY()
Gets the item's y (vertical) position. |
void |
removeDataBinding(java.lang.String bindingName)
Removes special column binding |
void |
removeDataBindings()
Removes all column bindings |
void |
removeFilterCondition(IFilterCondition condition)
Removes filter condition. |
void |
removeFilterConditions()
Removes filter condition. |
void |
removeHideRule(IHideRule rule)
Removes all hide rules that matches formatType. |
void |
removeHideRules()
Removes all hide rules |
void |
removeHighlightRule(IHighlightRule rule)
Removes high light rule. |
void |
removeHighlightRules()
Removes all high light rules. |
void |
removeSortCondition(ISortCondition condition)
Removes sort condition. |
void |
removeSortConditions()
Removes all sort conditions |
void |
setBookmark(java.lang.String value)
Sets the bookmark of the report item. |
void |
setComments(java.lang.String theComments)
Sets the comments of the report element. |
void |
setCurrentView(IDesignElement viewElement)
Sets the view to be used. |
void |
setCustomXml(java.lang.String customXml)
Sets the custom XML. |
void |
setDisplayName(java.lang.String displayName)
Sets the display name. |
void |
setDisplayNameKey(java.lang.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 |
setHeight(java.lang.String dimension)
Sets the item's height using a dimension string with optional unit suffix such as "10" or "10pt". |
void |
setName(java.lang.String name)
Sets the name of this element. |
void |
setNamedExpression(java.lang.String name,
java.lang.String exp)
Sets name of user property defined in this element. |
void |
setTocExpression(java.lang.String expression)
Sets a table of contents entry for this item. |
void |
setUserProperty(java.lang.String name,
java.lang.Object value,
java.lang.String type)
Sets user property defined in this element. |
void |
setUserProperty(java.lang.String name,
java.lang.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 |
setWidth(java.lang.String dimension)
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 |
setX(java.lang.String dimension)
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 |
setY(java.lang.String dimension)
Sets the item's y position using a dimension string with optional unit suffix such as "10" or "10pt". |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MultiRowItem(ExtendedItemHandle item)
item
- Method Detail |
---|
public void addFilterCondition(IFilterCondition condition) throws SemanticException
IMultiRowItem
addFilterCondition
in interface IMultiRowItem
SemanticException
public void addSortCondition(ISortCondition condition) throws SemanticException
IMultiRowItem
addSortCondition
in interface IMultiRowItem
SemanticException
public IFilterCondition[] getFilterConditions()
IMultiRowItem
getFilterConditions
in interface IMultiRowItem
public ISortCondition[] getSortConditions()
IMultiRowItem
getSortConditions
in interface IMultiRowItem
public void removeFilterCondition(IFilterCondition condition) throws SemanticException
IMultiRowItem
removeFilterCondition
in interface IMultiRowItem
SemanticException
public void removeFilterConditions() throws SemanticException
IMultiRowItem
removeFilterConditions
in interface IMultiRowItem
SemanticException
public void removeSortCondition(ISortCondition condition) throws SemanticException
IMultiRowItem
removeSortCondition
in interface IMultiRowItem
SemanticException
public void removeSortConditions() throws SemanticException
IMultiRowItem
removeSortConditions
in interface IMultiRowItem
SemanticException
public void addDataBinding(IDataBinding binding) throws SemanticException
IReportItem
addDataBinding
in interface IReportItem
SemanticException
public void addHideRule(IHideRule rule) throws SemanticException
IReportItem
addHideRule
in interface IReportItem
SemanticException
public void addHighlightRule(IHighlightRule rule) throws SemanticException
IReportItem
addHighlightRule
in interface IReportItem
SemanticException
public java.lang.String getBookmark()
IReportItem
getBookmark
in interface IReportItem
public java.lang.String getDataBinding(java.lang.String bindingName)
IReportItem
getDataBinding
in interface IReportItem
public IDataBinding[] getDataBindings()
IReportItem
getDataBindings
in interface IReportItem
public java.lang.String getHeight()
IReportItem
getHeight
in interface IReportItem
public IHideRule[] getHideRules()
IReportItem
getHideRules
in interface IReportItem
public IHighlightRule[] getHighlightRules()
IReportItem
getHighlightRules
in interface IReportItem
public java.lang.String getTocExpression()
IReportItem
getTocExpression
in interface IReportItem
IReportItem.setTocExpression(String)
public java.lang.String getWidth()
IReportItem
getWidth
in interface IReportItem
public java.lang.String getX()
IReportItem
getX
in interface IReportItem
public java.lang.String getY()
IReportItem
getY
in interface IReportItem
public void setX(double dimension) throws SemanticException
IReportItem
setX
in interface IReportItem
dimension
- the new value in application units.
SemanticException
- if the property is locked.public void setX(java.lang.String dimension) throws SemanticException
IReportItem
setX
in interface IReportItem
dimension
- dimension string with optional unit suffix.
SemanticException
- if the string is not validpublic void setY(double dimension) throws SemanticException
IReportItem
setY
in interface IReportItem
dimension
- the new value in application units.
SemanticException
- if the property is locked.public void setY(java.lang.String dimension) throws SemanticException
IReportItem
setY
in interface IReportItem
dimension
- dimension string with optional unit suffix.
SemanticException
- if the string is not validpublic void removeDataBinding(java.lang.String bindingName) throws SemanticException
IReportItem
removeDataBinding
in interface IReportItem
SemanticException
public void removeDataBindings() throws SemanticException
IReportItem
removeDataBindings
in interface IReportItem
SemanticException
public void removeHideRule(IHideRule rule) throws SemanticException
IReportItem
removeHideRule
in interface IReportItem
SemanticException
public void removeHideRules() throws SemanticException
IReportItem
removeHideRules
in interface IReportItem
SemanticException
public void removeHighlightRule(IHighlightRule rule) throws SemanticException
IReportItem
removeHighlightRule
in interface IReportItem
SemanticException
public void removeHighlightRules() throws SemanticException
IReportItem
removeHighlightRules
in interface IReportItem
SemanticException
public void setBookmark(java.lang.String value) throws SemanticException
IReportItem
setBookmark
in interface IReportItem
value
- the bookmark expression
SemanticException
- if the property is locked.public void setHeight(double dimension) throws SemanticException
IReportItem
setHeight
in interface IReportItem
dimension
- the new value in application units.
SemanticException
- if the property is locked.public void setHeight(java.lang.String dimension) throws SemanticException
IReportItem
setHeight
in interface IReportItem
dimension
- dimension string with optional unit suffix.
SemanticException
- if the string is not validpublic void setTocExpression(java.lang.String expression) throws SemanticException
IReportItem
setTocExpression
in interface IReportItem
expression
- the expression that returns a string
SemanticException
- if the TOC property is locked by the property mask.IReportItem.getTocExpression()
public void setWidth(double dimension) throws SemanticException
IReportItem
setWidth
in interface IReportItem
dimension
- the new value in application units.
SemanticException
- if the property is locked.public void setWidth(java.lang.String dimension) throws SemanticException
IReportItem
setWidth
in interface IReportItem
dimension
- dimension string with optional unit suffix.
SemanticException
- if the string is not validpublic java.lang.String getComments()
IReportElement
getComments
in interface IReportElement
public java.lang.String getCustomXml()
IReportElement
getCustomXml
in interface IReportElement
public java.lang.String getDisplayName()
IReportElement
getDisplayName
in interface IReportElement
public java.lang.String getDisplayNameKey()
IReportElement
getDisplayNameKey
in interface IReportElement
public java.lang.String getName()
IReportElement
null
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.
getName
in interface IReportElement
public void setComments(java.lang.String theComments) throws SemanticException
IReportElement
setComments
in interface IReportElement
theComments
- the comments to set
SemanticException
- if the comments property is locked or not defined on this
element.public void setCustomXml(java.lang.String customXml) throws SemanticException
IReportElement
setCustomXml
in interface IReportElement
customXml
- the custom XML to set
SemanticException
- if the custom XML is locked or not defined on this element.public void setDisplayName(java.lang.String displayName) throws SemanticException
IReportElement
setDisplayName
in interface IReportElement
displayName
- the display name
SemanticException
- if the display name property is locked or not defined on this
element.public void setDisplayNameKey(java.lang.String displayNameKey) throws SemanticException
IReportElement
setDisplayNameKey
in interface IReportElement
displayNameKey
- the resource key of the display name
SemanticException
- if the display name resource-key property is locked or not
defined on this element.public void setName(java.lang.String name) throws SemanticException
IReportElement
null
, then
the name is cleared if this element does not require a name.
setName
in interface IReportElement
name
- the new name
SemanticException
- if the name is duplicate, or if the name is null
and this element requires a name.public java.lang.String getNamedExpression(java.lang.String name)
IDesignElement
getNamedExpression
in interface IDesignElement
public IDesignElement getParent()
IDesignElement
getParent
in interface IDesignElement
public java.lang.String getQualifiedName()
IDesignElement
getName()
, plus the namespace of the module that the
elment is contained, if any. If the element is existed in the current
module,this method and getName()
will return identical
results.
getQualifiedName
in interface IDesignElement
public IStyle getStyle()
IDesignElement
getStyle
in interface IDesignElement
public java.lang.Object getUserProperty(java.lang.String name)
IDesignElement
getUserProperty
in interface IDesignElement
public void setNamedExpression(java.lang.String name, java.lang.String exp) throws SemanticException
IDesignElement
setNamedExpression
in interface IDesignElement
name
- name of user propertyexp
- name expression
SemanticException
public void setUserProperty(java.lang.String name, java.lang.Object value, java.lang.String type) throws SemanticException
IDesignElement
setUserProperty
in interface IDesignElement
SemanticException
public void setUserProperty(java.lang.String name, java.lang.String value) throws SemanticException
IDesignElement
setUserProperty
in interface IDesignElement
SemanticException
public void setCurrentView(IDesignElement viewElement) throws SemanticException
IReportItem
setCurrentView
in interface IReportItem
viewElement
- the view element, must not be this
. Can be
null
.
SemanticException
- if the given element resides in the other elements.public IReportDesign getReport()
IDesignElement
getReport
in interface IDesignElement
public IReportItem getExtensionElement()
MultiRowItem
.
simpleapi.IReportItem
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |