Package org.docx4j.wml

Enum STFtnPos

java.lang.Object
java.lang.Enum<STFtnPos>
org.docx4j.wml.STFtnPos
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<STFtnPos>, java.lang.constant.Constable
public enum STFtnPos
extends java.lang.Enum<STFtnPos>

Java class for ST_FtnPos.

The following schema fragment specifies the expected content contained within this class. 

 <simpleType name="ST_FtnPos">
   <restriction base="{http://www.w3.org/2001/XMLSchema}string">
     <enumeration value="pageBottom"/>
     <enumeration value="beneathText"/>
     <enumeration value="sectEnd"/>
     <enumeration value="docEnd"/>
   </restriction>
 </simpleType>

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant Description
    BENEATH_TEXT
    Footnotes Positioned Beneath Text
    DOC_END
    Footnotes Positioned At End of Document
    PAGE_BOTTOM
    Footnotes Positioned at Page Bottom
    SECT_END
    Footnotes Positioned At End of Section

  • Method Summary

    Modifier and Type Method Description
    static STFtnPos fromValue​(java.lang.String v)  
    java.lang.String value()  
    static STFtnPos valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static STFtnPos[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • PAGE_BOTTOM

      public static final STFtnPos PAGE_BOTTOM
      Footnotes Positioned at Page Bottom

    • BENEATH_TEXT

      public static final STFtnPos BENEATH_TEXT
      Footnotes Positioned Beneath Text

    • SECT_END

      public static final STFtnPos SECT_END
      Footnotes Positioned At End of Section

    • DOC_END

      public static final STFtnPos DOC_END
      Footnotes Positioned At End of Document

  • Method Details

    • values

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

    • valueOf

      public static STFtnPos valueOf​(java.lang.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:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null

    • value

      public java.lang.String value()

    • fromValue

      public static STFtnPos fromValue​(java.lang.String v)