Interface ThumbnailView

  • All Superinterfaces:
    com.google.gwt.user.client.ui.IsWidget, MenuContributor, ViewComponent

    public interface ThumbnailView
    extends ViewComponent
    A PageView-like ViewComponent showing Thumbnails for an associated PageView.
    • Field Detail

      • DEFAULT_LABEL_PROVIDER

        static final LabelProvider DEFAULT_LABEL_PROVIDER
        The default label provider creates simple labels for pages. It uses just the page number as label.

        If an application set another label provider and wants to reset the original behavior, this field can be used to reset to the default provider via setLabelProvider(LabelProvider)

    • Method Detail

      • getPageView

        PageView getPageView()
        Returns:
        the PageView this thumbnail view is associated with
      • isSelected

        boolean isSelected​(int pageIndex)
        Parameters:
        pageIndex - The index of the page to check.
        Returns:
        True when the page is currently selected.
      • setSelection

        void setSelection​(int pageIndex,
                          boolean isSelected)
        Sets a Selection of a Page or removes it.
        Parameters:
        pageIndex - The index of the page to check.
        isSelected - True when the page has to be selected, false else.
      • clearSelection

        void clearSelection()
        Clears the selection.
      • getSelectedPages

        List<Page> getSelectedPages()
        Returns:
        List of all Selected pages
      • setPageMoveMode

        void setPageMoveMode​(boolean pageMoveMode)
        Forces the Thumbnails to move away from the MoveToIndex.
        Parameters:
        pageMoveMode - true=on
      • isPageMoveMode

        boolean isPageMoveMode()
        Returns:
        the mode
      • getMoveToIndex

        int getMoveToIndex()
        Returns:
        the index of the Page the new Pages should be added/moved
      • setDefaultThumbnailSize

        void setDefaultThumbnailSize​(Dimension thumbnailSize)
        Sets the default thumbnail size.
        Parameters:
        thumbnailSize - The size of the thumbnails.
      • update

        void update()
        Updates the thumbnail view. Any cached content is reused, filters are re-applied.
      • setLabelProvider

        void setLabelProvider​(LabelProvider labelProvider)
        Sets the LabelProvider which is responsible for creating labels for each page in the ThumbnailView.
        Parameters:
        labelProvider - the label provider to use
        See Also:
        DEFAULT_LABEL_PROVIDER
      • getThumbnailPageView

        PageView getThumbnailPageView()
        Returns:
        the thumbnail PageView contained by this thumbnail view