laika.tree.LinkTargets

TargetDefinition

abstract class TargetDefinition extends AnyRef

The definition of a link target in the document tree, holding the element itself and its identifier. Three abstract methods have to be implemented by the concrete implementations.

Linear Supertypes
AnyRef, Any
Known Subclasses
CitationTarget, CustomizableTarget, DecoratedHeaderTarget, DefaultTarget, ExternalLinkTarget, FootnoteTarget, HeaderTarget, InvalidTarget, LinkAliasTarget
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. TargetDefinition
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TargetDefinition(source: Element, id: Id, global: Boolean)

Abstract Value Members

  1. abstract def replace: ((Element, Id)) ⇒ Option[Element]

    Converts the original target element to the final representation (with its final, resolved identifiers)

  2. abstract def resolve: ((Element, Id)) ⇒ Option[Element]

    Converts an element referencing this target to the final link element.

  3. abstract def withResolvedIds(documentId: String, renderedId: String): SingleTargetResolver

    Converts this target to a final, resolved target based on the specified identifiers.

    Converts this target to a final, resolved target based on the specified identifiers.

    documentId

    the id used as an identifier in the final, rendered output, only containing ASCII alphanumeric characters and optionally a dash to avoid identifiers which are illegal in the final output format (e.g. HTML, PDF)

    renderedId

    the id used to display to the user

    returns

    a final, resolved target based on the specified identifiers

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  10. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  11. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  12. val global: Boolean

  13. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  14. val id: Id

  15. def invalid(msg: String): InvalidTarget

    Converts this target to an invalid one with the specified error message.

  16. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  17. def lift(f: PartialFunction[(Element, Id), Element]): ((Element, Id)) ⇒ Option[Element]

    Convenience method lifting the partial function to a plain function returning an Option result.

    Convenience method lifting the partial function to a plain function returning an Option result.

    Attributes
    protected

  18. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  19. final def notify(): Unit

    Definition Classes
    AnyRef

  20. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  21. val source: Element

  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  23. def toString(): String

    Definition Classes
    AnyRef → Any

  24. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  25. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  26. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped