Package org.daisy.dotify.common.splitter
Interface SplitPointUnit
-
- All Known Implementing Classes:
Sheet
public interface SplitPointUnitProvides an interface for split point units.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleancollapsesWith(Object obj)Returns true if this unit can collapse with the other object.floatgetLastUnitSize()Gets the size of the unit if it is the last unit.List<String>getSupplementaryIDs()Gets the supplementary IDs for this unit.floatgetUnitSize()Gets the size of the unit.booleanisBreakable()Returns true if this unit is allowed to be the last unit in a result.booleanisCollapsible()Returns true if this unit can be excluded if an adjoining objectcollapsesWiththis unit, but has a greater size.booleanisSkippable()Returns true if this unit is skippable if it overflows the result.
-
-
-
Method Detail
-
isBreakable
boolean isBreakable()
Returns true if this unit is allowed to be the last unit in a result.- Returns:
- returns true if the unit is breakable, false otherwise
-
isSkippable
boolean isSkippable()
Returns true if this unit is skippable if it overflows the result.- Returns:
- returns true if the unit is skippable, false otherwise
-
isCollapsible
boolean isCollapsible()
Returns true if this unit can be excluded if an adjoining objectcollapsesWiththis unit, but has a greater size.- Returns:
- true if the unit is collapsible, false otherwise
-
collapsesWith
boolean collapsesWith(Object obj)
Returns true if this unit can collapse with the other object.- Parameters:
obj- the other object- Returns:
- true if the objects can collapse, false otherwise
-
getUnitSize
float getUnitSize()
Gets the size of the unit.- Returns:
- returns the size of the unit
-
getLastUnitSize
float getLastUnitSize()
Gets the size of the unit if it is the last unit.- Returns:
- returns the size of the unit when placed last in the result.
-
-