org.eclipse.birt.report.engine.api.script.element
Interface IDesignElement

All Known Subinterfaces:
ICell, IDataItem, IDynamicText, IGrid, IGroup, IImage, ILabel, IList, IListGroup, IListing, IReportDesign, IReportElement, IReportItem, IRow, ITable, ITableGroup, ITextItem

public interface IDesignElement


Method Summary
 java.lang.String getName()
          Returns the name of this element.
 java.lang.String getNamedExpression(java.lang.String name)
           
 IDesignElement getParent()
          Return the parent of this element
 java.lang.String getQualifiedName()
          Gets the name of this element.
 IScriptStyleDesign getStyle()
           
 java.lang.Object getUserProperty(java.lang.String name)
           
 void setName(java.lang.String name)
          Sets the name of this element.
 void setNamedExpression(java.lang.String name, java.lang.String exp)
           
 void setUserProperty(java.lang.String name, java.lang.Object value, java.lang.String type)
           
 void setUserProperty(java.lang.String name, java.lang.String value)
           
 

Method Detail

getStyle

public IScriptStyleDesign getStyle()

getName

public java.lang.String getName()
Returns the name of this element. Returns 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.

Returns:
the element name, or null if the name is not set

getQualifiedName

public java.lang.String getQualifiedName()
Gets the name of this element. The returned element name will be the same as 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.

Returns:
the qualified name of thie element.

setName

public void setName(java.lang.String name)
             throws ScriptException
Sets the name of this element. If the name is null, then the name is cleared if this element does not require a name.

Parameters:
name - the new name
Throws:
ScriptException - if the name is duplicate, or if the name is null and this element requires a name.

getNamedExpression

public java.lang.String getNamedExpression(java.lang.String name)

setNamedExpression

public void setNamedExpression(java.lang.String name,
                               java.lang.String exp)
                        throws ScriptException
Throws:
ScriptException

getUserProperty

public java.lang.Object getUserProperty(java.lang.String name)

setUserProperty

public void setUserProperty(java.lang.String name,
                            java.lang.String value)
                     throws ScriptException
Throws:
ScriptException

setUserProperty

public void setUserProperty(java.lang.String name,
                            java.lang.Object value,
                            java.lang.String type)
                     throws ScriptException
Throws:
ScriptException

getParent

public IDesignElement getParent()
Return the parent of this element

Returns:
the parent


Copyright © 2005 Actuate Corp. All rights reserved.