Packages

c

info.kwarc.mmt.frameit

FrameitPlugin

class FrameitPlugin extends ServerExtension with Logger with MMTTask

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FrameitPlugin
  2. MMTTask
  3. Killable
  4. ServerExtension
  5. FormatBasedExtension
  6. Extension
  7. Logger
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FrameitPlugin()

Type Members

  1. case class LocalError(s: String) extends ExtensionError with Product with Serializable

    a custom error class for this extension

    a custom error class for this extension

    Definition Classes
    Extension

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. def addListener(l: MMTTaskProgressListener): Unit
    Definition Classes
    MMTTask
  5. def apply(request: ServerRequest): ServerResponse

    handles a request for this ServerExtension

    handles a request for this ServerExtension

    for implementation, the ServerResponse._ methods should be used all errors are caught and displayed to the user when possible

    request

    The request sent to this ServerExtension

    returns

    a response for this request

    Definition Classes
    FrameitPlugin → ServerExtension
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def catchErrors[A](msg: String, recoverWith: ⇒ A)(code: ⇒ A): A

    like its partner but with return value

    like its partner but with return value

    Attributes
    protected
    Definition Classes
    Extension
  8. def catchErrors(msg: String)(code: ⇒ Unit): Unit

    convenience method for wrapping code in error handler that throws LocalError

    convenience method for wrapping code in error handler that throws LocalError

    Attributes
    protected
    Definition Classes
    Extension
  9. implicit lazy val ce: CheckingEnvironment
  10. lazy val checker: MMTStructureChecker
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  12. val controller: Controller

    the controller that this extension is added to; only valid after creation of the extension, i.e., will return null if used in a non-lazy val-field

    the controller that this extension is added to; only valid after creation of the extension, i.e., will return null if used in a non-lazy val-field

    Attributes
    protected
    Definition Classes
    Extension
  13. lazy val defaultPrefix: String
    Definition Classes
    Extension
  14. def destroy: Unit

    extension-specific cleanup (override as needed, empty by default)

    extension-specific cleanup (override as needed, empty by default)

    Extensions may create persistent data structures and threads, but they must clean up after themselves in this method

    Definition Classes
    Extension
  15. def destroyWhenRemainingTasksFinished: Unit

    convenience for calling waitUntilRemainingTasksFinished and then destroy

    convenience for calling waitUntilRemainingTasksFinished and then destroy

    Definition Classes
    Extension
  16. def diesWith(implicit that: Killable): FrameitPlugin.this.type

    gives a killable object the same kill button as one that is already around

    gives a killable object the same kill button as one that is already around

    For example, when processing a task, generates a subtask, this should be called on the subtask to ensure killing the overall task also kills the subtask.

    Definition Classes
    Killable
  17. val dpath: DPath
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  20. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. lazy val fv: FrameViewer
  22. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. def getFromFirstArgOrEnvvar(args: List[String], name: String, default: String = ""): String
    Attributes
    protected
    Definition Classes
    Extension
  24. def getReports: List[MMTTaskProgress]

    get all reports in reverse chronological order

    get all reports in reverse chronological order

    Definition Classes
    MMTTask
  25. def getdomcod: (Theory, Theory)
  26. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  27. def initOther(e: Extension): Unit

    any extension can initialize other extensions if those are not meant to be added to the ExtensionManager

    any extension can initialize other extensions if those are not meant to be added to the ExtensionManager

    Attributes
    protected
    Definition Classes
    Extension
  28. def isApplicable(cont: String): Boolean

    cont

    the context of the request

    returns

    true if cont is equal to this.context

    Definition Classes
    ServerExtension → FormatBasedExtension
  29. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  30. def isKilled: Boolean

    processing should be aborted gracefully if true

    processing should be aborted gracefully if true

    Definition Classes
    Killable
  31. def kill: Unit

    signals aborting of processing

    signals aborting of processing

    Definition Classes
    Killable
  32. def log(e: Error): Unit

    logs an error - always logged

    logs an error - always logged

    Attributes
    protected
    Definition Classes
    Logger
  33. def log(s: ⇒ String, subgroup: Option[String] = None): Unit

    logs a message with this logger's logprefix

    logs a message with this logger's logprefix

    Attributes
    protected
    Definition Classes
    Logger
  34. def logError(s: ⇒ String): Unit

    log as an error message

    log as an error message

    Attributes
    protected
    Definition Classes
    Logger
  35. def logGroup[A](a: ⇒ A): A

    wraps around a group to create nested logging

    wraps around a group to create nested logging

    Attributes
    protected
    Definition Classes
    Logger
  36. val logPrefix: String

    the prefix used to identify this extension for logging, by default the class name

    the prefix used to identify this extension for logging, by default the class name

    Definition Classes
    FrameitPlugin → Extension → Logger
  37. def logTemp(s: ⇒ String): Unit

    temporary logging - always logged

    temporary logging - always logged

    Attributes
    protected
    Definition Classes
    Logger
  38. def makeErrorThrower(msg: String): ErrorHandler

    an ErrorHandler that wraps an error in a LocalError and throws it

    an ErrorHandler that wraps an error in a LocalError and throws it

    Attributes
    protected
    Definition Classes
    Extension
  39. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  40. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  41. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  42. val pathPrefix: String
    Definition Classes
    ServerExtension
  43. def removeListener(l: MMTTaskProgressListener): Unit
    Definition Classes
    MMTTask
  44. val report: Report
    Attributes
    protected
    Definition Classes
    Extension → Logger
  45. def reportProgress(a: MMTTaskProgress): Unit

    adds a report and forwards it to all listeners

    adds a report and forwards it to all listeners

    Definition Classes
    MMTTask
  46. def run(solthS: String, vpathS: String): String
  47. def setTimeout[A](millisec: Int)(f: () ⇒ Unit): FrameitPlugin.this.type

    presses the kill button after the specified number of milli seconds

    presses the kill button after the specified number of milli seconds

    Definition Classes
    Killable
  48. val sitpath: MPath
  49. def sittheory: Theory
  50. def start(args: List[String]): Unit

    extension-specific initialization (override as needed, empty by default)

    extension-specific initialization (override as needed, empty by default)

    Definition Classes
    Extension
  51. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  52. def toString(): String
    Definition Classes
    AnyRef → Any
  53. implicit val unifun: (StructuralElement) ⇒ Unit
  54. def view: View
  55. val viewpath: MPath
  56. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  57. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  58. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  59. def waitUntilRemainingTasksFinished: Unit

    extensions that process tasks in separate threads should override this and wait until those threads are done

    extensions that process tasks in separate threads should override this and wait until those threads are done

    Definition Classes
    Extension

Inherited from MMTTask

Inherited from Killable

Inherited from ServerExtension

Inherited from FormatBasedExtension

Inherited from Extension

Inherited from Logger

Inherited from AnyRef

Inherited from Any

Ungrouped