Package com.levigo.jadice.web.client

Class ThumbnailViewBuilder

java.lang.Object
com.levigo.jadice.web.client.ThumbnailViewBuilder
public class ThumbnailViewBuilder extends Object
Builder for creating ThumbnailViews.

Builds a ThumbnailView that can be used - e.g. as a panel - to steer a document in a separate PageView in order to build a ThumbnailView by calling build().

  • Constructor Details

  • Method Details

    • setLabelThumbnailStyle

      public ThumbnailViewBuilder setLabelThumbnailStyle(com.levigo.jadice.web.client.viewer.internal.ThumbnailPageView.LabelThumbnailStyle thumbnailLabelStyle)
      Setter for configuring css styles of labels. ThumbnailPageView.LabelThumbnailStyle is part of an "internal" package. In general "internal" code is not guaranteed to remain API stable across releases. For this case, we're guaranteeing that the ThumbnailPageView.LabelThumbnailStyle interface will remain stable up until to Version 5.4 (see details in JWT-358).
      Parameters:
      thumbnailLabelStyle - the label style
      Returns:
      the builder object itself

    • setBorderThumbnailStyle

      public ThumbnailViewBuilder setBorderThumbnailStyle(com.levigo.jadice.web.client.border.internal.SimpleBorderSettings.BorderStyle borderThumbnailStyle)
      Setter for configuring CSS styles of borders.

      SimpleBorderSettings is part of an "internal" package. In general "internal" are not guaranteed to remain API stable across releases. For this case, we're guaranteeing that the SimpleBorderSettings.BorderStyle interface will remain stable up until to Version 5.4 (see details in JWT-358).

      Parameters:
      borderThumbnailStyle - the border style
      Returns:
      the builder object itself

    • setDefaultThumbnailSize

      public ThumbnailViewBuilder setDefaultThumbnailSize(Dimension defaultThumbnailSize)

    • setScrollbarVisibility

      public ThumbnailViewBuilder setScrollbarVisibility(ScrollbarVisibility scrollbarVisibility)
      Sets the ScrollbarVisibility for the created thumbnail view to the desired value.

      Important
      When setting the scrollbar to HIDDEN (off), scrolling might still be possible due to a registered MouseWheelScrollTool in the ToolManager of the thumbnail viewer.

      The tool has to be disabled manually in that case. Example: 

       ThumbnailView thumbnailView =
      new ThumbnailViewBuilder()
        .setScrollbarVisibility(new ScrollbarVisibility(Overflow.HIDDEN))
        [...]
        .build();
 ToolManager tt = thumbnailView.getToolManager();
 tt.setEnabled(MouseWheelScrollTool.class, false);
      Parameters:
      scrollbarVisibility - the desired ScrollbarVisibility
      Returns:
      The builder for method chaining

    • setHasNativeScrollbars

      public ThumbnailViewBuilder setHasNativeScrollbars(boolean nativeScrollbars)

    • build

      public ThumbnailView build()
      Builder method to create a configured ThumbnailView instance.
      Returns:
      the ThumbnailView