Package com.levigo.jadice.document

Interface Page

All Superinterfaces:
PropertiesProvider, Serializable
public interface Page extends PropertiesProvider, Serializable
Represents a page of a Document.

  • Field Details

    • PROPERTY_PREFIX_USER_PROPERTY

      static final String PROPERTY_PREFIX_USER_PROPERTY
      A property name prefix used for bridged property changes from user properties.
      See Also:

  • Method Details

    • getPageSegment

      PageSegment getPageSegment(DocumentLayer layer)
      Retrieve the PresentationElement at a given DocumentLayer
      Parameters:
      layer - the layer for which to extract the page segment.
      Returns:
      a PresentationElement or null if there is no page segment at the specified layer.

    • getDocumentLayer

      @Deprecated DocumentLayer getDocumentLayer(PageSegment segment)
      Deprecated.
      Retrieve the DocumentLayer for a given AbstractPageSegment
      Parameters:
      segment - the page segment for which to extract the layer.
      Returns:
      a DocumentLayer or null if there is no layer for the specified page segment.

    • add

      void add(DocumentLayer layer, PageSegment pageSegment)
      Adds given page segment at given DocumentLayer. For implementations with a "live" map returned from getSegmentMap() this is a convenience method for getSegmentMap().put(DocumentLayer,PageSegment).
      Parameters:
      layer - the layer at which to add the segment.
      pageSegment - the page segment to add
      Throws:
      UnsupportedOperationException - for read-only implementations of this interface

    • remove

      @Deprecated void remove(DocumentLayer layer)
      Deprecated.
      Removes the page segment in the given DocumentLayer. For implementations with a "live" map returned from getSegmentMap() this is a convenience method for getSegmentMap().remove(DocumentLayer).
      Parameters:
      layer - the layer at which to add the segment.
      Throws:
      UnsupportedOperationException - for read-only implementations of this interface

    • getSize

      Dimension2D getSize()
      Get the raw size of the page in base units.
      Returns:
      Dimension the raw size

    • getModCount

      @Deprecated long getModCount()
      Deprecated.
      Get the number of page modifications since its creation. A modification occurs when a PageSegment is added to or removed from a Page.
      Returns:
      number of page modifications

    • getLayers

      @Deprecated Set<DocumentLayer> getLayers()
      Deprecated.
      Return the DocumentLayers for which this page has a page segment. This is a convenience method for getSegmentMap().keySet().
      Returns:
      the DocumentLayers in an unordered set.

    • getPageSegments

      Collection<PageSegment> getPageSegments()
      Return the PageSegments this page holds. This is a convenience method for getSegmentMap().values().
      Returns:
      the PageSegments in an unordered set.

    • addPageListener

      void addPageListener(PageListener listener)
      Register a PageListener.
      Parameters:
      listener - the listener to register

    • removePageListener

      void removePageListener(PageListener listener)
      Deregister a PageListener.
      Parameters:
      listener - the listener to remove

    • getSegmentMap

      @Deprecated Map<DocumentLayer,PageSegment> getSegmentMap()
      Deprecated.
      Return the map of DocumentLayers to PageSegments. Depending on the implementation of this interface, the returned map may be "live" or read-only.
      Returns:
      the map of DocumentLayers to PageSegments.