LineProperties (dotify.library 1.0.5 API)

java.lang.Object
- org.daisy.dotify.formatter.impl.row.LineProperties

public final class LineProperties
extends Object

Provides details about a line.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class LineProperties.Builder
Provides a builder of line properties.

Field Summary

Fields
Modifier and Type Field Description

static LineProperties DEFAULT
Provides default line properties.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`BlockLineLocation`	`getBlockLineLocation()`
`int`	`getReservedWidth()`	Gets the number of characters on a line that cannot be used for text flow contents.
`boolean`	`suppressHyphenation()`	When true, hyphenation should be suppressed for the line.

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

- Field Detail
  - DEFAULT
```
public static final LineProperties DEFAULT
```
    Provides default line properties. The default is to allow hyphenation and to reserve no width.
- Method Detail
  - suppressHyphenation
```
public boolean suppressHyphenation()
```
    When true, hyphenation should be suppressed for the line.
    
    Returns:
    
    true if hyphenation should be suppressed, false otherwise
  - getReservedWidth
```
public int getReservedWidth()
```
    Gets the number of characters on a line that cannot be used for text flow contents.
    
    Returns:
    
    the number of characters on a line that cannot be used for text flow contents
  - getBlockLineLocation
```
public BlockLineLocation getBlockLineLocation()
```