com.levigo.jadice.document.creator
Class CompositePageSegment

java.lang.Object
  com.levigo.jadice.document.AbstractPageSegment
      com.levigo.jadice.document.AbstractMutablePageSegment
          com.levigo.jadice.document.creator.AbstractCompositePageSegment
              com.levigo.jadice.document.creator.CompositePageSegment

All Implemented Interfaces:

com.levigo.jadice.document.internal.model.RenderRoot, 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.creator.AbstractCompositePageSegment

AbstractCompositePageSegment.TransformedElement

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

CompositePageSegment(Dimension2D size)

CompositePageSegment(Rectangle2D bounds)
Deprecated. The applied origin is always x=0 and y=0, irrespective of the passed bounds origin. Use CompositePageSegment(Dimension2D) instead.

Method Summary

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.creator.AbstractCompositePageSegment

addPageSegment, addPageSegment, doCreateCacheableRendering, fireModified, getMetadata, getSegments, isAuxiliary, isOpaqe, setOpaqe, setSource

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

addPageSegmentListener, createPageSegmentEvent, fireModified, fireModified, removePageSegmentListener

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

createRendering, getCachedRendering, getId, getPermissions, getProperties, getResolution, 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

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.util.base.Identifiable

getId

Methods inherited from interface com.levigo.jadice.document.internal.model.RenderRoot

createRendering, isInitialized

Constructor Detail

CompositePageSegment

public CompositePageSegment(Rectangle2D bounds)
                     throws NullPointerException

Deprecated. The applied origin is always x=0 and y=0, irrespective of the passed bounds origin. Use CompositePageSegment(Dimension2D) instead.

Parameters:

bounds - The bounds used for this CompositePageSegment. Must not be null.

Throws:

IllegalArgumentException - if passed bounds are null.

NullPointerException

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.

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 com.levigo.jadice.document.internal.model.RenderRoot

Specified by:

getBounds in interface PageSegment

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.

Specified by:

getSize in interface PageSegment

Overrides:

getSize in class AbstractPageSegment

Returns:

the PageSegment's raw size