Package org.daisy.dotify.api.formatter
Class PageAreaProperties
- java.lang.Object
-
- org.daisy.dotify.api.formatter.PageAreaProperties
-
public class PageAreaProperties extends Object
Specifies an area of the page where collection items can be placed. The page area can be located before the text body, below the header or after the text body, above the footer.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PageAreaProperties.Alignment
Specifies the alignment of the page area.static class
PageAreaProperties.Builder
Creates a new page area properties builder.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PageAreaProperties.Alignment
getAlignment()
Gets the alignment of the page area.String
getCollectionId()
Gets the id of the associated collection.Iterable<FallbackRule>
getFallbackRules()
Gets the fallback rules.int
getMaxHeight()
Gets the maximum height allowed to be used by the page area, in rows.
-
-
-
Method Detail
-
getAlignment
public PageAreaProperties.Alignment getAlignment()
Gets the alignment of the page area.- Returns:
- returns the alignment
-
getCollectionId
public String getCollectionId()
Gets the id of the associated collection.- Returns:
- returns the id of the associated collection
-
getFallbackRules
public Iterable<FallbackRule> getFallbackRules()
Gets the fallback rules.- Returns:
- returns the fallback rules
-
getMaxHeight
public int getMaxHeight()
Gets the maximum height allowed to be used by the page area, in rows.- Returns:
- returns the maximum height of the page area in rows
-
-