folia.main.Figure
=================

.. currentmodule:: folia.main

.. autoclass:: Figure
   :show-inheritance:
   :undoc-members:
   :special-members:

   

   
   .. rubric:: Method Summary

   .. autosummary::
   
      ~Figure.__init__
      ~Figure.accepts
      ~Figure.add
      ~Figure.addable
      ~Figure.addidsuffix
      ~Figure.addtoindex
      ~Figure.alternatives
      ~Figure.ancestor
      ~Figure.ancestors
      ~Figure.annotation
      ~Figure.annotations
      ~Figure.annotator2processor
      ~Figure.append
      ~Figure.caption
      ~Figure.checkdeclaration
      ~Figure.context
      ~Figure.copy
      ~Figure.copychildren
      ~Figure.correct
      ~Figure.count
      ~Figure.deepvalidation
      ~Figure.depthfirstsearch
      ~Figure.description
      ~Figure.elements
      ~Figure.feat
      ~Figure.findcorrectionhandling
      ~Figure.findreplaceables
      ~Figure.generate_id
      ~Figure.getindex
      ~Figure.getmetadata
      ~Figure.gettextdelimiter
      ~Figure.hasannotation
      ~Figure.hasannotationlayer
      ~Figure.hasphon
      ~Figure.hastag
      ~Figure.hastext
      ~Figure.incorrection
      ~Figure.insert
      ~Figure.items
      ~Figure.json
      ~Figure.layers
      ~Figure.leftcontext
      ~Figure.move
      ~Figure.next
      ~Figure.originaltext
      ~Figure.paragraphs
      ~Figure.parsecommonarguments
      ~Figure.parsexml
      ~Figure.phon
      ~Figure.phoncontent
      ~Figure.postappend
      ~Figure.precedes
      ~Figure.previous
      ~Figure.relaxng
      ~Figure.relaxng_backwards
      ~Figure.remove
      ~Figure.replace
      ~Figure.resolveoffsets
      ~Figure.resolveword
      ~Figure.rightcontext
      ~Figure.select
      ~Figure.sentences
      ~Figure.setdoc
      ~Figure.setdocument
      ~Figure.setparents
      ~Figure.setprocessor
      ~Figure.settext
      ~Figure.speech_speaker
      ~Figure.speech_src
      ~Figure.stricttext
      ~Figure.substitute
      ~Figure.tag
      ~Figure.text
      ~Figure.textcontent
      ~Figure.textvalidation
      ~Figure.toktext
      ~Figure.untag
      ~Figure.updatetext
      ~Figure.words
      ~Figure.xml
      ~Figure.xmlstring
    
    
    ~Figure.__iter__
    
    
    
    ~Figure.__len__
    
    
    
    ~Figure.__str__
    
    
   
   

   
   
   .. rubric:: Class Attributes

   
   .. autoattribute:: ACCEPTED_DATA
   .. autoattribute:: ANNOTATIONTYPE
   .. autoattribute:: AUTH
   .. autoattribute:: AUTO_GENERATE_ID
   .. autoattribute:: HIDDEN
   .. autoattribute:: IMPLICITSPACE
   .. autoattribute:: LABEL
   .. autoattribute:: OCCURRENCES
   .. autoattribute:: OCCURRENCES_PER_SET
   .. autoattribute:: OPTIONAL_ATTRIBS
   .. autoattribute:: PHONCONTAINER
   .. autoattribute:: PRIMARYELEMENT
   .. autoattribute:: PRINTABLE
   .. autoattribute:: REQUIRED_ATTRIBS
   .. autoattribute:: REQUIRED_DATA
   .. autoattribute:: SETONLY
   .. autoattribute:: SPEAKABLE
   .. autoattribute:: SUBSET
   .. autoattribute:: TEXTCONTAINER
   .. autoattribute:: TEXTDELIMITER
   .. autoattribute:: WREFABLE
   .. autoattribute:: XLINK
   .. autoattribute:: XMLTAG
   
   

   .. rubric:: Method Details

   .. automethod::  __init__
   
   .. automethod:: __init__
   
   .. automethod:: accepts
   
   .. automethod:: add
   
   .. automethod:: addable
   
   .. automethod:: addidsuffix
   
   .. automethod:: addtoindex
   
   .. automethod:: alternatives
   
   .. automethod:: ancestor
   
   .. automethod:: ancestors
   
   .. automethod:: annotation
   
   .. automethod:: annotations
   
   .. automethod:: annotator2processor
   
   .. automethod:: append
   
   .. automethod:: caption
   
   .. automethod:: checkdeclaration
   
   .. automethod:: context
   
   .. automethod:: copy
   
   .. automethod:: copychildren
   
   .. automethod:: correct
   
   .. automethod:: count
   
   .. automethod:: deepvalidation
   
   .. automethod:: depthfirstsearch
   
   .. automethod:: description
   
   .. automethod:: elements
   
   .. automethod:: feat
   
   .. automethod:: findcorrectionhandling
   
   .. automethod:: findreplaceables
   
   .. automethod:: generate_id
   
   .. automethod:: getindex
   
   .. automethod:: getmetadata
   
   .. automethod:: gettextdelimiter
   
   .. automethod:: hasannotation
   
   .. automethod:: hasannotationlayer
   
   .. automethod:: hasphon
   
   .. automethod:: hastag
   
   .. automethod:: hastext
   
   .. automethod:: incorrection
   
   .. automethod:: insert
   
   .. automethod:: items
   
   .. automethod:: json
   
   .. automethod:: layers
   
   .. automethod:: leftcontext
   
   .. automethod:: move
   
   .. automethod:: next
   
   .. automethod:: originaltext
   
   .. automethod:: paragraphs
   
   .. automethod:: parsecommonarguments
   
   .. automethod:: parsexml
   
   .. automethod:: phon
   
   .. automethod:: phoncontent
   
   .. automethod:: postappend
   
   .. automethod:: precedes
   
   .. automethod:: previous
   
   .. automethod:: relaxng
   
   .. automethod:: relaxng_backwards
   
   .. automethod:: remove
   
   .. automethod:: replace
   
   .. automethod:: resolveoffsets
   
   .. automethod:: resolveword
   
   .. automethod:: rightcontext
   
   .. automethod:: select
   
   .. automethod:: sentences
   
   .. automethod:: setdoc
   
   .. automethod:: setdocument
   
   .. automethod:: setparents
   
   .. automethod:: setprocessor
   
   .. automethod:: settext
   
   .. automethod:: speech_speaker
   
   .. automethod:: speech_src
   
   .. automethod:: stricttext
   
   .. automethod:: substitute
   
   .. automethod:: tag
   
   .. automethod:: text
   
   .. automethod:: textcontent
   
   .. automethod:: textvalidation
   
   .. automethod:: toktext
   
   .. automethod:: untag
   
   .. automethod:: updatetext
   
   .. automethod:: words
   
   .. automethod:: xml
   
   .. automethod:: xmlstring
   
   
   
   .. automethod:: __iter__
   
   
   
   .. automethod:: __len__
   
   
   
   .. automethod:: __str__