Class FreeFormHandle

  • All Implemented Interfaces:
    IReportItemMethodContext, org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel, org.eclipse.birt.report.model.elements.interfaces.IFreeFormModel, org.eclipse.birt.report.model.elements.interfaces.IInternalReportItemModel, org.eclipse.birt.report.model.elements.interfaces.IReportItemModel, org.eclipse.birt.report.model.elements.interfaces.IStyledElementModel

    public class FreeFormHandle
    extends ReportItemHandle
    implements org.eclipse.birt.report.model.elements.interfaces.IFreeFormModel
    Represents a free-form element. Free-form is the simplest form of report container. A container item holds a collection of other report items. Every item in the container is positioned at an (x, y) location relative to the top left corner of the container. In Free-form elements can be positioned anywhere.
    • Constructor Detail

      • FreeFormHandle

        public FreeFormHandle​(org.eclipse.birt.report.model.core.Module module,
                              org.eclipse.birt.report.model.elements.FreeForm element)
        Constructs a free-form handle with the given design and the free-from. The application generally does not create handles directly. Instead, it uses one of the navigation methods available on other element handles.
        Parameters:
        module - the module
        element - the model representation of the element
    • Method Detail

      • getReportItems

        public SlotHandle getReportItems()
        Returns a slot handle to work with the Report Items within the free-form.
        Returns:
        a slot handle for the report items in the free-from.
        See Also:
        SlotHandle
      • bringForward

        public void bringForward​(ReportItemHandle content)
                          throws SemanticException
        Increases the z-index of the given element by 1. If the element is not in the freeform, do nothing.
        Parameters:
        content - the element
        Throws:
        SemanticException
      • sendBackward

        public void sendBackward​(ReportItemHandle content)
                          throws SemanticException
        Reduces the z-index of the given element that resides in the freeform. If the element is not in the freeform, do nothing.
        Parameters:
        content - the element
        Throws:
        SemanticException
      • bringToFront

        public void bringToFront​(ReportItemHandle content)
                          throws SemanticException
        Increases the z-index of the given element so that the element will have the maximal z-index value. If the element is not in the freeform, do nothing.
        Parameters:
        content - the element
        Throws:
        SemanticException
      • sendToBack

        public void sendToBack​(ReportItemHandle content)
                        throws SemanticException
        Reduces the z-index of the given element so that the element will have the minimal z-index value. If the element is not in the freeform, do nothing.
        Parameters:
        content - the element
        Throws:
        SemanticException