Class AutoTextHandle

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

public class AutoTextHandle extends ReportItemHandle implements org.eclipse.birt.report.model.elements.interfaces.IAutoTextModel
Represents a autotext report item. A autotext item supports page number and total page . The autotext has the following properties:
  • An autotext choice type counts the page number or total page number
  • Constructor Details

    • AutoTextHandle

      public AutoTextHandle(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
      Constructs a autotext handle with the given design and the element. 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 Details

    • getAutoTextType

      public String getAutoTextType()
      Returns the autotext type for this parameter. The autotext type counts the page number or total page number. Types are defined in DesignChoiceConstants can be one of the followings:
      • AUTO_TEXT_PAGE_NUMBER
      • AUTO_TEXT_TOTAL_PAGE
      • AUTO_TEXT_PAGE_NUMBER_UNFILTERED
      • AUTO_TEXT_TOTAL_PAGE_UNFILTERED
      • AUTO_TEXT_PAGE_VARIABLE
      Returns:
      the type for the parameter
      See Also:
    • setAutoTextType

      public void setAutoTextType(String type) throws SemanticException
      Sets the autotext type for this parameter. The autotext type counts the page number or total page number. Types are defined in DesignChoiceConstants can be one of the followings:
      • AUTO_TEXT_PAGE_NUMBER
      • AUTO_TEXT_TOTAL_PAGE
      • AUTO_TEXT_PAGE_NUMBER_UNFILTERED
      • AUTO_TEXT_TOTAL_PAGE_UNFILTERED
      • AUTO_TEXT_PAGE_VARIABLE
      Parameters:
      type - the type for the parameter
      Throws:
      SemanticException - if the input type is not one of above choices.
      See Also:
    • getPageVariable

      public String getPageVariable()
      Gets the page variable property value.
      Returns:
      the page variable property value.
    • setPageVariable

      public void setPageVariable(String pageVariable) throws SemanticException
      Sets the page variable property value.
      Parameters:
      pageVariable - page variable property value.
      Throws:
      SemanticException