Class Overlay

  • All Implemented Interfaces:
    Completable, Streamable

    public class Overlay
    extends PageObject
    An overlay is a MO:DCA-P resource object. It may be stored in an external resource library or it may be carried in a resource group. An overlay is similar to a page in that it defines its own environment and carries the same data objects.
    • Constructor Detail

      • Overlay

        public Overlay​(Factory factory,
                       java.lang.String name,
                       int width,
                       int height,
                       int rotation,
                       int widthResolution,
                       int heightResolution)
        Construct a new overlay object for the specified name argument, the overlay name should be an 8 character identifier.
        Parameters:
        factory - the resource manager of the page.
        name - the name of the page.
        width - the width of the page.
        height - the height of the page.
        rotation - the rotation of the page.
        widthResolution - the width resolution of the page.
        heightResolution - the height resolution of the page.
    • Method Detail

      • writeStart

        protected void writeStart​(java.io.OutputStream os)
                           throws java.io.IOException
        Helper method to write the start of the Object.
        Overrides:
        writeStart in class PageObject
        Parameters:
        os - The stream to write to
        Throws:
        java.io.IOException - throws an I/O exception if one occurred
      • writeContent

        protected void writeContent​(java.io.OutputStream os)
                             throws java.io.IOException
        Helper method to write the contents of the Object.
        Overrides:
        writeContent in class PageObject
        Parameters:
        os - The stream to write to
        Throws:
        java.io.IOException - throws an I/O exception if one occurred
      • writeEnd

        protected void writeEnd​(java.io.OutputStream os)
                         throws java.io.IOException
        Helper method to write the end of the Object.
        Overrides:
        writeEnd in class PageObject
        Parameters:
        os - The stream to write to
        Throws:
        java.io.IOException - an I/O exception if one occurred