Protocols

An object capable of resolving text asynchronously to another representation. New representation may contain change in attributes or the string itself.

Describes an object (typically attachment view) that may change size during the layout pass

Denotes an Attachmentcontent view that observes background color changes in containerEditorView

Describes an object capable of providing offsets for the Attachment. The value is used to offset the Attachment when rendered alongside the text. This may be used to align the content baselines in Attachment content to that of it’s container’s content baselines.

Describes an object that fulfils requirements to enable asynchronous rendering of attachments in the EditorView

Marker protocol for attachment views that may need to defer completion of rendering in asynchronous mode until the view bounds are changed. This may be important for cases like GridView that does not directly contain the Editors within but instead hosts another view that in turn hosts multiple editors i.e. one per cell. Conformance to this protocol defers invoking the didRenderAttachment on AsyncAttachmentRenderingDelegate until the view size are changed to a non-zero value. In absence of this, didRenderAttachment is invoked as soon as the attachment is rendered in the editor.

Describes an object capable of gaining focus.

Describes an object capable of providing numbers to be displayed when isLineNumbersEnabled is set to true in EditorView

Describes an object capable of providing style and formatting information for rendering lists in EditorView.

Represents a Sequence generator that can return a value based on given index. Besides other possible uses, this is used in Lists for generation of bullets/numbering.

An object capable of decoding attributes for use in NSAttributedString

An object capable of decoding the given type of content into NSAttributedString for using in EditorView or the RendererView.

Identifies a content type within the Editor

Undocumented

Describes a view contained in Attachment that contains a single EditorView. This is a helper protocol that can be applied to the view so that basic properties and functions are made available on the view as passthrough.

Describes an object interested in observing the bounds of a view. Attachment is BoundsObserving and reacts to changes in the bounds of views hosted within the Attachment. Any view contained in the Attachment that is capable of changing its bounds must define and set BoundsObserving to Attachment.

Usage Example

 class MyAttachmentView: UIView {
 weak var boundsObserver: BoundsObserving?

 override var bounds: CGRect {
     didSet {
         guard oldValue != bounds else { return }
         boundsObserver?.didChangeBounds(bounds)
     }
    }
 }

 let myView = MyAttachmentView()
 let attachment = Attachment(myView, size: .matchContent)
 myView.boundsObserver = attachment

Describes an object interested in listening to events raised from EditorView

Describes a command that can be executed on EditorView. A command may be invoked directly on the editor by providing an instance. However, in a typical usage scenario, these should be invoked via EditorCommandExecutor which manages all the EditorViews in the view including the ones that are contained in the attachments.

Undocumented

Describes an encoder for a content type in Editor. This can be used in conjunction with AnyEditorTextEncoding to register various encoders for each of the supported content types. ### Usage Example ###

 struct ParagraphEncoder: EditorTextEncoding {
     func encode(name: EditorContent.Name, string: NSAttributedString) -> JSON {
         var paragraph = JSON()
         paragraph.type = name.rawValue
         if let style = string.attribute(.paragraphStyle, at: 0, effectiveRange: nil) as? NSParagraphStyle {
             paragraph[style.key] = style.value
         }
         paragraph.contents = contentsFrom(string)
        return paragraph
     }
 }

Describes an object capable of encoding contents of at Attachment

An object capable of encoding EditorContent to given type.

A generic encoder for encoding EditorContent. You may create encoders for individual types of contents in the Editor, and use EditorContentEncoder to register and encode the all the contents of the given EditorView.

Usage Example

typealias JSON = [String: Any]
struct JSONEncoder: EditorContentEncoder {
    let textEncoders: [EditorContent.Name: AnyEditorTextEncoding<JSON>] = [
        .paragraph: AnyEditorTextEncoding(ParagraphEncoder()),
        .text: AnyEditorTextEncoding(TextEncoder())
    ]
    let attachmentEncoders: [EditorContent.Name: AnyEditorContentAttachmentEncoding<JSON>] = [
       .panel: AnyEditorContentAttachmentEncoding(PanelEncoder()),
       .media: AnyEditorContentAttachmentEncoding(MediaEncoder()),
    ]
}

// Get the encoded content from the editor
let encodedContent = editor.transformContents(using: JSONEncoder())

An object capable of handing GridView events

An object capable of intercepting and modifying the text and attributes in an EditorView when registered with the EditorView.