public class AnnotationPageSegment extends AbstractMutablePageSegment implements com.levigo.jadice.document.internal.PageAwarePageSegment, com.levigo.jadice.document.internal.text.TextContentFactory, com.levigo.jadice.document.internal.presentation.group.DynamicPresentationInitializer
AbstractPageSegment.CacheableVisualElement
CACHE_KEY_CONTENTS, format, id
Constructor and Description |
---|
AnnotationPageSegment() |
AnnotationPageSegment(PageSegmentSource source) |
Modifier and Type | Method and Description |
---|---|
void |
addAnnotation(Annotation newAnno)
Adds an existing annotation if not already present in this
AnnotationPageSegment
instance. |
protected AbstractPageSegment.CacheableVisualElement |
createCacheableVisualElement()
This method is not part of the public API
|
void |
deleteAnnotation(Annotation annotation)
Remove the given annotation.
|
void |
deleteAnnotations(Collection<Annotation> annotation)
Remove the given annotations.
|
protected AbstractPageSegment.CacheableVisualElement |
doCreateCacheableRendering(RenderControls controls) |
AnnotationProfile |
getAnnotationProfile() |
List<Annotation> |
getAnnotations()
Returns a collection of all annotations.
|
protected AbstractPageSegment.CacheableVisualElement |
getCachedVisualElement(RenderControls controls) |
Collection<Annotation> |
getDeletedAnnotations()
Returns a collection of all deleted annotations.
|
com.levigo.jadice.document.internal.presentation.group.TransparencyGroupContainer |
getInitialized()
Caveat: this method is not part of the public API.
|
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,
List<com.levigo.jadice.document.internal.condition.PresentationElementCondition> conditions)
If the factory provides the text content based on the presentation tree the given conditions
shall be applied while traversing it.
|
com.levigo.jadice.document.internal.presentation.group.TransparencyGroupContainer |
initialize(RenderControls controls) |
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)
Return whether this factory is eligible for the given page segment and the given priority.
|
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
|
addPageSegmentListener, createPageSegmentEvent, fireModified, fireModified, fireModified, removePageSegmentListener
getBounds, getCachedVisualElement, getId, getMetadata, getPermissions, getProperties, getResolution, getSource, isInitialized, setSource
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getBounds, getSource
getProperties
getMetadata
getPermissions
getConditionFactories
getId
getTextContent
public AnnotationPageSegment()
public AnnotationPageSegment(PageSegmentSource source)
public void addAnnotation(Annotation newAnno)
AnnotationPageSegment
instance.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)
public void deleteAnnotations(Collection<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()
public com.levigo.jadice.document.internal.presentation.group.TransparencyGroupContainer getInitialized()
AbstractPageSegment
getInitialized
in interface com.levigo.jadice.document.internal.presentation.group.PresentationInitializer
getInitialized
in class AbstractPageSegment
protected AbstractPageSegment.CacheableVisualElement getCachedVisualElement(RenderControls controls)
public com.levigo.jadice.document.internal.presentation.group.TransparencyGroupContainer initialize(RenderControls controls)
initialize
in interface com.levigo.jadice.document.internal.presentation.group.DynamicPresentationInitializer
protected AbstractPageSegment.CacheableVisualElement createCacheableVisualElement() throws JadiceException
AbstractPageSegment
createCacheableVisualElement
in class AbstractPageSegment
JadiceException
protected AbstractPageSegment.CacheableVisualElement doCreateCacheableRendering(RenderControls controls) throws JadiceException
JadiceException
public 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, List<com.levigo.jadice.document.internal.condition.PresentationElementCondition> conditions)
com.levigo.jadice.document.internal.text.TextContentFactory
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)
com.levigo.jadice.document.internal.text.TextContentFactory
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)
Copyright © 2024 levigo holding gmbh. All rights reserved.