com.levigo.jadice.document.composite

Class AbstractCompositePageSegment

java.lang.Object

com.levigo.jadice.document.AbstractPageSegment

com.levigo.jadice.document.AbstractMutablePageSegment

com.levigo.jadice.document.composite.AbstractCompositePageSegment

All Implemented Interfaces:

ConditionFactoryProvider, com.levigo.jadice.document.internal.PageAwarePageSegment, com.levigo.jadice.document.internal.presentation.group.PresentationInitializer, com.levigo.jadice.document.internal.presentation.group.VisualizationInitializer, MetadataProvider, MutablePageSegment, PageSegment, PermissionsProvider<PageSegment>, PropertiesProvider, Identifiable

Direct Known Subclasses:

CompositePageSegment, DynamicCompositePageSegment

public abstract class AbstractCompositePageSegment
extends AbstractMutablePageSegment
implements com.levigo.jadice.document.internal.PageAwarePageSegment

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractCompositePageSegment.TransformedElement

Nested classes/interfaces inherited from class com.levigo.jadice.document.AbstractPageSegment

AbstractPageSegment.CacheableVisualElement

Field Summary

Fields inherited from class com.levigo.jadice.document.AbstractPageSegment

CACHE_KEY_CONTENTS, format, id

Constructor Summary

Constructors

Constructor and Description
AbstractCompositePageSegment()

Method Summary

Modifier and Type	Method and Description
void	addPageSegment(PageSegment segment, AffineTransform tx) Place the given PageSegment into the composition using the given transform.
void	addPageSegment(PageSegment segment, AffineTransform tx, Shape clipPath) Place the given PageSegment into the composition using the given transform.
protected AbstractPageSegment.CacheableVisualElement	createCacheableVisualElement() This method is not part of the public API
protected void	fireModified() Fire a notification about a general change to the page segment.
Metadata	getMetadata() Return the exposed meta-data or null if no meta-data is available.
protected List<AbstractCompositePageSegment.TransformedElement>	getSegments() Warning: Just for internal use.
boolean	isAuxiliary() Return whether this PageSegment is in some way "auxiliary".
boolean	isOpaqe() Set whether this page segment is opaque (all white) regardless of whether the whole bounds are taken up by component segments or not.
void	setCurrentPage(Page page) Set the context page for this page segment.
void	setOpaqe(boolean clearBackground) Set whether this page segment is opaque (all white) regardless of whether the whole bounds are taken up by component segments or not.
void	setSource(PageSegmentSource source)

Methods inherited from class com.levigo.jadice.document.AbstractMutablePageSegment

addPageSegmentListener, createPageSegmentEvent, fireModified, fireModified, removePageSegmentListener

Methods inherited from class com.levigo.jadice.document.AbstractPageSegment

getBounds, getCachedVisualElement, getId, getInitialized, getPermissions, getProperties, getResolution, getSize, getSource, isInitialized, toString

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, getSize, getSource

Methods inherited from interface com.levigo.jadice.document.util.PropertiesProvider

getProperties

Methods inherited from interface com.levigo.jadice.document.PermissionsProvider

getPermissions

Methods inherited from interface com.levigo.jadice.document.condition.ConditionFactoryProvider

getConditionFactories

Methods inherited from interface org.jadice.util.base.Identifiable

getId

Methods inherited from interface com.levigo.jadice.document.internal.presentation.group.VisualizationInitializer

getBounds

Methods inherited from interface com.levigo.jadice.document.internal.presentation.group.PresentationInitializer

getInitialized, isInitialized

Constructor Detail

AbstractCompositePageSegment

public AbstractCompositePageSegment()

Method Detail

getMetadata

public Metadata getMetadata()

Description copied from interface: MetadataProvider

Return the exposed meta-data or null if no meta-data is available. An object being a MetadataProvider is not required to provide a non-null meta-data.

Specified by:

getMetadata in interface MetadataProvider

Overrides:

getMetadata in class AbstractPageSegment

Returns:

the metadata document or null

setSource

public void setSource(PageSegmentSource source)

Overrides:

setSource in class AbstractPageSegment

isAuxiliary

public boolean isAuxiliary()

Description copied from interface: PageSegment

Return whether this PageSegment is in some way "auxiliary". Auxiliary page segments contain additions to the main page segment, but rarely represent the main page content in their own right. Currently most page segments are non-auxiliary except for the AnnotationPageSegment.

Specified by:

isAuxiliary in interface PageSegment

Overrides:

isAuxiliary in class AbstractPageSegment

Returns:

true if this page segment is auxiliary, false if it represents "main" page content.

addPageSegment

public void addPageSegment(PageSegment segment,
                           AffineTransform tx)

Place the given PageSegment into the composition using the given transform.

Parameters:

segment - the page segment to be placed

tx - the affine transform to be used

addPageSegment

public void addPageSegment(PageSegment segment,
                           AffineTransform tx,
                           Shape clipPath)

Place the given PageSegment into the composition using the given transform. Apply the given clip path to the placed page segments to cut away undesired parts. The clip path is interpreted in the coordinate system of the placed page segment, i.e. before the transform is applied.

Parameters:

segment - the page segment to be placed

tx - the affine transform to be used

clipPath - the clip path to be applied or null if no clipping shall be applied.

Throws:

IllegalArgumentException - if segment or tx is null.

setCurrentPage

public void setCurrentPage(Page page)

Description copied from interface: com.levigo.jadice.document.internal.PageAwarePageSegment

Set the context page for this page segment. Typically, only the first call to this method is used by implementations. When page segments are added to further pages, this call may therefore be ignored.

Specified by:

setCurrentPage in interface com.levigo.jadice.document.internal.PageAwarePageSegment

createCacheableVisualElement

protected AbstractPageSegment.CacheableVisualElement createCacheableVisualElement()
                                                                           throws JadiceException

Description copied from class: AbstractPageSegment

This method is not part of the public API

Overrides:

createCacheableVisualElement in class AbstractPageSegment

Throws:

JadiceException

isOpaqe

public boolean isOpaqe()

Set whether this page segment is opaque (all white) regardless of whether the whole bounds are taken up by component segments or not.

Returns:

whether this page segment is opaque

setOpaqe

public void setOpaqe(boolean clearBackground)

Set whether this page segment is opaque (all white) regardless of whether the whole bounds are taken up by component segments or not.

fireModified

protected void fireModified()

Description copied from class: AbstractMutablePageSegment

Fire a notification about a general change to the page segment. Please consider firing a more specialized one, indicating the actual damage region.

Overrides:

fireModified in class AbstractMutablePageSegment

getSegments

protected List<AbstractCompositePageSegment.TransformedElement> getSegments()

Warning: Just for internal use. As the returned segments represent the actual segments, changes may lead to inconsistencies.