Package com.levigo.jadice.document
Interface PageSegment
- All Superinterfaces:
org.jadice.util.base.Identifiable,MetadataProvider,PermissionsProvider<PageSegment>,PropertiesProvider,Serializable
public interface PageSegment
extends PropertiesProvider, MetadataProvider, PermissionsProvider<PageSegment>, org.jadice.util.base.Identifiable, Serializable
A
PageSegment represents a single layer of a Page, i.e. the Page consists of
a stack of PageSegments.-
Method Summary
Modifier and TypeMethodDescriptionReturns the raw size and position of thePageSegmentin base units.getSize()Returns the raw size/dimensions of thePageSegmentin base units.Deprecated.booleanReturn whether this PageSegment is in some way "auxiliary".Methods inherited from interface org.jadice.util.base.Identifiable
getIdMethods inherited from interface com.levigo.jadice.document.metadata.MetadataProvider
getMetadataMethods inherited from interface com.levigo.jadice.document.PermissionsProvider
getPermissionsMethods inherited from interface com.levigo.jadice.document.util.PropertiesProvider
getProperties
-
Method Details
-
getSource
Deprecated.Get thePageSegmentSourcedescribing the source of this page segment. Returnsnullif the page segment is not derived from a source.- Returns:
- the page segment source
-
getSize
Dimension2D getSize()Returns the raw size/dimensions of thePageSegmentin base units.- Returns:
- the
PageSegment's raw size
-
getBounds
Rectangle2D getBounds()Returns the raw size and position of thePageSegmentin base units. Position is measured in relation to thePage's coordinate system's origin point (0,0).- Returns:
- the raw size and position
-
isAuxiliary
boolean isAuxiliary()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.- Returns:
trueif this page segment is auxiliary,falseif it represents "main" page content.
-