Package com.levigo.jadice.document.composite

Class CompositePageSegment

java.lang.Object

com.levigo.jadice.document.AbstractPageSegment

com.levigo.jadice.document.AbstractMutablePageSegment

com.levigo.jadice.document.composite.AbstractCompositePageSegment

com.levigo.jadice.document.composite.CompositePageSegment

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

public final class CompositePageSegment
extends AbstractCompositePageSegment

Within a CompositePageSegment (cps) one or more PageSegments can be arranged by transformations and clippings. The size of a cps is passed with the constructor and is immutable. PageSegments that are outside of this area will not be rendered.

* A cps is not delegating AbstractPageSegment.getPermissions(), AbstractPageSegment.getProperties() or AbstractPageSegment.getSource() to its child-segments. If needed, this has to be done manually using the according getters and setters of the PageSegments.

Nested Class Summary

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

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	Description
CompositePageSegment(Dimension2D size)

Method Summary

Modifier and Type	Method	Description
Rectangle2D	getBounds()	Returns the raw size and position of the PageSegment in base units.
Dimension2D	getSize()	Returns the raw size/dimensions of the PageSegment in base units.

Methods inherited from class com.levigo.jadice.document.composite.AbstractCompositePageSegment

addPageSegment, addPageSegment, createCacheableVisualElement, fireModified, getMetadata, getResolution, getSegments, isAuxiliary, isOpaque, setCurrentPage, setOpaque, setSource

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

addPageSegmentListener, createPageSegmentEvent, fireModified, fireModified, removePageSegmentListener

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

getCachedVisualElement, getId, getInitialized, getPermissions, getProperties, 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.condition.ConditionFactoryProvider

getConditionFactories

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

getId

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

getSource

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

getPermissions

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

getInitialized, isInitialized

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

getProperties

Constructor Detail

CompositePageSegment

public CompositePageSegment(Dimension2D size)

Parameters:

size - The size that is used for this pageSegment. The origin is always x=0 and y=0. Must not be null. The given size is measured in Unit.JadiceDocumentUnits.

Throws:

IllegalArgumentException - if passed size is null.

Method Detail

getBounds

public Rectangle2D getBounds()

Description copied from interface: PageSegment

Returns the raw size and position of the PageSegment in base units. Position is measured in relation to the Page's coordinate system's origin point (0,0).

Specified by:

getBounds in interface PageSegment

Specified by:

getBounds in interface com.levigo.jadice.document.internal.presentation.group.VisualizationInitializer

Overrides:

getBounds in class AbstractPageSegment

Returns:

the raw size and position

getSize

public Dimension2D getSize()

Description copied from interface: PageSegment

Returns the raw size/dimensions of the PageSegment in base units.

Returns:

the PageSegment's raw size