public abstract class AbstractPageSegment extends Object implements PageSegment, com.levigo.jadice.document.internal.presentation.group.VisualizationInitializer
Modifier and Type | Class and Description |
---|---|
protected static class |
AbstractPageSegment.CacheableVisualElement
This class is not part of the public API
|
Modifier and Type | Field and Description |
---|---|
protected static Object |
CACHE_KEY_CONTENTS
the key with which the contents will be cached if this PageSegment is able to cache its contents
|
protected Format |
format
Human readable format description.
|
protected String |
id |
Constructor and Description |
---|
AbstractPageSegment()
Construct a page segment.
|
Modifier and Type | Method and Description |
---|---|
protected AbstractPageSegment.CacheableVisualElement |
createCacheableVisualElement()
This method is not part of the public API
|
Rectangle2D |
getBounds()
Deprecated.
The deprecation of this method does not mean that it will be completely
removed! In one of the future major releases this method will be made abstract so
that PageSegments inheriting from the AbstractPageSegment will have to implement
their own getBounds-Method.
|
protected AbstractPageSegment.CacheableVisualElement |
getCachedVisualElement() |
String |
getId()
Return the unique identifier for this object.
|
com.levigo.jadice.document.internal.presentation.group.TransparencyGroupContainer |
getInitialized()
Caveat: this method is not part of the public API.
|
Metadata |
getMetadata()
Return the exposed meta-data or
null if no meta-data is available. |
Permissions<PageSegment> |
getPermissions()
Provides an instance of
Permissions . |
Map<String,Object> |
getProperties()
Return a map of user properties.
|
Resolution |
getResolution()
Return the resolution of the page segment (in DPI).
|
Dimension2D |
getSize()
Deprecated.
The deprecation of this method does not mean that it will be completely
removed! In one of the future major releases this method will be made abstract so
that PageSegments inheriting from the AbstractPageSegment will have to implement
their own getSize-Method.
|
PageSegmentSource |
getSource()
Get the
PageSegmentSource describing the source of this page segment. |
boolean |
isAuxiliary()
Return whether this PageSegment is in some way "auxiliary".
|
boolean |
isInitialized() |
protected void |
setSource(PageSegmentSource source) |
String |
toString()
Description of this page segment instances
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getConditionFactories
protected static final Object CACHE_KEY_CONTENTS
protected Format format
protected String id
public PageSegmentSource getSource()
PageSegment
PageSegmentSource
describing the source of this page segment. Returns
null
if the page segment is not derived from a source.getSource
in interface PageSegment
protected void setSource(PageSegmentSource source)
public Resolution getResolution()
Page segments usually return just the base resolution as their native resolution. Page segments with pixel-data return the actual pixel resolution they can provide. This information is used to hint e.g. the printer about the maximum resolution a page segment can produce.
@Deprecated public Dimension2D getSize()
PageSegment
PageSegment
in base units.getSize
in interface PageSegment
PageSegment
's raw size@Deprecated public Rectangle2D getBounds()
PageSegment
PageSegment
in base units. Position is
measured in relation to the Page
's coordinate system's origin point (0,0).getBounds
in interface com.levigo.jadice.document.internal.presentation.group.VisualizationInitializer
getBounds
in interface PageSegment
public String toString()
toString
in class Object
Object.toString()
protected AbstractPageSegment.CacheableVisualElement getCachedVisualElement()
public boolean isInitialized()
isInitialized
in interface com.levigo.jadice.document.internal.presentation.group.PresentationInitializer
public com.levigo.jadice.document.internal.presentation.group.TransparencyGroupContainer getInitialized()
getInitialized
in interface com.levigo.jadice.document.internal.presentation.group.PresentationInitializer
protected AbstractPageSegment.CacheableVisualElement createCacheableVisualElement() throws JadiceException
JadiceException
public Metadata getMetadata()
MetadataProvider
null
if no meta-data is available. An object being
a MetadataProvider is not required to provide a non-null
meta-data.getMetadata
in interface MetadataProvider
null
public Map<String,Object> getProperties()
PropertiesProvider
getProperties
in interface PropertiesProvider
public String getId()
Identifiable
getId
in interface Identifiable
public boolean isAuxiliary()
PageSegment
isAuxiliary
in interface PageSegment
true
if this page segment is auxiliary, false
if it represents
"main" page content.public Permissions<PageSegment> getPermissions()
PermissionsProvider
Permissions
. Must never return null
.getPermissions
in interface PermissionsProvider<PageSegment>
Permissions
object.Copyright © 2024 levigo holding gmbh. All rights reserved.