alloyeditor

  • API Docs for Version: 1.2.5

    • Show:

    CKEDITOR.Link Class

    Defined in: src/core/link.js:7

    Link class utility. Provides methods for create, delete and update links.

    Constructor

    Methods

    _getCompleteURI

    (
    • URI
    )
    String protected

    Defined in src/core/link.js:199

    Checks if the URI has an '@' symbol. If it does and the URI looks like an email and doesn't have 'mailto:', 'mailto:' is added to the URI. If it doesn't and the URI doesn't have a scheme, the default 'http' scheme with hierarchical path '//' is added to the URI.

    Parameters:

    • URI String

      The URI of the link.

    Returns:

    String:

    The URI updated with the protocol.

    advanceSelection

    (
    • link
    )

    Defined in src/core/link.js:23

    Advances the editor selection to the next available position after a given link or the one in the current selection.

    Parameters:

    • link CKEDITOR.dom.element

      The link element which link style should be removed.

    create

    (
    • URI
    • attrs
    • modifySelection
    )

    Defined in src/core/link.js:53

    Create a link with given URI as href.

    Parameters:

    • URI String

      The URI of the link.

    • attrs Object

      A config object with link attributes. These might be arbitrary DOM attributes.

    • modifySelection Object

      A config object with an advance attribute to indicate if the selection should be moved after the link creation.

    getFromSelection

    () CKEDITOR.dom.element

    Defined in src/core/link.js:94

    Retrieves a link from the current selection.

    Returns:

    CKEDITOR.dom.element:

    The retrieved link or null if not found.

    remove

    (
    • link
    • modifySelection
    )

    Defined in src/core/link.js:120

    Removes a link from the editor.

    Parameters:

    • link CKEDITOR.dom.element

      The link element which link style should be removed.

    • modifySelection Object

      A config object with an advance attribute to indicate if the selection should be moved after the link creation.

    update

    (
    • attrs
    • link
    • modifySelection
    )

    Defined in src/core/link.js:154

    Updates the href of an already existing link.

    Parameters:

    • attrs Object | String

      The attributes to update or remove. Attributes with null values will be removed.

    • link CKEDITOR.dom.element

      The link element which href should be removed.

    • modifySelection Object

      A config object with an advance attribute to indicate if the selection should be moved after the link creation.