|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IReportItem
Represents a the design of a report item in the scripting environment
Method Summary | |
---|---|
void |
addDataBinding(IDataBinding binding)
Add ComputedColumn.name , expression of IDataBinding are required. |
void |
addHideRule(IHideRule rule)
Add HideRule |
void |
addHighlightRule(IHighlightRule rule)
Adds high light rule. |
java.lang.String |
getBookmark()
Returns the bookmark of the report item. |
java.lang.String |
getDataBinding(java.lang.String bindingName)
Returns column binding. |
IDataBinding[] |
getDataBindings()
Returns array of all column bindings |
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 |
getTocExpression()
Returns the expression evalueated as a table of contents entry for this item. |
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 |
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 |
setBookmark(java.lang.String value)
Sets the bookmark of the report item. |
void |
setCurrentView(IDesignElement viewElement)
Sets the view to be used. |
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 |
setTocExpression(java.lang.String expression)
Sets a table of contents entry for this item. |
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 interface org.eclipse.birt.report.model.api.simpleapi.IReportElement |
---|
getComments, getCustomXml, getDisplayName, getDisplayNameKey, getName, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setName |
Methods inherited from interface org.eclipse.birt.report.model.api.simpleapi.IDesignElement |
---|
getNamedExpression, getParent, getQualifiedName, getReport, getStyle, getUserProperty, setNamedExpression, setUserProperty, setUserProperty |
Method Detail |
---|
java.lang.String getX()
java.lang.String getY()
void setX(java.lang.String dimension) throws SemanticException
dimension
- dimension string with optional unit suffix.
SemanticException
- if the string is not validvoid setX(double dimension) throws SemanticException
dimension
- the new value in application units.
SemanticException
- if the property is locked.void setY(java.lang.String dimension) throws SemanticException
dimension
- dimension string with optional unit suffix.
SemanticException
- if the string is not validvoid setY(double dimension) throws SemanticException
dimension
- the new value in application units.
SemanticException
- if the property is locked.void setHeight(java.lang.String dimension) throws SemanticException
dimension
- dimension string with optional unit suffix.
SemanticException
- if the string is not validvoid setHeight(double dimension) throws SemanticException
dimension
- the new value in application units.
SemanticException
- if the property is locked.void setWidth(java.lang.String dimension) throws SemanticException
dimension
- dimension string with optional unit suffix.
SemanticException
- if the string is not validvoid setWidth(double dimension) throws SemanticException
dimension
- the new value in application units.
SemanticException
- if the property is locked.java.lang.String getWidth()
java.lang.String getHeight()
java.lang.String getBookmark()
void setBookmark(java.lang.String value) throws SemanticException
value
- the bookmark expression
SemanticException
- if the property is locked.void setTocExpression(java.lang.String expression) throws SemanticException
expression
- the expression that returns a string
SemanticException
- if the TOC property is locked by the property mask.getTocExpression()
java.lang.String getTocExpression()
setTocExpression(String)
IDataBinding[] getDataBindings()
java.lang.String getDataBinding(java.lang.String bindingName)
bindingName
-
void removeDataBinding(java.lang.String bindingName) throws SemanticException
bindingName
-
SemanticException
void removeDataBindings() throws SemanticException
SemanticException
void addDataBinding(IDataBinding binding) throws SemanticException
binding
-
SemanticException
IHighlightRule[] getHighlightRules()
void addHighlightRule(IHighlightRule rule) throws SemanticException
rule
-
SemanticException
void removeHighlightRules() throws SemanticException
SemanticException
void removeHighlightRule(IHighlightRule rule) throws SemanticException
rule
-
SemanticException
void removeHideRule(IHideRule rule) throws SemanticException
rule
-
SemanticException
void removeHideRules() throws SemanticException
SemanticException
IHideRule[] getHideRules()
void addHideRule(IHideRule rule) throws SemanticException
rule
-
SemanticException
void setCurrentView(IDesignElement viewElement) throws SemanticException
viewElement
- the view element, must not be this
. Can be
null
.
SemanticException
- if the given element resides in the other elements.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |