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

All Superinterfaces:
IDesignElement, IReportElement
All Known Subinterfaces:
IDataItem, IDynamicText, IGrid, IImage, ILabel, IList, ITable, ITextItem

public interface IReportItem
extends IReportElement

Represents a the design of a report item in the scripting environment


Method Summary
 java.lang.String getBookmark()
          Returns the bookmark of the report item.
 java.lang.String getHeight()
          Gets the item's height.
 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 setBookmark(java.lang.String value)
          Sets the bookmark of the report item.
 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.engine.api.script.element.IReportElement
getComments, getCustomXml, getDisplayName, getDisplayNameKey, setComments, setCustomXml, setDisplayName, setDisplayNameKey
 
Methods inherited from interface org.eclipse.birt.report.engine.api.script.element.IDesignElement
getName, getNamedExpression, getParent, getQualifiedName, getStyle, getUserProperty, setName, setNamedExpression, setUserProperty, setUserProperty
 

Method Detail

getX

public java.lang.String getX()
Gets the item's x (horizontal) position.

Returns:
The item's x position.

getY

public java.lang.String getY()
Gets the item's y (vertical) position.

Returns:
The item's y position.

setX

public void setX(java.lang.String dimension)
          throws ScriptException
Sets 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.

Parameters:
dimension - dimension string with optional unit suffix.
Throws:
ScriptException - if the string is not valid

setX

public void setX(double dimension)
          throws ScriptException
Sets 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.

Parameters:
dimension - the new value in application units.
Throws:
ScriptException - if the property is locked.

setY

public void setY(java.lang.String dimension)
          throws ScriptException
Sets 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.

Parameters:
dimension - dimension string with optional unit suffix.
Throws:
ScriptException - if the string is not valid

setY

public void setY(double dimension)
          throws ScriptException
Sets 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.

Parameters:
dimension - the new value in application units.
Throws:
ScriptException - if the property is locked.

setHeight

public void setHeight(java.lang.String dimension)
               throws ScriptException
Sets 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.

Parameters:
dimension - dimension string with optional unit suffix.
Throws:
ScriptException - if the string is not valid

setHeight

public void setHeight(double dimension)
               throws ScriptException
Sets 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.

Parameters:
dimension - the new value in application units.
Throws:
ScriptException - if the property is locked.

setWidth

public void setWidth(java.lang.String dimension)
              throws ScriptException
Sets 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.

Parameters:
dimension - dimension string with optional unit suffix.
Throws:
ScriptException - if the string is not valid

setWidth

public void setWidth(double dimension)
              throws ScriptException
Sets 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.

Parameters:
dimension - the new value in application units.
Throws:
ScriptException - if the property is locked.

getWidth

public java.lang.String getWidth()
Gets a the item's width.

Returns:
a the item's width.

getHeight

public java.lang.String getHeight()
Gets the item's height.

Returns:
the item's height.

getBookmark

public java.lang.String getBookmark()
Returns the bookmark of the report item. The bookmark value is evaluated as an expression.

Returns:
the book mark as a string

setBookmark

public void setBookmark(java.lang.String value)
                 throws ScriptException
Sets 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");

Parameters:
value - the bookmark expression
Throws:
ScriptException - if the property is locked.

setTocExpression

public void setTocExpression(java.lang.String expression)
                      throws ScriptException
Sets 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.

Parameters:
expression - the expression that returns a string
Throws:
ScriptException - if the TOC property is locked by the property mask.
See Also:
getTocExpression()

getTocExpression

public java.lang.String getTocExpression()
Returns the expression evalueated as a table of contents entry for this item.

Returns:
the expression evaluated as a table of contents entry for this item
See Also:
setTocExpression(String)


Copyright © 2005 Actuate Corp. All rights reserved.