Package org.daisy.braille.utils.impl.provider.indexbraille

Class IndexContractEmbosserWriter

java.lang.Object

org.daisy.braille.utils.impl.provider.indexbraille.IndexContractEmbosserWriter

All Implemented Interfaces:

Closeable, AutoCloseable, ContractEmbosserWriter, EmbosserWriter, EmbosserWriterProperties

public class IndexContractEmbosserWriter
extends Object
implements ContractEmbosserWriter

Provides an embosser writer that supports different configurations based on the properties of an InternalContract.

Method Summary

Modifier and Type	Method	Description
void	close()
int	getMaxWidth()	Gets the maximum row width in the current configuration.
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, InternalContract contract)	Opens for writing using the specified contract.
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.
boolean	supportsAligning()	Returns true if this embosser supports aligning.
void	write(String braille)	Writes a string of braille to the embosser.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

open

public void open(boolean duplex)
          throws IOException

Description copied from interface: EmbosserWriter

Opens for writing using the default contract.

Specified by:

open in interface EmbosserWriter

Parameters:

duplex - true if both sides of sheets should be used, false otherwise

Throws:

IOException - if an I/O error occurs

open

public void open(boolean duplex,
                 InternalContract contract)
          throws IOException,
                 InternalContractNotSupportedException

Description copied from interface: ContractEmbosserWriter

Opens for writing using the specified contract.

Specified by:

open in interface ContractEmbosserWriter

Parameters:

duplex - if both sides of sheets should be used, false otherwise

contract - the contract

Throws:

IOException - if an I/O exception of some sort has occurred

InternalContractNotSupportedException - if the supplied contract is not supported, that is to say if the contract does not contain information required by the implementation

write

public void write(String braille)
           throws IOException

Description copied from interface: EmbosserWriter

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.

Specified by:

write in interface EmbosserWriter

Parameters:

braille - characters in the range 0x2800 to 0x28FF

Throws:

IOException - if an I/O error occurs

newLine

public void newLine()
             throws IOException

Description copied from interface: EmbosserWriter

Starts a new line.

Specified by:

newLine in interface EmbosserWriter

Throws:

IOException - if an I/O error occurs

setRowGap

public void setRowGap(int value)

Description copied from interface: EmbosserWriter

Sets the row gap for following calls to newLine to the specified value, measured as an integer multiple of the dot-to-dot height.

Specified by:

setRowGap in interface EmbosserWriter

Parameters:

value - the row gap

getRowGap

public int getRowGap()

Description copied from interface: EmbosserWriter

Gets the current row gap, measured as an integer multiple of the dot-to-dot height.

Specified by:

getRowGap in interface EmbosserWriter

Returns:

returns the current row gap

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

newPage

public void newPage()
             throws IOException

Description copied from interface: EmbosserWriter

Starts a new page.

Specified by:

newPage in interface EmbosserWriter

Throws:

IOException - if an I/O error occurs

newSectionAndPage

public void newSectionAndPage(boolean duplex)
                       throws IOException

Description copied from interface: EmbosserWriter

Starts a new page on a blank sheet of paper with the specified duplex settings.

Specified by:

newSectionAndPage in interface EmbosserWriter

Parameters:

duplex - if both sides of sheets should be used, false otherwise

Throws:

IOException - if an I/O error occurs

newVolumeSectionAndPage

public void newVolumeSectionAndPage(boolean duplex)
                             throws IOException

Description copied from interface: EmbosserWriter

Starts a new page on a blank sheet of paper in a new volume with the specified duplex settings.

Specified by:

newVolumeSectionAndPage in interface EmbosserWriter

Parameters:

duplex - if both sides of sheets should be used, false otherwise

Throws:

IOException - if an I/O error occurs

isOpen

public boolean isOpen()

Description copied from interface: EmbosserWriter

Returns true if embosser is open.

Specified by:

isOpen in interface EmbosserWriter

Returns:

returns true if embosser is open, false otherwise

isClosed

public boolean isClosed()

Description copied from interface: EmbosserWriter

Tests if embosser has been closed.

Specified by:

isClosed in interface EmbosserWriter

Returns:

returns true if the embosser has been open, but is now closed, false otherwise

getMaxWidth

public int getMaxWidth()

Description copied from interface: EmbosserWriterProperties

Gets the maximum row width in the current configuration.

Specified by:

getMaxWidth in interface EmbosserWriterProperties

Returns:

returns the maximum row width, in characters

supportsAligning

public boolean supportsAligning()

Description copied from interface: EmbosserWriterProperties

Returns true if this embosser supports aligning. This indicates that rows can be padded with whitespace to move the text block horizontally using the value returned by getMaxWidth. Should return true for all physical embossers, since they all have a finite row length.

Specified by:

supportsAligning in interface EmbosserWriterProperties

Returns:

returns true if this embosser supports aligning, false otherwise.