Package com.inductiveautomation.rm.shape

Class PaginationUtils

java.lang.Object
com.inductiveautomation.rm.shape.PaginationUtils
public class PaginationUtils extends Object
Utility class for handling pagination related operations, specifically those that deal with binding Page related keys to components.

Pagination in this case refers to process when a single component is rendered across multiple pages as part of the RPG process. Consider a table that has more rows than can fit on a single page, the table will be rendered across more than one page, resulting in multiple paginations.

  • Method Details

    • addShapeWithPageBindingToPageReferenceShape

      public static RMShape addShapeWithPageBindingToPageReferenceShape(ReportOwner owner, RMShape shape)
      Adds the RMShape to the ReportOwner's list of shapes that uses page related bindings or references, if the RMShape has any bindings that are related to pagination.
      Parameters:
      owner - The ReportOwner to add the RMShape to
      shape - The RMShape to check for page related bindings. If null, this method does nothing. We allow for null to prevent a null check before calling this method.
      Returns:
      The RMShape that was passed in. This is to allow for method chaining.

    • resolvePageBindings

      public static void resolvePageBindings(ReportOwner owner, RMShape shape)
      For bindings which uses Page related keys, we evaluate the bindings on the properties of the shape on which the binding is defined.
      Parameters:
      owner - Required so that we can push the Page related keymap to the data stack
      shape - The shape on which the bindings are to be resolved