TransitionProperties (dotify.library 1.0.5 API)

java.lang.Object
- org.daisy.dotify.formatter.impl.search.TransitionProperties

```
public class TransitionProperties
extends Object
```
Provides details about a page that are needed for advanced volume transitions.

Constructor Summary

Constructors
Constructor	Description
`TransitionProperties(VolumeKeepPriority keepPriority, boolean hasBlockBoundary)`	Creates a new instance with the specified arguments.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static TransitionProperties`	`empty()`	Returns a default transition.
`boolean`	`equals(Object obj)`
`VolumeKeepPriority`	`getVolumeKeepPriority()`	Gets the volume keep priority for this page.
`boolean`	`hasBlockBoundary()`	Returns true if this page has a block boundary that is useful for a volume transition, false otherwise.
`int`	`hashCode()`

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

- Constructor Detail
  - TransitionProperties
```
public TransitionProperties(VolumeKeepPriority keepPriority,
                            boolean hasBlockBoundary)
```
    Creates a new instance with the specified arguments.
    
    Parameters:
    
    keepPriority - the volume keep priority for the page
    
    hasBlockBoundary - true if this page has a block boundary that is useful for a volume transition, false otherwise
- Method Detail
  - getVolumeKeepPriority
```
public VolumeKeepPriority getVolumeKeepPriority()
```
    Gets the volume keep priority for this page.
    
    Returns:
    
    returns the volume keep priority
  - hasBlockBoundary
```
public boolean hasBlockBoundary()
```
    Returns true if this page has a block boundary that is useful for a volume transition, false otherwise.
    
    Returns:
    
    returns true if the page has a block boundary that is useful for volume transitions, false otherwise
  - empty
```
public static TransitionProperties empty()
```
    Returns a default transition.
    
    Returns:
    
    returns the default transition instance
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object