KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jahia > services > htmleditors > HtmlEditor


1 //
2 // ____.
3 // __/\ ______| |__/\. _______
4 // __ .____| | \ | +----+ \
5 // _______| /--| | | - \ _ | : - \_________
6 // \\______: :---| : : | : | \________>
7 // |__\---\_____________:______: :____|____:_____\
8 // /_____|
9 //
10 // . . . i n j a h i a w e t r u s t . . .
11 //
12 //
13
14 package org.jahia.services.htmleditors;
15
16 /**
17  * <p>Title: HtmlEditor Interface</p>
18  * <p>Description: Interface for Html Editor</p>
19  * <p>Copyright: Copyright (c) 2002</p>
20  * <p>Company: Jahia S.A.R.L</p>
21  * @author Khue Nguyen
22  * @version 1.0
23  */
24
25 public interface HtmlEditor {
26
27     /**
28      * Returns the unique identifier.
29      *
30      * @return the unique identifier
31      */
32     public abstract String JavaDoc getId();
33
34     /**
35      * Returns the visual Display Name
36      *
37      * @return the visual Display name
38      */
39     public abstract String JavaDoc getDisplayName();
40
41     /**
42      * Returns the base directory relative to
43      *
44      * <jahia-home>/jsp/jahia/htmleditors
45      *
46      * @return
47      */
48     public abstract String JavaDoc getBaseDirectory();
49
50     /**
51      * Returns the path to the file containing the HTML Editor.
52      * This file will be included in Content Editor View ( Jahia Update Engine ).
53      * The path must be relative to Jahia's HtmlEditor root path:
54      *
55      * <jahia-home>/jsp/jahia/htmleditors
56      *
57      * @return
58      */
59     public abstract String JavaDoc getIncludeFile();
60
61     /**
62      * Returns true if this Editor can run given Client Capabilities.
63      *
64      * @param clientCapabilities
65      * @return true if this Editor can run for the given ClientCapabilities
66      */
67     public abstract boolean isClientCapable(ClientCapabilities clientCapabilities);
68
69     /**
70      * Returns true if this Editor is authorized for a given site.
71      *
72      * @param siteID
73      * @return true if the given site has autorization to use this Editor
74      */
75     public abstract boolean isSiteAuthorized(int siteID);
76
77     /**
78      * Returns true if this Editor support CSS.
79      *
80      * @return true if CSS selection should be displayed for this CSS
81      */
82     public abstract boolean enableCSS();
83
84 }
Popular Tags