Packages

t

info.kwarc.mmt.api

NarrativeElement

trait NarrativeElement extends StructuralElement

A NarrativeElement is any OMDoc element that is used to represent narration and document structure.

These include documents and cross-references.

Source
OMDocElement.scala
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NarrativeElement
  2. StructuralElement
  3. NamedElement
  4. Content
  5. ClientProperties
  6. HasMetaData
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract val feature: String

    the kind of declaration, e.g., "constant"

    the kind of declaration, e.g., "constant"

    Definition Classes
    StructuralElement
  2. abstract def getDeclarations: List[StructuralElement]

    the children of this element

    the children of this element

    Definition Classes
    StructuralElement
  3. abstract def name: LocalName

    the name relative to the parent

    the name relative to the parent

    Definition Classes
    NamedElement
  4. abstract def parent: ComponentParent

    the containing knowledge item, a URL if none

    the containing knowledge item, a URL if none

    Definition Classes
    StructuralElement
  5. abstract def parentOpt: Option[DPath]

    the containing document (if any)

  6. abstract def path: DPath

    the MMT URI of the element

    the MMT URI of the element

    Definition Classes
    NarrativeElementStructuralElement
  7. abstract def toNode: Node

    XML representation

    XML representation

    Definition Classes
    Content

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. lazy val clientProperty: ListMap[URI, Any]
    Definition Classes
    ClientProperties
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  7. def compatible(that: StructuralElement): Boolean

    two StructuralElement's are compatible if they have the same type, same Path, and agree in all parts that are TermContainer's

    two StructuralElement's are compatible if they have the same type, same Path, and agree in all parts that are TermContainer's

    Definition Classes
    StructuralElement
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def equivalentTo(that: StructuralElement): Boolean

    logically equivalent: compares headerInfo, components, and declarations

    logically equivalent: compares headerInfo, components, and declarations

    Definition Classes
    StructuralElement
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def getComponent(k: ComponentKey): Option[ComponentContainer]

    returns a specific component if present

    returns a specific component if present

    Definition Classes
    StructuralElement
  14. def getComponentContext(k: ComponentKey): Context

    like getComponent but returns the additional context (in addition to the context of the element) of the component, empty by default, override as needed unspecified if the component does not exist

    like getComponent but returns the additional context (in addition to the context of the element) of the component, empty by default, override as needed unspecified if the component does not exist

    Definition Classes
    StructuralElement
  15. def getComponents: List[DeclarationComponent]

    returns all term components of this elements

    returns all term components of this elements

    Definition Classes
    NarrativeElementStructuralElement
  16. def getMetaDataNode: NodeSeq
    Definition Classes
    HasMetaData
  17. def getOrigin: Origin
    Definition Classes
    StructuralElement
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def headerInfo: HeaderInfo

    header information of this elements includes the MMT types (e.g., domain, codomain of links) but not the logical types of constants

    header information of this elements includes the MMT types (e.g., domain, codomain of links) but not the logical types of constants

    Definition Classes
    StructuralElement
  20. def isGenerated: Boolean
    Definition Classes
    StructuralElement
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. def merge(that: StructuralElement): Unit

    merge all properties of 'that' into 'this' except for components and declarations

    merge all properties of 'that' into 'this' except for components and declarations

    Definition Classes
    StructuralElement
  23. val metadata: MetaData
    Definition Classes
    HasMetaData
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. def setOrigin(o: Origin): Unit
    Definition Classes
    StructuralElement
  28. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  29. def toNode(rh: RenderingHandler): Unit

    by default, this prints out toNode

    by default, this prints out toNode

    potentially large StructuralElements should override it with a memory-efficient implementation

    Definition Classes
    Content
  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from StructuralElement

Inherited from NamedElement

Inherited from Content

Inherited from ClientProperties

Inherited from HasMetaData

Inherited from AnyRef

Inherited from Any

Ungrouped