|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.levigo.jadice.document.AbstractPageSegment com.levigo.jadice.document.AbstractMutablePageSegment com.levigo.jadice.annotation.AnnotationPageSegment
public class AnnotationPageSegment
A page segment which holds annotations
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.levigo.jadice.document.AbstractPageSegment |
---|
AbstractPageSegment.CacheableRendering |
Field Summary |
---|
Fields inherited from class com.levigo.jadice.document.AbstractPageSegment |
---|
CACHE_KEY_CONTENTS, format, id |
Constructor Summary | |
---|---|
AnnotationPageSegment()
|
|
AnnotationPageSegment(PageSegmentSource source)
|
Method Summary | ||
---|---|---|
void |
addAnnotation(Annotation newAnno)
Adds an existing annotation if not already present in this AnnotationPageSegment
instance. |
|
com.levigo.jadice.document.internal.model.RenderElement |
createRendering()
Caveat: this method is not part of the public API. |
|
com.levigo.jadice.document.internal.model.RenderElement |
createRendering(RenderControls controls)
|
|
void |
deleteAnnotation(Annotation annotation)
Remove the given annotation. |
|
void |
deleteAnnotations(Collection<Annotation> annotation)
Remove the given annotations. |
|
protected AbstractPageSegment.CacheableRendering |
doCreateCacheableRendering()
|
|
protected AbstractPageSegment.CacheableRendering |
doCreateCacheableRendering(RenderControls controls)
|
|
AnnotationProfile |
getAnnotationProfile()
|
|
static
|
getAnnotationRenderer(A annotation)
Deprecated. Do not use. With the next major release this method will not be available as part of the public API any longer. |
|
List<Annotation> |
getAnnotations()
Returns a collection of all annotations. |
|
protected AbstractPageSegment.CacheableRendering |
getCachedRendering(RenderControls controls)
|
|
Collection<Annotation> |
getDeletedAnnotations()
Returns a collection of all deleted annotations. |
|
Dimension |
getPageResolution()
Returns the horizontal and vertical resolution. |
|
com.levigo.jadice.document.internal.Qualification |
getQualification(PageSegment pageSegment)
|
|
Dimension2D |
getSize()
Returns the raw size/dimensions of the PageSegment in base units. |
|
com.levigo.jadice.document.internal.text.TextContentRequestResult |
getTextContent(PageSegment ps,
Rectangle2D roi)
|
|
boolean |
isAuxiliary()
Return whether this PageSegment is in some way "auxiliary". |
|
boolean |
isEligible(PageSegment s,
Rectangle2D roi,
com.levigo.jadice.document.internal.text.TextContentServiceInternal.Priority priority)
|
|
void |
setAnnotationProfile(AnnotationProfile annotationProfile)
Deprecated. Should not be used, profile will be set via AnnotationPageSegment
addAnnotation(Annotation) method. |
|
void |
setCurrentPage(Page page)
Integrator warning: this method is an implementation of an internal interface. |
|
void |
toBack(Collection<Annotation> a)
Move the selected annotations to the back of the rendering list. |
|
void |
toFront(Collection<Annotation> a)
Move the selected annotations to the front of the rendering list. |
|
String |
toString()
Description of this page segment instances |
Methods inherited from class com.levigo.jadice.document.AbstractMutablePageSegment |
---|
addPageSegmentListener, createPageSegmentEvent, fireModified, fireModified, fireModified, removePageSegmentListener |
Methods inherited from class com.levigo.jadice.document.AbstractPageSegment |
---|
getBounds, getCachedRendering, getId, getMetadata, getPermissions, getProperties, getResolution, getSource, isInitialized, setSource |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.levigo.jadice.document.PageSegment |
---|
getBounds, getSource |
Methods inherited from interface com.levigo.jadice.document.util.PropertiesProvider |
---|
getProperties |
Methods inherited from interface com.levigo.jadice.document.metadata.MetadataProvider |
---|
getMetadata |
Methods inherited from interface com.levigo.jadice.document.PermissionsProvider |
---|
getPermissions |
Methods inherited from interface com.levigo.util.base.Identifiable |
---|
getId |
Methods inherited from interface com.levigo.jadice.document.internal.model.RenderRoot |
---|
getBounds, isInitialized |
Constructor Detail |
---|
public AnnotationPageSegment()
public AnnotationPageSegment(PageSegmentSource source)
Method Detail |
---|
public void addAnnotation(Annotation newAnno)
AnnotationPageSegment
instance.
newAnno
-
IllegalArgumentException
- if the given annotation already belongs to an other
AnnotationPageSegment
. In such a case remove the annotation from its
AnnotationPageSegment
before adding it to this AnnotationPageSegment
instance.public Dimension2D getSize()
PageSegment
PageSegment
in base units.
getSize
in interface PageSegment
getSize
in class AbstractPageSegment
PageSegment
's raw sizepublic void deleteAnnotation(Annotation annotation)
annotation
- public void deleteAnnotations(Collection<Annotation> annotation)
annotation
- public void toFront(Collection<Annotation> a)
public void toBack(Collection<Annotation> a)
public List<Annotation> getAnnotations()
public Collection<Annotation> getDeletedAnnotations()
public Dimension getPageResolution()
public String toString()
AbstractPageSegment
toString
in class AbstractPageSegment
Object.toString()
@Deprecated public static <A extends Annotation> AnnotationRenderer<A> getAnnotationRenderer(A annotation)
public com.levigo.jadice.document.internal.model.RenderElement createRendering()
AbstractPageSegment
createRendering
in interface com.levigo.jadice.document.internal.model.RenderRoot
createRendering
in class AbstractPageSegment
RenderRoot.createRendering()
protected AbstractPageSegment.CacheableRendering getCachedRendering(RenderControls controls)
public com.levigo.jadice.document.internal.model.RenderElement createRendering(RenderControls controls)
createRendering
in interface com.levigo.jadice.document.internal.model.DynamicRenderRoot
protected AbstractPageSegment.CacheableRendering doCreateCacheableRendering() throws JadiceException
doCreateCacheableRendering
in class AbstractPageSegment
JadiceException
protected AbstractPageSegment.CacheableRendering doCreateCacheableRendering(RenderControls controls) throws JadiceException
JadiceException
@Deprecated public void setAnnotationProfile(AnnotationProfile annotationProfile)
AnnotationPageSegment
addAnnotation(Annotation)
method.
annotationProfile
- the annotationProfile to setpublic AnnotationProfile getAnnotationProfile()
public boolean isAuxiliary()
PageSegment
isAuxiliary
in interface PageSegment
isAuxiliary
in class AbstractPageSegment
true
if this page segment is auxiliary, false
if it
represents "main" page content.public com.levigo.jadice.document.internal.text.TextContentRequestResult getTextContent(PageSegment ps, Rectangle2D roi)
getTextContent
in interface com.levigo.jadice.document.internal.text.TextContentFactory
public com.levigo.jadice.document.internal.Qualification getQualification(PageSegment pageSegment)
getQualification
in interface com.levigo.jadice.document.internal.text.TextContentFactory
public boolean isEligible(PageSegment s, Rectangle2D roi, com.levigo.jadice.document.internal.text.TextContentServiceInternal.Priority priority)
isEligible
in interface com.levigo.jadice.document.internal.text.TextContentFactory
public void setCurrentPage(Page page)
setCurrentPage
in interface com.levigo.jadice.document.internal.PageAwarePageSegment
PageAwarePageSegment.setCurrentPage(com.levigo.jadice.document.Page)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |