KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > riotfamily > components > editor > ComponentEditor


1 /* ***** BEGIN LICENSE BLOCK *****
2  * Version: MPL 1.1
3  * The contents of this file are subject to the Mozilla Public License Version
4  * 1.1 (the "License"); you may not use this file except in compliance with
5  * the License. You may obtain a copy of the License at
6  * http://www.mozilla.org/MPL/
7  *
8  * Software distributed under the License is distributed on an "AS IS" basis,
9  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
10  * for the specific language governing rights and limitations under the
11  * License.
12  *
13  * The Original Code is Riot.
14  *
15  * The Initial Developer of the Original Code is
16  * Neteye GmbH.
17  * Portions created by the Initial Developer are Copyright (C) 2006
18  * the Initial Developer. All Rights Reserved.
19  *
20  * Contributor(s):
21  * Felix Gnass [fgnass at neteye dot de]
22  *
23  * ***** END LICENSE BLOCK ***** */

24 package org.riotfamily.components.editor;
25
26 import java.util.List JavaDoc;
27 import java.util.Map JavaDoc;
28
29 import org.riotfamily.components.context.RequestContextExpiredException;
30
31 /**
32  * Interface used by the Riot Toolbar to edit components. All methods defined
33  * by this interface are exposed to the JavaScript client via DWR.
34  *
35  * @author Felix Gnass [fgnass at neteye dot de]
36  */

37 public interface ComponentEditor {
38
39     public static final String JavaDoc POSTION_CLASS_PREFIX = "component-";
40
41     public static final String JavaDoc LAST_COMPONENT_CLASS = "last-component";
42
43     public String JavaDoc getText(Long JavaDoc containerId, String JavaDoc property);
44
45     public void updateText(Long JavaDoc containerId, String JavaDoc property, String JavaDoc text);
46
47     public void updateTextChunks(Long JavaDoc containerId, String JavaDoc property,
48             String JavaDoc[] chunks);
49
50     public List JavaDoc getValidTypes(String JavaDoc controllerId);
51
52     public Long JavaDoc insertComponent(Long JavaDoc listId, int position, String JavaDoc type,
53             Map JavaDoc properties);
54
55     public void setType(Long JavaDoc containerId, String JavaDoc type);
56
57     public String JavaDoc getLiveListHtml(String JavaDoc controllerId, Long JavaDoc listId)
58             throws RequestContextExpiredException;
59
60     public String JavaDoc getPreviewListHtml(String JavaDoc controllerId, Long JavaDoc listId)
61             throws RequestContextExpiredException;
62
63     public void moveComponent(Long JavaDoc containerId, Long JavaDoc nextContainerId);
64
65     public void deleteComponent(Long JavaDoc containerId);
66
67     public void publish(Long JavaDoc listId, Long JavaDoc[] containerIds);
68
69     public void discard(Long JavaDoc listId, Long JavaDoc[] containerIds);
70
71     public void keepAlive();
72
73     public void logout();
74
75     public Map JavaDoc getEditorConfigs();
76
77 }
Popular Tags