EmbosserWriter (Braille Utils)

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, EmbosserProperties, EmbosserWriterProperties

All Known Implementing Classes:

AbstractEmbosserWriter, BufferedEmbosserWriter, BufferedVolumeEmbosser, ConfigurableEmbosser, FileToDeviceEmbosserWriter
```
public interface EmbosserWriter
extends EmbosserWriterProperties, java.io.Closeable
```
Provides an embosser communication interface. Communication is flat. For example, only one of these should be called when starting a new page:
- newPage
- newSectionAndPage
- newVolumeSectionAndPage
Author:

Joel Håkansson

Nested Class Summary
- Nested classes/interfaces inherited from interface org.daisy.braille.embosser.EmbosserProperties
  EmbosserProperties.PrintMode

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getRowGap()` Gets the current row gap, measured as an integer multiple of the dot-to-dot height.
`boolean`	`isClosed()` Tests if embosser has been closed
`boolean`	`isOpen()` Returns true if embosser is open
`void`	`newLine()` Starts a new line
`void`	`newPage()` Starts a new page
`void`	`newSectionAndPage(boolean duplex)` Starts a new page on a blank sheet of paper with the specified duplex settings.
`void`	`newVolumeSectionAndPage(boolean duplex)` Starts a new page on a blank sheet of paper in a new volume with the specified duplex settings.
`void`	`open(boolean duplex)` Opens for writing using the default contract
`void`	`open(boolean duplex, Contract contract)` Opens for writing
`void`	`setRowGap(int value)` Sets the row gap for following calls to newLine to the specified value, measured as an integer multiple of the dot-to-dot height.
`void`	`write(java.lang.String braille)` Writes a string of braille to the embosser.

Methods inherited from interface org.daisy.braille.embosser.EmbosserWriterProperties
getMaxHeight, getMaxWidth

Methods inherited from interface org.daisy.braille.embosser.EmbosserProperties
supports8dot, supportsAligning, supportsDuplex, supportsPrintMode, supportsVolumes, supportsZFolding

Methods inherited from interface java.io.Closeable
close

- Method Detail
  - write
```
void write(java.lang.String braille)
           throws java.io.IOException
```
    Writes a string of braille to the embosser. Values must be between 0x2800 and 0x28FF. An implementation may supply a complete row of braille in a single chunk. However, an implementation may also call this method repeatedly without any other calls in between.
    
    Parameters:
    braille - characters in the range 0x2800 to 0x28FF
    
    Throws:
    
    java.io.IOException
  - newLine
```
void newLine()
             throws java.io.IOException
```
    Starts a new line
    
    Throws:
    
    java.io.IOException
  - newPage
```
void newPage()
             throws java.io.IOException
```
    Starts a new page
    
    Throws:
    
    java.io.IOException
  - newSectionAndPage
```
void newSectionAndPage(boolean duplex)
                       throws java.io.IOException
```
    Starts a new page on a blank sheet of paper with the specified duplex settings.
    
    Parameters:
    duplex -
    
    Throws:
    
    java.io.IOException
  - newVolumeSectionAndPage
```
void newVolumeSectionAndPage(boolean duplex)
                             throws java.io.IOException
```
    Starts a new page on a blank sheet of paper in a new volume with the specified duplex settings.
    
    Parameters:
    duplex -
    
    Throws:
    
    java.io.IOException
  - open
```
void open(boolean duplex)
          throws java.io.IOException
```
    Opens for writing using the default contract
    
    Throws:
    
    java.io.IOException - if an I/O exception of some sort has occurred
  - open
```
void open(boolean duplex,
        Contract contract)
          throws java.io.IOException,
                 ContractNotSupportedException
```
    Opens for writing
    
    Parameters:
    duplex -
    contract -
    
    Throws:
    
    java.io.IOException - if an I/O exception of some sort has occurred
    
    ContractNotSupportedException - if the supplied contract is not supported, that is to say if the contract does not contain information required by the implementation
  - isOpen
```
boolean isOpen()
```
    Returns true if embosser is open
    
    Returns:
    returns true if embosser is open, false otherwise
  - isClosed
```
boolean isClosed()
```
    Tests if embosser has been closed
    
    Returns:
    returns true if the embosser has been open, but is now closed, false otherwise
  - setRowGap
```
void setRowGap(int value)
```
    Sets the row gap for following calls to newLine to the specified value, measured as an integer multiple of the dot-to-dot height.
    
    Parameters:
    value -
  - getRowGap
```
int getRowGap()
```
    Gets the current row gap, measured as an integer multiple of the dot-to-dot height.
    
    Returns:
    returns the current row gap

Interface EmbosserWriter

Nested Class Summary

Nested classes/interfaces inherited from interface org.daisy.braille.embosser.EmbosserProperties

Method Summary

Methods inherited from interface org.daisy.braille.embosser.EmbosserWriterProperties

Methods inherited from interface org.daisy.braille.embosser.EmbosserProperties

Methods inherited from interface java.io.Closeable

Method Detail

write

newLine

newPage

newSectionAndPage

newVolumeSectionAndPage

open

open

isOpen

isClosed

setRowGap

getRowGap