Package org.daisy.dotify.formatter.impl.obfl

Enum OBFLVariable

  • All Implemented Interfaces:
    Serializable, Comparable<OBFLVariable>
    public enum OBFLVariable
extends Enum<OBFLVariable>

    Variables that can be used in an OBFL expression.

    Within a Context certain variables are available, such as current volume number and current page number. Here the different variables that exist are listed.

    Some variables exclude each other. For instance, STARTED_PAGE_NUMBER and STARTED_VOLUME_FIRST_CONTENT_PAGE_NUMBER are both "meta" page numbers and at most one such "meta" page number is available in any particular context within the document.

    • Enum Constant Detail

      • PAGE_NUMBER

        public static final OBFLVariable PAGE_NUMBER

        The current page number.

      • VOLUME_NUMBER

        public static final OBFLVariable VOLUME_NUMBER

        The current volume number.

      • VOLUME_COUNT

        public static final OBFLVariable VOLUME_COUNT

        The total number of volumes in the document.

      • STARTED_VOLUME_NUMBER

        public static final OBFLVariable STARTED_VOLUME_NUMBER

        The volume number of the context described in the current context. This is a meta volume number.

        In the context of a OBFL toc-entry element this is the volume number the toc-entry refers to.

      • STARTED_PAGE_NUMBER

        public static final OBFLVariable STARTED_PAGE_NUMBER

        The page number of the context described in the current context. This is a meta page number.

        In the context of a OBFL toc-entry element this is the page number the toc-entry refers to.

      • STARTED_VOLUME_FIRST_CONTENT_PAGE_NUMBER

        public static final OBFLVariable STARTED_VOLUME_FIRST_CONTENT_PAGE_NUMBER

        The page number of the first content page of the context described in in the current context. This is a meta page number.

        In the context of a OBFL toc-entry-on-resumed element this is the page number of the first content page after the volume break that corresponds with this entry.

      • STARTS_AT_TOP_OF_PAGE

        public static final OBFLVariable STARTS_AT_TOP_OF_PAGE

        Indicates that no content has been printed on this page yet.

      • SHEET_COUNT

        public static final OBFLVariable SHEET_COUNT

        The total number of sheets in the document.

      • VOLUME_SHEET_COUNT

        public static final OBFLVariable VOLUME_SHEET_COUNT

        The number of sheets in the current volume.

    • Method Detail

      • values

        public static OBFLVariable[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (OBFLVariable c : OBFLVariable.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static OBFLVariable valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null