org.xwiki.edit

Interface EditConfiguration

@Role
 @Unstable
public interface EditConfiguration

Edit configuration options.

Since:

8.2RC1

Version:

$Id: 262a94895c9ae64b7330093043b9c303824c9f22 $

Method Summary

Modifier and Type	Method and Description
String	getDefaultEditor(Type dataType) Returns the component hint of the configured default editor or the id of the configured default editor category associated with the specified data type.
String	getDefaultEditor(Type dataType, 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 specified data type.

Method Detail

getDefaultEditor

String getDefaultEditor(Type dataType)

Returns the component hint of the configured default editor or the id of the configured default editor category associated with the specified data type. Returns null if there's no configured default editor or default editor category for the specified data type.

Parameters:

dataType - some data type

Returns:

an editor component hint, or a editor category id or null

getDefaultEditor

String getDefaultEditor(Type dataType,
                        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 specified data type. Returns null if there's no configured default editor or default editor sub-category for the specified data type.

Parameters:

dataType - some data type

category - some editor category

Returns:

an editor component hint, or a editor sub-category id or null