Interface ClientConfiguration

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int getMaxParallelTileRequests()
      Gets the maximum number of concurrent Tile requests that a client can request on a jadice web toolkit server.
      Float getMaxZoomFactor()
      Returns the maximum allowed zoom value.
      Float getMinZoomFactor()
      Returns the minimum allowed zoom value.
      int getQualityEnhancement()
      The render quality enhancement for modern high-resolution displays and for high browser zoom levels (120% and more).
      boolean isAnnotationEditorWidgetUsed()
      Whether a position editor widget is added to the per-annotation toolbar.
      boolean isFocusTextEditor()
      Gets whether text editors of text based annotations should be focused by the browser.
      boolean isIconFontUsed()
      Whether icon fonts should be used when rendering images on toolbar buttons.
      boolean isPreserveRenderControlsOnDocumentChange()
      Returns whether the document controls should be preserved on document change.
      void setFocusTextEditor​(boolean focusTextEditor)
      Sets whether text editors of text based annotations should be focused by the browser.
      void setIsAnnotationEditorWidgetUsed​(boolean useAnnotationEditorWidget)
      Set whether a position editor widget is added to the per-annotation toolbar.
      void setIsIconFontUsed​(boolean useIconFont)
      Sets whether icon fonts should be used or not.
      void setMaxParallelTileRequests​(int maxRequestCount)
      Sets the maximum number of Tile requests that a client can have running on a jadice web toolkit server at the same time.
      void setMaxZoomFactor​(float maxZoom)
      Sets the maximum allowed zoom value.
      void setMinZoomFactor​(float minZoom)
      Sets the minimum allowed zoom value.
      void setPreserveRenderControlsOnDocumentChange​(boolean keepDocumentControlsOnDocumentChange)
      Sets whether the document controls should be preserved on document change.
      void setQualityEnhancement​(int qualityInPercent)
      Allows tuning the render quality for modern high-resolution displays and for high browser zoom levels (120% and more).
    • Method Detail

      • setIsIconFontUsed

        void setIsIconFontUsed​(boolean useIconFont)
        Sets whether icon fonts should be used or not. If not the ImageResources configured in the UIStyle are used.
        Parameters:
        useIconFont - true if icon fonts should be used when rendering images on toolbar buttons, context menus and other widgets
      • isIconFontUsed

        boolean isIconFontUsed()
        Whether icon fonts should be used when rendering images on toolbar buttons. If not the ImageResources configured in the UIStyle are used.
        Returns:
        whether icon fonts should be used
      • setMaxParallelTileRequests

        void setMaxParallelTileRequests​(int maxRequestCount)
        Sets the maximum number of Tile requests that a client can have running on a jadice web toolkit server at the same time.
        Parameters:
        maxRequestCount - the number of requests
      • getMaxParallelTileRequests

        int getMaxParallelTileRequests()
        Gets the maximum number of concurrent Tile requests that a client can request on a jadice web toolkit server.
        Returns:
        the number of allowed maximum parallel tile requests
      • getQualityEnhancement

        int getQualityEnhancement()
        The render quality enhancement for modern high-resolution displays and for high browser zoom levels (120% and more). This variable allows enhancing the render quality between 0 (standard) and 100 percent (maximum quality).
        Returns:
        adjustment percentage (0 is standard quality, but fast; 100 is maximum quality, but slow)
      • setQualityEnhancement

        void setQualityEnhancement​(int qualityInPercent)
        Allows tuning the render quality for modern high-resolution displays and for high browser zoom levels (120% and more). This variable allows enhancing the render quality between 0 (standard) and 100 percent (maximum quality).

        Some examples:

        • qualityInPercent = 0: "standard render behaviour"
        • qualityInPercent = 100: "full-resolution" rendering on high resolution devices. Be aware that this may slow down tile rendering and document display on the client!
        • qualityInPercent = 30: seems like a good trade-off between quality and speed.
        Parameters:
        qualityInPercent - adjustment percentage (0 is standard quality, but fast; 100 is maximum quality, but slow)
      • setMaxZoomFactor

        void setMaxZoomFactor​(float maxZoom)
        Sets the maximum allowed zoom value.
        Parameters:
        maxZoom - the maximum allowed zoom value
      • getMaxZoomFactor

        Float getMaxZoomFactor()
        Returns the maximum allowed zoom value.
        Returns:
        the maximum allowed zoom value
      • setMinZoomFactor

        void setMinZoomFactor​(float minZoom)
        Sets the minimum allowed zoom value.
        Parameters:
        minZoom - the minimum allowed zoom value
      • getMinZoomFactor

        Float getMinZoomFactor()
        Returns the minimum allowed zoom value.
        Returns:
        the minimum allowed zoom value
      • isFocusTextEditor

        boolean isFocusTextEditor()
        Gets whether text editors of text based annotations should be focused by the browser.

        For more details about this setting, see the documentation of setFocusTextEditor(boolean)

        Returns:
        true if the browser scrolling should lead to jadice scrolling; false if the browser scrolling should be ignored
        See Also:
        setFocusTextEditor(boolean)
      • setFocusTextEditor

        void setFocusTextEditor​(boolean focusTextEditor)
        Sets whether text editors of text based annotations should be focused by the browser.

        This is only when using jadice scrollbars instead of native scrollbars.

        Default: true

        A text editor needs the browsers focus to get input. When setting focus to the editor most browsers ensure that the text area is visible. It does this by browser scrolling. If the jadice scrollbars are used instead of the native scrollbars (this is default) the browser would scroll with the invisible scrollbars to make the editor visible if it is partly outside the visible area. There are two possibilities to handle this situation.

        • Scroll the jadice scrollbars and reset the browser scrolling. This works in all browsers. But it can lead to some unexpected scrolling. Chrome for example centers the part of the editor containing text. IE just scrolls the whole editor visible.
        • Reset the browser scrolling. This does not lead to unexpected scrolling but it can happen that the user inserts text and does not see the text. Besides it does not work in IE.
        Parameters:
        focusTextEditor - true if the browser scrolling should lead to jadice scrolling; false if the browser scrolling should be ignored
      • isPreserveRenderControlsOnDocumentChange

        boolean isPreserveRenderControlsOnDocumentChange()
        Returns whether the document controls should be preserved on document change.

        By Default the document controls are not kept on document change.

        Returns:
        whether the document controls should be kept on document change
      • setPreserveRenderControlsOnDocumentChange

        void setPreserveRenderControlsOnDocumentChange​(boolean keepDocumentControlsOnDocumentChange)
        Sets whether the document controls should be preserved on document change.

        By Default the document controls are not kept on document change.

        Parameters:
        keepDocumentControlsOnDocumentChange - true if the document controls should be kept on document change otherwise false
      • setIsAnnotationEditorWidgetUsed

        void setIsAnnotationEditorWidgetUsed​(boolean useAnnotationEditorWidget)
        Set whether a position editor widget is added to the per-annotation toolbar.
        Parameters:
        useAnnotationEditorWidget - true if the widget should be added.
      • isAnnotationEditorWidgetUsed

        boolean isAnnotationEditorWidgetUsed()
        Whether a position editor widget is added to the per-annotation toolbar.
        Returns:
        Is the widget added?