Package com.teamten.typeset

Enum Class Config.Key

java.lang.Object
java.lang.Enum<Config.Key>
com.teamten.typeset.Config.Key
All Implemented Interfaces:
Serializable, Comparable<Config.Key>, Constable
Enclosing class:
Config
public static enum Config.Key extends Enum<Config.Key>
Various keys that can be used in this configuration.

  • Enum Constant Details

    • TITLE

      public static final Config.Key TITLE

    • SUBTITLE

      public static final Config.Key SUBTITLE

    • AUTHOR

      public static final Config.Key AUTHOR

    • PUBLISHER_NAME

      public static final Config.Key PUBLISHER_NAME

    • PUBLISHER_LOCATION

      public static final Config.Key PUBLISHER_LOCATION

    • COLOPHON

      public static final Config.Key COLOPHON

    • TOC_TITLE

      public static final Config.Key TOC_TITLE

    • TOC_STYLE

      public static final Config.Key TOC_STYLE

    • INDEX_TITLE

      public static final Config.Key INDEX_TITLE

    • LANGUAGE

      public static final Config.Key LANGUAGE

    • BODY_FONT

      public static final Config.Key BODY_FONT

    • BLOCK_QUOTE_FONT

      public static final Config.Key BLOCK_QUOTE_FONT

    • BODY_CODE_FONT

      public static final Config.Key BODY_CODE_FONT

    • CAPTION_FONT

      public static final Config.Key CAPTION_FONT

    • PART_HEADER_FONT

      public static final Config.Key PART_HEADER_FONT

    • CHAPTER_HEADER_FONT

      public static final Config.Key CHAPTER_HEADER_FONT

    • MINOR_HEADER_FONT

      public static final Config.Key MINOR_HEADER_FONT

    • PAGE_NUMBER_FONT

      public static final Config.Key PAGE_NUMBER_FONT

    • CODE_FONT

      public static final Config.Key CODE_FONT

    • OUTPUT_FONT

      public static final Config.Key OUTPUT_FONT

    • INPUT_FONT

      public static final Config.Key INPUT_FONT

    • HEADLINE_FONT

      public static final Config.Key HEADLINE_FONT

    • HALF_TITLE_PAGE_TITLE_FONT

      public static final Config.Key HALF_TITLE_PAGE_TITLE_FONT

    • HALF_TITLE_PAGE_SUBTITLE_FONT

      public static final Config.Key HALF_TITLE_PAGE_SUBTITLE_FONT

    • TITLE_PAGE_AUTHOR_FONT

      public static final Config.Key TITLE_PAGE_AUTHOR_FONT

    • TITLE_PAGE_TITLE_FONT

      public static final Config.Key TITLE_PAGE_TITLE_FONT

    • TITLE_PAGE_SUBTITLE_FONT

      public static final Config.Key TITLE_PAGE_SUBTITLE_FONT

    • TITLE_PAGE_PUBLISHER_NAME_FONT

      public static final Config.Key TITLE_PAGE_PUBLISHER_NAME_FONT

    • TITLE_PAGE_PUBLISHER_LOCATION_FONT

      public static final Config.Key TITLE_PAGE_PUBLISHER_LOCATION_FONT

    • COPYRIGHT_PAGE_COPYRIGHT_FONT

      public static final Config.Key COPYRIGHT_PAGE_COPYRIGHT_FONT

    • COPYRIGHT_PAGE_COLOPHON_FONT

      public static final Config.Key COPYRIGHT_PAGE_COLOPHON_FONT

    • TOC_PAGE_TITLE_FONT

      public static final Config.Key TOC_PAGE_TITLE_FONT

    • TOC_PAGE_PART_FONT

      public static final Config.Key TOC_PAGE_PART_FONT

    • TOC_PAGE_CHAPTER_FONT

      public static final Config.Key TOC_PAGE_CHAPTER_FONT

    • FOOTNOTE_NUMBER_FONT

      public static final Config.Key FOOTNOTE_NUMBER_FONT

    • FALLBACK_TYPEFACE

      public static final Config.Key FALLBACK_TYPEFACE

    • PAGE_WIDTH

      public static final Config.Key PAGE_WIDTH

    • PAGE_HEIGHT

      public static final Config.Key PAGE_HEIGHT

    • PAGE_MARGIN_TOP

      public static final Config.Key PAGE_MARGIN_TOP

    • PAGE_MARGIN_BOTTOM

      public static final Config.Key PAGE_MARGIN_BOTTOM

    • PAGE_MARGIN_OUTER

      public static final Config.Key PAGE_MARGIN_OUTER

    • PAGE_MARGIN_INNER

      public static final Config.Key PAGE_MARGIN_INNER

    • FOOTNOTE_SHIFT

      public static final Config.Key FOOTNOTE_SHIFT

  • Method Details

    • values

      public static Config.Key[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static Config.Key valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • getKeyType

      public com.teamten.typeset.Config.KeyType getKeyType()
      Specifies what kind of key this is (string, font, or distance).

    • fromHeader

      public static Config.Key fromHeader(String stringKey)
      The string key is converted to upper case, and hyphens are converted to underscores.
      Throws:
      IllegalArgumentException - if the key does not match one of the entries in the enum.