Interface RenderControlInventory

  • All Known Implementing Classes:
    BasicRenderControlInventory.Inventory

    public interface RenderControlInventory

    Implementations of RenderControlInventory handle document and page specific render controls belonging to a certain document instance.

    Instances of this interface allow to get access to document and page specific render settings which is especially useful when the keep render settings mode is enabled.

    This interface allows to get access to document and page specific render settings. With that it allows to change the render settings, too. To support multi viewer usage of one single document instance, viewers always works on snapshots of document render control inventories. As a consequence changes may not be reflected by any viewer which holds this document currently.

    • Method Detail

      • getDocumentRenderControls

        RenderControls getDocumentRenderControls()
        Return the documents render control
        Returns:
        document specific render control
      • getPageRenderControl

        RenderControls getPageRenderControl​(Page page)
        Returns the page render control for the given page.

        If no page render control exist, the document render controls will be returned.

        Parameters:
        page - the page for which the page render control lookup is demanded
        Returns:
        the page specific render control or the document specific render control if no page render control is available
      • getPageRenderControl

        RenderControls getPageRenderControl​(Page page,
                                            boolean create)
        Returns the page render controls for the given page.

        If the given page does not have its own render controls and the second parameter is true a new instance is created and returned.

        If the given page does not have its own render controls and the second parameter is false the document render controls instance is returned.

        Parameters:
        page - the page for which the page render control lookup is demanded
        create - controls whether to return a new RenderControls instance or the document specific instance
        Returns:
        the corresponding RenderControls
      • clear

        void clear()
        Clear/remove references on Pages to ensure all references on Pages of a closed document are removed.