TractorPaper (dotify.api 5.0.0 API)

java.lang.Object
- org.daisy.dotify.api.paper.AbstractPaper
- - org.daisy.dotify.api.paper.TractorPaper

All Implemented Interfaces:

Serializable, FactoryProperties, Paper
```
public class TractorPaper
extends AbstractPaper
```
Provides a paper object for perforated paper with paper guides.

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

Constructor Summary

Constructors
Constructor	Description
`TractorPaper(String name, String desc, String identifier, Length across, Length along)`	Creates a new tractor paper

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`TractorPaper`	`asTractorPaper()`	Returns this Paper as a TractorPaper
`Length`	`getLengthAcrossFeed()`	Gets the length of the paper perpendicular to the direction of the paper feed
`Length`	`getLengthAlongFeed()`	Gets the length of the paper along the direction of the paper feed
`Paper.Type`	`getType()`	Gets the type of paper
`String`	`toString()`

Methods inherited from class org.daisy.dotify.api.paper.AbstractPaper
asRollPaper, asSheetPaper, getDescription, getDisplayName, getIdentifier

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TractorPaper
```
public TractorPaper(String name,
                    String desc,
                    String identifier,
                    Length across,
                    Length along)
```
    Creates a new tractor paper
    
    Parameters:
    
    name - a name
    
    desc - a description
    
    identifier - an identifier
    
    across - the width of the paper
    
    along - the height of the paper
- Method Detail
  - getLengthAcrossFeed
```
public Length getLengthAcrossFeed()
```
    Gets the length of the paper perpendicular to the direction of the paper feed
    
    Returns:
    
    returns the length.
  - getLengthAlongFeed
```
public Length getLengthAlongFeed()
```
    Gets the length of the paper along the direction of the paper feed
    
    Returns:
    
    returns the length.
  - getType
```
public Paper.Type getType()
```
    Description copied from interface: Paper
    
    Gets the type of paper
    
    Returns:
    
    returns the type of paper
  - asTractorPaper
```
public TractorPaper asTractorPaper()
```
    Description copied from interface: Paper
    
    Returns this Paper as a TractorPaper
    
    Specified by:
    
    asTractorPaper in interface Paper
    
    Overrides:
    
    asTractorPaper in class AbstractPaper
    
    Returns:
    
    returns the TractorPaper
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object