Interface PageView

All Superinterfaces:
com.google.gwt.event.shared.HasHandlers, com.google.gwt.event.logical.shared.HasResizeHandlers, com.google.gwt.user.client.ui.IsWidget, JadicePageView, MenuContributor, com.levigo.jadice.web.client.util.internal.Repaintable, ViewComponent

public interface PageView extends JadicePageView, com.google.gwt.user.client.ui.IsWidget, com.google.gwt.event.logical.shared.HasResizeHandlers, com.levigo.jadice.web.client.util.internal.Repaintable
  • Method Details

    • getUIStyle

      UIStyle getUIStyle()
    • setVisibleRect

      void setVisibleRect(Rectangle visibleRect)
      Sets the visible Rectangle to update the view to. Used by the ScrollPanels containing the PageView.
      Parameters:
      visibleRect - The currently visible area.
    • getCurrentLaidOutPageBounds

      Rectangle getCurrentLaidOutPageBounds()
      Returns:
      the absolute Bounds in PX of the currentPage
    • getLaidOutPageBounds

      Rectangle getLaidOutPageBounds(Page page)
      Parameters:
      page - to get the Bounds of
      Returns:
      the absolute Bounds in PX of the given page (Empty Rectangle when not visible)
    • addHandler

      com.google.gwt.event.shared.HandlerRegistration addHandler(JadiceEventHandler jadiceEventHandler)
      Parameters:
      jadiceEventHandler - The listener to add.
      Returns:
      a HandlerRegistration handle to remove the handler as soon as the handler isn't required or desired any more. Call HandlerRegistration.removeHandler().
    • addHandler

      <H extends com.google.gwt.event.shared.EventHandler> com.google.gwt.event.shared.HandlerRegistration addHandler(H handler, com.google.gwt.event.shared.GwtEvent.Type<H> type)
      Adds handlers on the PageView for special JadiceEvents.
      Type Parameters:
      H - the derivation of EventHandler
      Parameters:
      handler - The handler to add.
      type - The type of the event.
      Returns:
      a HandlerRegistration handle to remove the handler as soon as the handler isn't required or desired any more. Call HandlerRegistration.removeHandler().
    • addDomHandler

      <H extends com.google.gwt.event.shared.EventHandler> com.google.gwt.event.shared.HandlerRegistration addDomHandler(H handler, com.google.gwt.event.dom.client.DomEvent.Type<H> type)
      Adds a GWT DOM Handler to the PageView widget.
      Type Parameters:
      H - the EventHandler
      Parameters:
      handler - the handler to add
      type - the Type of the Event
      Returns:
      a HandlerRegistration handle to remove the handler as soon as the handler isn't required or desired any more. Call HandlerRegistration.removeHandler().
    • setDontUpdateOnChange

      void setDontUpdateOnChange(boolean dontUpdateOnChange)
      Setting this value to true causes the view to not updating itself when scrolling or zooming. This is necessary when you zoom or change the Layout and want to hold the currentPage (otherwise the currentPage can be unset because its no more visible).
      Parameters:
      dontUpdateOnChange - If true, don't call update() when an update event is fired.
    • forceUpdate

      void forceUpdate()
      Forces an update of the view. This is only required, when automatic updating has been stopped by setDontUpdateOnChange(true). Also this can be used to force repainting any tiles no matter to which costs.
    • update

      void update()
      Update the view. Any cached content is reused.
    • getTileManager

      Deprecated.
      Returns the PageView.TileManager instance of this page view
      Returns:
      the TileManager
    • setPreloadingPageRange

      void setPreloadingPageRange(PreloadingPageRange preloadingPageRange)
      Sets the preloading range which indicates how many pages should be preloaded.
      Parameters:
      preloadingPageRange - the PreloadingPageRange
    • getPageManager

      com.levigo.jadice.web.client.page.internal.PageManager getPageManager()
    • setRepaintMode

      void setRepaintMode(PageView.RepaintMode repaintMode)
      Indicates what should be done while repainting - full repaint or just a fast zoom.
    • setTextPurgeStrategy

      void setTextPurgeStrategy(PageView.TextPurgeStrategy textPurgeStrategy)
      Sets the PageView.TextPurgeStrategy to decide whether PageTextContent should be cached and when the are cache when they should be removed from the cache.
      Parameters:
      textPurgeStrategy - the PurgeStrategy
    • setVisibleRectPositionOnPageChange

      void setVisibleRectPositionOnPageChange(PageView.VisibleRectPositioningStrategy position)
      Defines where the visible rectangle should be positioned when the page changes.
      Parameters:
      position - the PageView.VisibleRectPositioningStrategy
    • setVisibleRectPositionOnDocumentChange

      void setVisibleRectPositionOnDocumentChange(PageView.VisibleRectPositioningStrategy position)
      Defines where the visible rectangle should be positioned when the document changes.
      Parameters:
      position - the PageView.VisibleRectPositioningStrategy
    • getVisibleRectPositionOnPageChange

      PageView.VisibleRectPositioningStrategy getVisibleRectPositionOnPageChange()
      Returns where the visible rectangle should be positioned when the page changes.
      Returns:
      the PageView.VisibleRectPositioningStrategy
    • getVisibleRectPositionOnDocumentChange

      PageView.VisibleRectPositioningStrategy getVisibleRectPositionOnDocumentChange()
      Returns where the visible rectangle should be positioned when the page changes.
      Returns:
      the PageView.VisibleRectPositioningStrategy
    • setHasNativeScrollbars

      void setHasNativeScrollbars(boolean nativeScrollbars)
      Set true when native scrollbars are used for this page view. Some calculations need this info.
      Parameters:
      nativeScrollbars - true if native scrollbars are used; otherwise false
    • hasNativeScrollbars

      boolean hasNativeScrollbars()
      Returns true if native scrollbars are used for this page view. Returns false if not.
      Returns:
      whether native scrollbars are used or not
    • setScrollForceSelectedPageVisible

      void setScrollForceSelectedPageVisible(boolean scrollForceSelectedPageVisible)
      Whether a force selected page should be scrolled completely (as much as it fits in without zooming) into the visible area if it's already partly visible.
      Parameters:
      scrollForceSelectedPageVisible - whether the page should be scrolled completely visible
    • getAggregateBounds

      Rectangle getAggregateBounds()
      Return the bounds encompassing the bounds of all rendered pages.
      Returns:
      the bounds in display units
    • getApplyFilterInView

      PageView.ApplyFilterInView getApplyFilterInView()
      Whether to show all pages of a FilteredDocument - even those pages that are not accepted the filter. Only applicable for FilteredDocuments.
    • setApplyFilterInView

      void setApplyFilterInView(PageView.ApplyFilterInView applyFilter)
      Sets whether to show all pages of a FilteredDocument - even those pages that are not accepted the filter. Only applicable for FilteredDocuments.