Package org.xwiki.edit

Interface EditorManager

  • @Role
public interface EditorManager
    Manages the available Editors.
    Since:
    8.2RC1
    Version:
    $Id: 93ff5d1806ec777d97c6e9b6cb0be53bd611b1e0 $

    • Method Detail

      • getEditors

        <D> List<Editor<D>> getEditors​(Type dataType)
        Type Parameters:
        D - the data type
        Parameters:
        dataType - the data type
        Returns:
        the list of editors that can edit the specified type of data

      • getEditors

        <D> List<Editor<D>> getEditors​(Type dataType,
                               String category)
        Type Parameters:
        D - the data type
        Parameters:
        dataType - the data type
        category - the editor category
        Returns:
        the list of editors that have the specified category and which are associated with the given data type

      • getEditor

        <D> Editor<D> getEditor​(Type dataType,
                        String hint)
        Type Parameters:
        D - the data type
        Parameters:
        dataType - the data type
        hint - the Editor component role hint
        Returns:
        an editor that can edit the specified data type and which has the given Editor component role hint, or null if no such editor can be found

      • getDefaultEditor

        <D> Editor<D> getDefaultEditor​(Type dataType)
        Type Parameters:
        D - the data type
        Parameters:
        dataType - the data type
        Returns:
        the configured default editor associated with the specified data type

      • getDefaultEditor

        <D> Editor<D> getDefaultEditor​(Type dataType,
                               String category)
        Type Parameters:
        D - the data type
        Parameters:
        dataType - the data type
        category - the editor category
        Returns:
        the configured default editor that has the specified category and which is associated with the given data type