PageSegment (documentplatform dist, documentation 6.2.161 API)

All Superinterfaces:

ConditionFactoryProvider, Identifiable, MetadataProvider, PermissionsProvider<PageSegment>, PropertiesProvider

All Known Subinterfaces:

MutablePageSegment

All Known Implementing Classes:

AbstractCompositePageSegment, AbstractMutablePageSegment, AbstractPageSegment, AnnotationPageSegment, CompositePageSegment, ContentsCreatorPageSegment, DynamicCompositePageSegment, LazyStreamPageSegment
```
public interface PageSegment
extends PropertiesProvider, MetadataProvider, PermissionsProvider<PageSegment>, ConditionFactoryProvider, Identifiable
```
A PageSegment represents a single layer of a Page, i.e. the Page consists of a stack of PageSegments.

Method Summary

All Methods Instance Methods Abstract Methods
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.
`PageSegmentSource`	`getSource()`	Get the `PageSegmentSource` describing the source of this page segment.
`boolean`	`isAuxiliary()`	Return whether this PageSegment is in some way "auxiliary".

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.metadata.MetadataProvider
getMetadata

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

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

- Method Detail
  - getSource
```
PageSegmentSource getSource()
```
    Get the PageSegmentSource describing the source of this page segment. Returns null if the page segment is not derived from a source.
    
    Returns:
    
    the page segment source
  - getSize
```
Dimension2D getSize()
```
    Returns the raw size/dimensions of the PageSegment in base units.
    
    Returns:
    
    the PageSegment's raw size
  - getBounds
```
Rectangle2D getBounds()
```
    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).
    
    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:
    
    true if this page segment is auxiliary, false if it represents "main" page content.