Package org.daisy.braille.embosser

Class AbstractEmbosser

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Factory>, Embosser, EmbosserProperties, Factory
    public abstract class AbstractEmbosser
extends AbstractFactory
implements Embosser
    Provides an abstract base for Embossers, implementing basic features such as the ability to set page format, table, and cell height and width.
    Author:
    Joel Håkansson
    See Also:
    Serialized Form

    • Field Detail

      • defaultTable

        protected final Table defaultTable

      • setTable

        protected Table setTable

    • Constructor Detail

      • AbstractEmbosser

        public AbstractEmbosser​(java.lang.String name,
                        java.lang.String desc,
                        java.lang.Enum<? extends java.lang.Enum<?>> identifier)
        Creates a new AbstractEmbosser with the supplied name, description and identifier
        Parameters:
        name - the embosser name
        desc - the embosser description
        identifier - an identifier

    • Method Detail

      • setCellWidth

        protected void setCellWidth​(double val)
        Set cell width, in millimeters
        Parameters:
        val - the width, in millimeters

      • setCellHeight

        protected void setCellHeight​(double val)
        Set cell height, in millimeters
        Parameters:
        val - the height, in millimeters

      • getPageFormat

        protected PageFormat getPageFormat()
        Gets the page format
        Returns:
        returns the page format

      • getCellWidth

        public double getCellWidth()
        Gets cell width, in millimeters
        Returns:
        returns cell width, in millimeters

      • getCellHeight

        public double getCellHeight()
        Gets cell height, in millimeters
        Returns:
        returns cell height, in millimeters

      • getMaxHeight

        public int getMaxHeight​(PageFormat pageFormat)
        Description copied from interface: Embosser
        Gets the max height for the specified page format
        Specified by:
        getMaxHeight in interface Embosser
        Parameters:
        pageFormat - the page format
        Returns:
        returns the max height for the specified page format

      • getMaxWidth

        public int getMaxWidth​(PageFormat pageFormat)
        Description copied from interface: Embosser
        Gets the max width for the specified page format
        Specified by:
        getMaxWidth in interface Embosser
        Parameters:
        pageFormat - the page format
        Returns:
        returns the max width for the specified page format

      • getPrintableArea

        public Area getPrintableArea​(PageFormat pageFormat)
        Description copied from interface: Embosser
        Gets the printable area for the specified page format
        Specified by:
        getPrintableArea in interface Embosser
        Parameters:
        pageFormat - the page format
        Returns:
        returns the printable area for the specified page format

      • getFeature

        public java.lang.Object getFeature​(java.lang.String key)
        Description copied from interface: Factory
        Gets the value of a feature used by this Factory
        Specified by:
        getFeature in interface Factory
        Parameters:
        key - the key for the feature
        Returns:
        returns the current value of the feature

      • getProperty

        public java.lang.Object getProperty​(java.lang.String key)
        Description copied from interface: Factory
        Gets the value of a read-only property that applies to all objects returned by this Factory.
        Specified by:
        getProperty in interface Factory
        Parameters:
        key - the name of the property to get
        Returns:
        returns the value associated with this property or null if none is found

      • setFeature

        public void setFeature​(java.lang.String key,
                       java.lang.Object value)
        Associates the specified value with the specified key in this map. If the map previously contained a mapping for this key, the old value is replaced.
        Specified by:
        setFeature in interface Factory
        Parameters:
        key - key with which the specified value is to be associated.
        value - value to be associated with the specified key.

      • supportsTable

        public boolean supportsTable​(Table table)
        Description copied from interface: Embosser
        Returns true if table is supported
        Specified by:
        supportsTable in interface Embosser
        Parameters:
        table - the table to test
        Returns:
        returns true if table is supported