public interface Page extends PropertiesProvider
Document
.Modifier and Type | Field and Description |
---|---|
static String |
PROPERTY_PREFIX_USER_PROPERTY
A property name prefix used for bridged property changes from user properties.
|
Modifier and Type | Method and Description |
---|---|
void |
add(DocumentLayer layer,
PageSegment pageSegment)
Adds given page segment at given
DocumentLayer . |
void |
addPageListener(PageListener listener)
Register a
PageListener . |
DocumentLayer |
getDocumentLayer(PageSegment segment)
Retrieve the
DocumentLayer for a given AbstractPageSegment |
Set<DocumentLayer> |
getLayers()
Return the
DocumentLayer s for which this page has a page segment. |
long |
getModCount()
Get the number of page modifications since its creation.
|
PageSegment |
getPageSegment(DocumentLayer layer)
Retrieve the
PresentationElement at a given DocumentLayer |
Collection<PageSegment> |
getPageSegments()
Return the
PageSegment s this page holds. |
Map<DocumentLayer,PageSegment> |
getSegmentMap()
Return the map of
DocumentLayer s to PageSegment s. |
Dimension2D |
getSize()
Get the raw size of the page in base units.
|
void |
remove(DocumentLayer layer)
Removes the page segment in the given
DocumentLayer . |
void |
removePageListener(PageListener listener)
Deregister a
PageListener . |
getProperties
static final String PROPERTY_PREFIX_USER_PROPERTY
PageSegment getPageSegment(DocumentLayer layer)
PresentationElement
at a given DocumentLayer
layer
- the layer for which to extract the page segment.PresentationElement
or null
if there is no page segment at the
specified layer.DocumentLayer getDocumentLayer(PageSegment segment)
DocumentLayer
for a given AbstractPageSegment
segment
- the page segment for which to extract the layer.DocumentLayer
or null
if there is no layer for the specified
page segment.void add(DocumentLayer layer, PageSegment pageSegment)
DocumentLayer
. For implementations with a "live" map
returned from getSegmentMap()
this is a convenience method for
getSegmentMap().put(DocumentLayer,PageSegment)
.layer
- the layer at which to add the segment.pageSegment
- the page segment to addUnsupportedOperationException
- for read-only implementations of this interfacevoid remove(DocumentLayer layer)
DocumentLayer
. For implementations with a "live"
map returned from getSegmentMap()
this is a convenience method for
getSegmentMap().remove(DocumentLayer)
.layer
- the layer at which to add the segment.UnsupportedOperationException
- for read-only implementations of this interfaceDimension2D getSize()
long getModCount()
PageSegment
is added
to or
removed
from a Page.Set<DocumentLayer> getLayers()
DocumentLayer
s for which this page has a page segment. This is a convenience
method for getSegmentMap().keySet()
.Collection<PageSegment> getPageSegments()
PageSegment
s this page holds. This is a convenience method for
getSegmentMap().values()
.void addPageListener(PageListener listener)
PageListener
.listener
- the listener to registervoid removePageListener(PageListener listener)
PageListener
.listener
- the listener to removeMap<DocumentLayer,PageSegment> getSegmentMap()
DocumentLayer
s to PageSegment
s. Depending on the
implementation of this interface, the returned map may be "live" or read-only.DocumentLayer
s to PageSegment
s.Copyright © 2024 levigo holding gmbh. All rights reserved.