Uses of Class
com.levigo.jadice.document.DocumentLayer

Packages that use DocumentLayer

Package	Description
com.levigo.jadice.document
com.levigo.jadice.web.client.util.helper
com.levigo.jadice.web.shared.model
com.levigo.jadice.web.shared.model.settings

Uses of DocumentLayer in com.levigo.jadice.document

Fields in com.levigo.jadice.document declared as DocumentLayer

Modifier and Type	Field	Description
static final DocumentLayer	DocumentLayer.ANNOTATIONS	A layer typically used for annotations.
static final DocumentLayer	DocumentLayer.BACKGROUND	A layer typically used for a document backdrop, e.g. a form image behind plain-text form-contents.
static final DocumentLayer	DocumentLayer.DEFAULT	A layer typically used for the document itself.
static final DocumentLayer	DocumentLayer.EMBEDDED_ANNOTATIONS	A layer typically used for format specific inline annotations.
static final DocumentLayer	DocumentLayer.FORM	A layer typically used for form elements.
static final DocumentLayer	DocumentLayer.OCR	A layer typically used for OCR informations, e.g. a hocr file produced by Tesseract which contains text and position information HINT: This layer is installed by default in the default layer cache.

Methods in com.levigo.jadice.document that return DocumentLayer

Modifier and Type	Method	Description
static DocumentLayer	DocumentLayer.get(String name)	Return the document layer with the given name.
static DocumentLayer	DocumentLayer.get(String name, int priority)	Return the document layer with the given name and priority.
DocumentLayer	Page.getDocumentLayer(PageSegment segment)	Deprecated.
DocumentLayer	PageSegmentEvent.getLayer()	Returns the document layer in which the changed page segment resides if available otherwise null

Methods in com.levigo.jadice.document that return types with arguments of type DocumentLayer

Modifier and Type	Method	Description
Set<DocumentLayer>	Page.getLayers()	Deprecated.
Map<DocumentLayer,PageSegment>	Page.getSegmentMap()	Deprecated.

Methods in com.levigo.jadice.document with parameters of type DocumentLayer

Modifier and Type	Method	Description
void	Page.add(DocumentLayer layer, PageSegment pageSegment)	Adds given page segment at given DocumentLayer.
int	DocumentLayer.compareTo(DocumentLayer o)	Compare two DocumentLayers.
PageSegment	Page.getPageSegment(DocumentLayer layer)	Retrieve the PresentationElement at a given DocumentLayer
void	Page.remove(DocumentLayer layer)	Deprecated.
void	PageSegmentEvent.setLayer(DocumentLayer layer)	Sets the document layer in which the changed page segment resides.

Constructors in com.levigo.jadice.document with parameters of type DocumentLayer

Modifier	Constructor	Description
	PageSegmentEvent(Document document, Page page, PageSegment segment, DocumentLayer layer)	Constructor
	PageSegmentEvent(Document document, Page page, PageSegment segment, DocumentLayer layer, PageSegmentEvent.Type type)	Constructor
	PageSegmentEvent(Page page, PageSegment segment, DocumentLayer layer)	Constructor

Uses of DocumentLayer in com.levigo.jadice.web.client.util.helper

Methods in com.levigo.jadice.web.client.util.helper with parameters of type DocumentLayer

Modifier and Type	Method	Description
static Collection<Annotation>	Annotations.getAnnotations(Page page, DocumentLayer documentLayer)	Retrieves the list of annotations lying in the corresponding PageSegment for a given Page and DocumentLayer.
static Collection<Annotation>	Annotations.getDeletedAnnotations(Page page, DocumentLayer documentLayer)	To a given Page and DocumentLayer retrieve the list of annotations that have been deleted from the initial set of annotations which was sent from the server to the client
boolean	Annotations.isAnnotationPageSegment(Page page, DocumentLayer documentLayer)	Check if the PageSegment on a given DocumentLayer on a given Page is an AnnotationPageSegment

Uses of DocumentLayer in com.levigo.jadice.web.shared.model

Methods in com.levigo.jadice.web.shared.model with parameters of type DocumentLayer

Modifier and Type	Method	Description
SourceConfiguration	SourceConfiguration.into(DocumentLayer layer)	Sets the Layer of the Source

Uses of DocumentLayer in com.levigo.jadice.web.shared.model.settings

Methods in com.levigo.jadice.web.shared.model.settings that return types with arguments of type DocumentLayer

Modifier and Type	Method	Description
Set<DocumentLayer>	BaseRenderSettings.getLayers()	only for serialization
List<DocumentLayer>	BaseRenderSettings.getOrderedAndActiveLayers(Collection<DocumentLayer> candidateLayers)	Returns a collection of candidate layers in an ordering suitable for rendering.

Methods in com.levigo.jadice.web.shared.model.settings with parameters of type DocumentLayer

Modifier and Type	Method	Description
boolean	BaseRenderSettings.isDocumentLayerEnabled(DocumentLayer layer)	Returns whether the given layer will be rendered (true if to be rendered, false if not enabled).
void	BaseRenderSettings.setDocumentLayerEnabled(DocumentLayer layer, boolean value)	Sets a flag whether document layer of given class should be rendered or not.

Method parameters in com.levigo.jadice.web.shared.model.settings with type arguments of type DocumentLayer

Modifier and Type	Method	Description
List<DocumentLayer>	BaseRenderSettings.getOrderedAndActiveLayers(Collection<DocumentLayer> candidateLayers)	Returns a collection of candidate layers in an ordering suitable for rendering.