Classes

Class	Line #	Total Statements	% Filtered	Complexity	Uncovered Elements	TOTAL Coverage	Actions
WysiwygEditorConfiguration	30	0	-	0	0	-1.0 -	Show methods

Class WysiwygEditorConfiguration

Class WysiwygEditorConfiguration	Line # 30	Total Statements 0	% Filtered -	Complexity 0	Uncovered Elements 0	TOTAL Coverage -1.0 -

 

Contributing tests

Source view

1		/*
2		* See the NOTICE file distributed with this work for additional
3		* information regarding copyright ownership.
4		*
5		* This is free software; you can redistribute it and/or modify it
6		* under the terms of the GNU Lesser General Public License as
7		* published by the Free Software Foundation; either version 2.1 of
8		* the License, or (at your option) any later version.
9		*
10		* This software is distributed in the hope that it will be useful,
11		* but WITHOUT ANY WARRANTY; without even the implied warranty of
12		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13		* Lesser General Public License for more details.
14		*
15		* You should have received a copy of the GNU Lesser General Public
16		* License along with this software; if not, write to the Free
17		* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18		* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19		*/
20		package org.xwiki.wysiwyg.server;
21
22		import org.xwiki.component.annotation.Role;
23
24		/**
25		* WYSIWYG editor configuration properties.
26		*
27		* @version $Id: 1885cf50e492825c3a5a92ca11e78120b5bc67dc $
28		*/
29		@Role
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
30		public interface WysiwygEditorConfiguration
31		{
32		/**
33		* @return {@code true} if the WYSIWYG/Source tabs are enabled, {@code null} if this configuration property is not
34		* set, {@code false} otherwise
35		*/
36		Boolean isSourceEditorEnabled();
37
38		/**
39		* @return the list of plugins that are loaded by the WYSIWYG editor
40		*/
41		String getPlugins();
42
43		/**
44		* @return the list of entries on the WYSIWYG editor menu bar
45		*/
46		String getMenuBar();
47
48		/**
49		* @return the list of features available on the WYSIWYG editor tool bar
50		*/
51		String getToolBar();
52
53		/**
54		* @return {@code true} if the user is allowed to choose only from the attachments of the edited page when creating
55		* a link to an attachment, {@code null} if this configuration property is not set, {@code false} otherwise
56		*/
57		Boolean isAttachmentSelectionLimited();
58
59		/**
60		* @return {@code true} if users are allowed to insert external images, i.e. images that are not attached to a wiki
61		* page, {@code null} if this configuration property is not set, {@code false} otherwise
62		*/
63		Boolean areExternalImagesAllowed();
64
65		/**
66		* @return {@code true} if the user is allowed to choose only from the list of images attached to the edited page
67		* when inserting an image, {@code null} if this configuration property is not set, {@code false} otherwise
68		* @see #isAttachmentSelectionLimited()
69		*/
70		Boolean isImageSelectionLimited();
71
72		/**
73		* @return the colors available in the color picker
74		*/
75		String getColorPalette();
76
77		/**
78		* @return the number of colors to display per row in the color picker, or {@code null} if this configuration
79		* property is not set
80		*/
81		Integer getColorsPerRow();
82
83		/**
84		* @return the list of font names available in the font picker
85		*/
86		String getFontNames();
87
88		/**
89		* @return the list of font sizes available in the font picker
90		*/
91		String getFontSizes();
92
93		/**
94		* @return the list of style names available in the style picker
95		*/
96		String getStyleNames();
97
98		/**
99		* @return the maximum number of history entries that will be stored
100		*/
101		Integer getHistorySize();
102
103		/**
104		* @return {@code true} if the content pasted into the rich text area should be cleaned automatically, {@code false}
105		* otherwise (the user can trigger the clean manually using the tool bar icon)
106		*/
107		Boolean isPasteContentCleanedAutomatically();
108		}