Leader (dotify.library 1.0.5 API)

java.lang.Object
- org.daisy.dotify.api.formatter.Leader

Direct Known Subclasses:

LeaderSegment
```
public class Leader
extends Object
```
Leader is a data object used when separating two chunks of text within a single row.

The constructor is private, use Leader.Builder to create new instances.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`Leader.Alignment`	Alignment values for leaders.
`static class`	`Leader.Builder`	The Builder is used when creating a Leader instance.

Constructor Summary

Constructors
Modifier Constructor Description

protected Leader(Leader l)

protected Leader(Leader.Builder builder)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Leader.Alignment`	`getAlignment()`	Get the Alignment for this Leader.
`String`	`getPattern()`	Get the pattern for this Leader.
`Position`	`getPosition()`	Get the Position for this Leader.

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

- Constructor Detail
  - Leader
```
protected Leader(Leader.Builder builder)
```
  - Leader
```
protected Leader(Leader l)
```
- Method Detail
  - getPattern
```
public String getPattern()
```
    Get the pattern for this Leader. The pattern is used to fill up the space between the text preceding the leader and the text following it.
    
    Returns:
    
    returns the pattern
  - getPosition
```
public Position getPosition()
```
    Get the Position for this Leader.
    
    Returns:
    
    returns the Position
  - getAlignment
```
public Leader.Alignment getAlignment()
```
    Get the Alignment for this Leader. The alignment effects the placement of the text following the leader.
    
    Returns:
    
    returns the Alignment