org.xwiki.wysiwyg.server
Interface WysiwygEditorConfiguration


@Role
public interface WysiwygEditorConfiguration

WYSIWYG editor configuration properties.

Version:
$Id: 9a8475dfce6307d484e193325a3364b6244463a2 $

Method Summary
 Boolean areExternalImagesAllowed()
           
 String getColorPalette()
           
 Integer getColorsPerRow()
           
 String getFontNames()
           
 String getFontSizes()
           
 Integer getHistorySize()
           
 String getMenuBar()
           
 String getPlugins()
           
 String getStyleNames()
           
 String getToolBar()
           
 Boolean isAttachmentSelectionLimited()
           
 Boolean isImageSelectionLimited()
           
 Boolean isSourceEditorEnabled()
           
 

Method Detail

isSourceEditorEnabled

Boolean isSourceEditorEnabled()
Returns:
true if the WYSIWYG/Source tabs are enabled, null if this configuration property is not set, false otherwise

getPlugins

String getPlugins()
Returns:
the list of plugins that are loaded by the WYSIWYG editor

getMenuBar

String getMenuBar()
Returns:
the list of entries on the WYSIWYG editor menu bar

getToolBar

String getToolBar()
Returns:
the list of features available on the WYSIWYG editor tool bar

isAttachmentSelectionLimited

Boolean isAttachmentSelectionLimited()
Returns:
true if the user is allowed to choose only from the attachments of the edited page when creating a link to an attachment, null if this configuration property is not set, false otherwise

areExternalImagesAllowed

Boolean areExternalImagesAllowed()
Returns:
true if users are allowed to insert external images, i.e. images that are not attached to a wiki page, null if this configuration property is not set, false otherwise

isImageSelectionLimited

Boolean isImageSelectionLimited()
Returns:
true if the user is allowed to choose only from the list of images attached to the edited page when inserting an image, null if this configuration property is not set, false otherwise
See Also:
isAttachmentSelectionLimited()

getColorPalette

String getColorPalette()
Returns:
the colors available in the color picker

getColorsPerRow

Integer getColorsPerRow()
Returns:
the number of colors to display per row in the color picker, or null if this configuration property is not set

getFontNames

String getFontNames()
Returns:
the list of font names available in the font picker

getFontSizes

String getFontSizes()
Returns:
the list of font sizes available in the font picker

getStyleNames

String getStyleNames()
Returns:
the list of style names available in the style picker

getHistorySize

Integer getHistorySize()
Returns:
the maximum number of history entries that will be stored


Copyright © 2004-2012 XWiki. All Rights Reserved.