Package org.xwiki.edit

Interface EditorConfiguration<D>

  • Type Parameters:
    D - the type of data that is edited by the editors affected by this configuration
    @Role
public interface EditorConfiguration<D>
    Interface used to customize the EditConfiguration for a specific data type. It allows you to:
    • reuse some existing configuration properties that don't follow the conventions established by the EditConfiguration
    • specify the default editor when there's no one configured
    .
    Since:
    8.2RC1
    Version:
    $Id: aefc6e5caf5ca08be62ebad6d0e782ad80f10eb0 $

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getDefaultEditor()
      Returns the component hint of the configured default editor or the id of the configured default editor category associated with the data type bound to this configuration.
      String getDefaultEditor​(String category)
      Returns the component hint of the configured default editor within the specified category, or the id of the configured default editor sub-category within the specified category, associated with the data type bound to this configuration.

    • Method Detail

      • getDefaultEditor

        String getDefaultEditor()
        Returns the component hint of the configured default editor or the id of the configured default editor category associated with the data type bound to this configuration. Returns null if there's no configured default editor or default editor category for the data type bound to this configuration.
        Returns:
        an editor component hint, or a editor category id or null

      • getDefaultEditor

        String getDefaultEditor​(String category)
        Returns the component hint of the configured default editor within the specified category, or the id of the configured default editor sub-category within the specified category, associated with the data type bound to this configuration. Returns null if there's no configured default editor or default editor sub-category for the data type bound to this configuration.
        Parameters:
        category - some editor category
        Returns:
        an editor component hint, or a editor sub-category id or null