com.levigo.jadice.document.render

Interface Inventory<C extends ProcessingControls<S>,S extends ProcessingSettings>

All Known Implementing Classes:

RenderControlsInventory

public interface Inventory<C extends ProcessingControls<S>,S extends ProcessingSettings>

Method Summary

Modifier and Type	Method and Description
C	getDocumentRenderControls() Return the documents processing controls.
C	getPageRenderControls(Page page) Return the page processing controls for the given page.
C	getPageRenderControls(Page page, boolean create) Return the page render control for the given page.

Method Detail

getDocumentRenderControls

C getDocumentRenderControls()

Return the documents processing controls. The naming of the method includes a reference to RenderControls for historical reasons.

Returns:

document specific render control

getPageRenderControls

C getPageRenderControls(Page page)

Return the page processing controls for the given page. If no page render control exist, null will be returned. The naming of the method includes a reference to RenderControls for historical reasons.

Parameters:

page - the page for which the page render control lookup is demanded

Returns:

the page specific render control or null if no page render control is available

getPageRenderControls

C getPageRenderControls(Page page,
                        boolean create)

Return the page render control for the given page. If no page render control exist, the boolean parameter create decides, whether a page render control will be created and returned or just null will be returned. The naming of the method includes a reference to RenderControls for historical reasons.

Returns:

the page specific render control or null if no render control exist and the create parameter is false or the given page is null