Interface IReportItem

    • Field Detail

      • constants

        static final org.eclipse.birt.report.model.api.simpleapi.ScriptConstants constants
    • Method Detail

      • getX

        java.lang.String getX()
        Gets the item's x (horizontal) position.
        Returns:
        The item's x position.
      • getY

        java.lang.String getY()
        Gets the item's y (vertical) position.
        Returns:
        The item's y position.
      • setX

        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

        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

        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

        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

        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

        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

        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

        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

        java.lang.String getWidth()
        Gets a the item's width.
        Returns:
        a the item's width.
      • getHeight

        java.lang.String getHeight()
        Gets the item's height.
        Returns:
        the item's height.
      • getBookmark

        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

        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

        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

        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)
      • getDataBindings

        IDataBinding[] getDataBindings()
        Returns array of all column bindings
        Returns:
        all column bindings
      • getDataBinding

        java.lang.String getDataBinding​(java.lang.String bindingName)
        Returns column binding.
        Parameters:
        bindingName -
        Returns:
        column binding expression.
      • removeDataBinding

        void removeDataBinding​(java.lang.String bindingName)
                        throws ScriptException
        Removes special column binding
        Parameters:
        bindingName -
        Throws:
        ScriptException
      • getHighlightRules

        IHighlightRule[] getHighlightRules()
        Gets all high light rules.
        Returns:
        all high light rules
      • getHideRules

        IHideRule[] getHideRules()
        Returns array of hide rule expression
        Returns:
        array of hide rule expression
      • setCurrentView

        void setCurrentView​(IDesignElement viewElement)
                     throws ScriptException
        Sets 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.
        Parameters:
        viewElement - the view element, must not be this. Can be null.
        Throws:
        ScriptException - if the given element resides in the other elements.