Class ImageCellPosition

  • All Implemented Interfaces:
    Streamable

    public class ImageCellPosition
    extends AbstractAFPObject
    The IM Image Cell Position structured field specifies the placement, size, and replication of IM image cells.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private byte[] xFillSize
      size of fill rectangle in X direction
      private int xOffset
      offset of image cell in X direction
      private byte[] xSize
      size of image cell in X direction
      private byte[] yFillSize
      size of fill rectangle in Y direction
      private int yOffset
      offset of image cell in Y direction
      private byte[] ySize
      size of image cell in Y direction
    • Constructor Summary

      Constructors 
      Constructor Description
      ImageCellPosition​(int x, int y)
      Main Constructor
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void setXFillSize​(int size)
      Specifies the extent of the fill rectangle in the X direction, in image points.
      void setXSize​(int xcSize)
      Specifies the extent in the X direction, in image points, of this image cell.
      void setYFillSize​(int size)
      Specifies the extent of the fill rectangle in the Y direction, in image points.
      void setYSize​(int size)
      Specifies the extent in the Y direction, in image points, of this image cell.
      void writeToStream​(java.io.OutputStream os)
      DataStream objects must implement the writeToStream() method to write its data to the given OutputStream
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • xOffset

        private int xOffset
        offset of image cell in X direction
      • yOffset

        private int yOffset
        offset of image cell in Y direction
      • xSize

        private final byte[] xSize
        size of image cell in X direction
      • ySize

        private final byte[] ySize
        size of image cell in Y direction
      • xFillSize

        private final byte[] xFillSize
        size of fill rectangle in X direction
      • yFillSize

        private final byte[] yFillSize
        size of fill rectangle in Y direction
    • Constructor Detail

      • ImageCellPosition

        public ImageCellPosition​(int x,
                                 int y)
        Main Constructor
        Parameters:
        x - The offset of image cell in X direction
        y - The offset of image cell in Y direction
    • Method Detail

      • writeToStream

        public void writeToStream​(java.io.OutputStream os)
                           throws java.io.IOException
        DataStream objects must implement the writeToStream() method to write its data to the given OutputStream
        Parameters:
        os - the outputsteam stream
        Throws:
        java.io.IOException - an I/O exception of some sort has occurred.
      • setXSize

        public void setXSize​(int xcSize)
        Specifies the extent in the X direction, in image points, of this image cell. A value of X'FFFF' indicates that the default extent specified in bytes 28 and 29 of the Image Input Descriptor (IID) is to be used.
        Parameters:
        xcSize - The size to set.
      • setXFillSize

        public void setXFillSize​(int size)
        Specifies the extent of the fill rectangle in the X direction, in image points. This value can be smaller than, equal to, or larger than the image cell extent in the X direction (XCSize). A value of X'FFFF' indicates that the image cell X-extent should be used as the fill rectangle X-extent. The fill rectangle is filled in the X direction by repeating the image cell in the X direction. The image cell can be truncated to fit the rectangle.
        Parameters:
        size - The size to set.
      • setYSize

        public void setYSize​(int size)
        Specifies the extent in the Y direction, in image points, of this image cell. A value of X'FFFF' indicates that the default extent specified in bytes 30 and 31 of the Image Input Descriptor (IID) is to be used.
        Parameters:
        size - The size to set.
      • setYFillSize

        public void setYFillSize​(int size)
        Specifies the extent of the fill rectangle in the Y direction, in image points. This value can be smaller than, equal to, or larger than the image cell extent in the Y direction (YCSize). A value of X'FFFF' indicates that the image cell Y-extent should be used as the fill rectangle Y-extent. The fill rectangle is filled in the Y direction by repeating the image cell in the Y direction. The image cell can be truncated to fit the rectangle.
        Parameters:
        size - The size to set.