Interface Resolvable

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String[] getIDRefs()
      Get the array of idrefs of this resolvable object.
      boolean isResolved()
      Check if this area has been resolved.
      void resolveIDRef​(java.lang.String id, java.util.List<PageViewport> pages)
      This method allows the Resolvable object to resolve one of its unresolved idrefs with the actual set of PageViewports containing the target ID.
    • Method Detail

      • isResolved

        boolean isResolved()
        Check if this area has been resolved.
        Returns:
        true once this area is resolved
      • getIDRefs

        java.lang.String[] getIDRefs()
        Get the array of idrefs of this resolvable object. If this object contains child resolvables that are resolved through this then it should return the idref's of the child also.
        Returns:
        the id references for resolving this object
      • resolveIDRef

        void resolveIDRef​(java.lang.String id,
                          java.util.List<PageViewport> pages)
        This method allows the Resolvable object to resolve one of its unresolved idrefs with the actual set of PageViewports containing the target ID. The Resolvable object initially identifies to the AreaTreeHandler which idrefs it needs resolved. After the idrefs are resolved, the ATH calls this method to allow the Resolvable object to update itself with the PageViewport information.
        Parameters:
        id - an ID matching one of the Resolvable object's unresolved idref's.
        pages - the list of PageViewports with the given ID