Package org.daisy.dotify.api.paper

Class SheetPaper

java.lang.Object

org.daisy.dotify.api.paper.AbstractPaper

org.daisy.dotify.api.paper.SheetPaper

All Implemented Interfaces:

Serializable, FactoryProperties, Paper

public class SheetPaper
extends AbstractPaper

Provides a paper object for cut-sheet paper.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.daisy.dotify.api.factory.FactoryProperties

FactoryProperties.ComparatorBuilder

Nested classes/interfaces inherited from interface org.daisy.dotify.api.paper.Paper

Paper.Type

Field Summary

Fields

Modifier and Type	Field	Description
protected Length	pageHeight
protected Length	pageWidth

Constructor Summary

Constructors

Constructor	Description
SheetPaper(String name, String desc, String identifier, Length pageWidth, Length pageHeight)	Creates a new cut-sheet paper.

Method Summary

Modifier and Type	Method	Description
SheetPaper	asSheetPaper()	Returns this Paper as a SheetPaper.
Length	getPageHeight()	Gets the height of the paper in default orientation.
Length	getPageWidth()	Gets the width of the paper in the default orientation.
Paper.Type	getType()	Gets the type of paper.
String	toString()

Methods inherited from class org.daisy.dotify.api.paper.AbstractPaper

asRollPaper, asTractorPaper, getDescription, getDisplayName, getIdentifier

Methods inherited from class java.lang.Object

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

Field Detail

pageWidth

protected final Length pageWidth

pageHeight

protected final Length pageHeight

Constructor Detail

SheetPaper

public SheetPaper(String name,
                  String desc,
                  String identifier,
                  Length pageWidth,
                  Length pageHeight)

Creates a new cut-sheet paper.

Parameters:

name - a name

desc - a description

identifier - an identifier

pageWidth - the width of the paper in the default orientation

pageHeight - the height of the paper in the default orientation

Method Detail

getType

public Paper.Type getType()

Description copied from interface: Paper

Gets the type of paper.

Returns:

returns the type of paper

getPageWidth

public Length getPageWidth()

Gets the width of the paper in the default orientation.

Returns:

returns the width

getPageHeight

public Length getPageHeight()

Gets the height of the paper in default orientation.

Returns:

returns the height

asSheetPaper

public SheetPaper asSheetPaper()

Description copied from interface: Paper

Returns this Paper as a SheetPaper.

Specified by:

asSheetPaper in interface Paper

Overrides:

asSheetPaper in class AbstractPaper

Returns:

returns the SheetPaper

toString

public String toString()

Overrides:

toString in class Object