001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.ui.components;
029
030import org.opencms.main.OpenCms;
031import org.opencms.util.CmsStringUtil;
032
033/**
034 * Contains the CSS style name constants used within the theme.<p>
035 */
036public final class OpenCmsTheme {
037
038    /** CSS style name. */
039    public static final String APP_BUTTON = "o-app-button";
040
041    /** CSS style name. */
042    public static final String APP_BUTTON_PADDED = "o-app-button-padded";
043
044    /** CSS style name. */
045    public static final String APP_CONTENT = "o-app-content";
046
047    /** CSS style name. */
048    public static final String APP_INFO = "o-app-info";
049
050    /** CSS style name. */
051    public static final String BOOKMARKS_PLACEHOLDER = "o-bookmarks-placeholder";
052
053    /** CSS style name. */
054    public static final String BUTTON_BLUE = "o-button-blue";
055
056    /** CSS style name. */
057    public static final String BUTTON_ICON = "o-button-icon";
058
059    /** CSS style name. */
060    public static final String BUTTON_INVISIBLE = "o-button-invisible";
061
062    /** CSS style name. */
063    public static final String BUTTON_OVERLAY = "o-button-overlay";
064
065    /** CSS style name. */
066    public static final String BUTTON_OVERLAY_BLUE = "o-button-overlay-blue";
067
068    /** CSS style name. */
069    public static final String BUTTON_OVERLAY_BLUE_INVERSE = "o-button-overlay-blue-inv";
070
071    /** CSS style name. */
072    public static final String BUTTON_OVERLAY_BLUE_LIGHT = "o-button-overlay-blue-light";
073
074    /** CSS style name. */
075    public static final String BUTTON_OVERLAY_CYAN = "o-button-overlay-cyan";
076
077    /** CSS style name. */
078    public static final String BUTTON_OVERLAY_CYAN_INVERSE = "o-button-overlay-cyan-inv";
079
080    /** CSS style name. */
081    public static final String BUTTON_OVERLAY_GRAY_LIGHT = "o-button-overlay-gray-light";
082
083    /** CSS style name. */
084    public static final String BUTTON_OVERLAY_GREEN = "o-button-overlay-green";
085
086    /** CSS style name. */
087    public static final String BUTTON_OVERLAY_ORANGE = "o-button-overlay-orange";
088
089    /** CSS style name. */
090    public static final String BUTTON_OVERLAY_RED = "o-button-overlay-red";
091
092    /** CSS style name. */
093    public static final String BUTTON_PRESSED = "o-button-pressed";
094
095    /** CSS style name. */
096    public static final String BUTTON_SITE = "o-button-site";
097
098    /** CSS style name. */
099    public static final String BUTTON_TABLE_ICON = "o-button-table-icon";
100
101    /** CSS style name. */
102    public static final String BUTTON_UNPADDED = "o-button-unpadded";
103
104    /** CSS style name. */
105    public static final String COLOR_BLUE = "o-color-blue";
106
107    /** CSS style name. */
108    public static final String COLOR_CYAN = " o-color-cyan";
109
110    /** CSS style name. */
111    public static final String COLOR_GRAY = "o-color-gray";
112
113    /** CSS style name. */
114    public static final String COLOR_ORANGE = "o-color-orange";
115
116    /** CSS style name. */
117    public static final String COLOR_RED = "o-color-red";
118
119    /** CSS style name. */
120    public static final String CRUMB_WRAPPER = "o-crumb-wrapper";
121
122    /** CSS style name. */
123    public static final String CRUMBS = "o-crumbs";
124
125    /** CSS style name. */
126    public static final String DIALOG = "o-dialog";
127
128    /** CSS style name. */
129    public static final String DIALOG_BUTTON_BAR = "o-dialog-button-bar";
130
131    /** CSS style name. */
132    public static final String DIALOG_CONTENT = "o-dialog-content";
133
134    /** CSS style name. */
135    public static final String DIALOG_CONTENT_PANEL = "o-dialog-content-panel";
136
137    /** CSS style name. */
138    public static final String DIALOG_FORM = "o-dialog-form";
139
140    /** CSS style name. */
141    public static final String DIFF_TYPE_ADDED = "diffTypeAdded";
142
143    /** CSS style name. */
144    public static final String DIFF_TYPE_CHANGED = "diffTypeChanged";
145
146    /** CSS style name. */
147    public static final String DIFF_TYPE_DELETED = "diffTypeDeleted";
148
149    /** CSS style name. */
150    public static final String DIFF_TYPE_UNCHANGED = "diffTypeUnchanged";
151
152    /** CSS style name. */
153    public static final String DISABLED = "o-disabled";
154
155    /** CSS style name. */
156    public static final String DROPDOWN = "o-dropdown";
157
158    /** CSS style name. */
159    public static final String EXPIRED = "o-expired";
160
161    /** CSS style name. */
162    public static final String FILE_TREE = "o-file-tree";
163
164    /** CSS style name. */
165    public static final String FORMLAYOUT_WORKPLACE_MAIN = "o-formlayout-workplace-main";
166
167    /** CSS style name. */
168    public static final String FULL_WIDTH_PADDING = "o-full-width-padding";
169
170    /** CSS style name. */
171    public static final String HIDDEN = "hidden";
172
173    /** CSS style name. */
174    public static final String HIDDEN_TOOLBAR = "o-hidden-toolbar";
175
176    /** CSS style name. */
177    public static final String HOVER_COLUMN = "o-hover-column";
178
179    /** The cache icon CSS class.*/
180    public static final String ICON_CACHE = "oc-icon-24-cache";
181
182    /** The database icon CSS class. */
183    public static final String ICON_DATABASE = "oc-icon-24-database";
184
185    /** CSS style name.*/
186    public static final String ICON_EXLPORER = "oc-icon-24-folder";
187
188    /** CSS style name.*/
189    public static final String ICON_EXLPORER_BIG = "oc-icon-32-explorer";
190
191    /** The group icon CSS class. */
192    public static final String ICON_GROUP = "oc-icon-24-group";
193
194    /** The job icon CSS class. */
195    public static final String ICON_JOB = "oc-icon-24-scheduler";
196
197    /**The Log icon. */
198    public static final String ICON_LOG = "oc-icon-24-log";
199
200    /**Icon for OUs. */
201    public static final String ICON_OU = "oc-icon-24-orgunit";
202
203    /**Icon for OUs for web user. */
204    public static final String ICON_OU_WEB = "oc-icon-24-webuser";
205
206    /** The icon for all principal option (currently used in principal select).*/
207    public static final String ICON_PRINCIPAL_ALL = "oc-icon-24-principal-all";
208
209    /** The icon for overwriting principal (currently used in principal select).*/
210    public static final String ICON_PRINCIPAL_OVERWRITE = "oc-icon-24-principal-overwrite";
211
212    /** The project icon CSS class. */
213    public static final String ICON_PROJECT = "oc-icon-24-project";
214
215    /** Path to the project current theme resource. */
216    public static final String ICON_PROJECT_CURRENT = "oc-icon-24-project_yellow";
217
218    /** Path to the project other theme resource. */
219    public static final String ICON_PROJECT_OTHER = "oc-icon-24-project_red";
220
221    /** Path to the project publish theme resource. */
222    public static final String ICON_PUBLISH = "oc-icon-24-publish";
223
224    /** The role icon CSS class.*/
225    public static final String ICON_ROLE = "oc-icon-24-role";
226
227    /**The session icon.*/
228    public static final String ICON_SESSION = "oc-icon-24-session";
229
230    /** The cache icon CSS class. */
231    public static final String ICON_SITE = "oc-icon-24-site";
232
233    /** CSS style name.*/
234    public static final String ICON_TERMINAL = "oc-icon-32-terminal";
235
236    /** CSS style name.*/
237    public static final String ICON_TOOL_1 = "oc-icon-32-tool1";
238
239    /** CSS style name.*/
240    public static final String ICON_TOOL_2 = "oc-icon-32-tool2";
241
242    /** CSS style name.*/
243    public static final String ICON_TOOL_3 = "oc-icon-32-tool3";
244
245    /** CSS style name.*/
246    public static final String ICON_TOOL_4 = "oc-icon-32-tool4";
247
248    /** CSS style name.*/
249    public static final String ICON_TOOL_5 = "oc-icon-32-tool5";
250
251    /** The user icon CSS class.*/
252    public static final String ICON_USER = "oc-icon-24-user";
253
254    /** CSS style name. */
255    public static final String IMAGE_GRADIENT = "o-image-gradient";
256
257    /** CSS style name. */
258    public static final String IMAGE_TRANSPARENT = "o-image-transparent";
259
260    /** CSS style name. */
261    public static final String IN_NAVIGATION = "o-in-navigation";
262
263    /** CSS style name. */
264    public static final String INFO = "o-info-dialog";
265
266    /** CSS style name. */
267    public static final String INFO_ELEMENT_NAME = "o-info-dialog-name";
268
269    /** CSS style name. */
270    public static final String INFO_ELEMENT_VALUE = "o-info-dialog-value";
271
272    /** CSS style name. */
273    public static final String INLINE_TEXTFIELD = "o-inline-textfield";
274
275    /** CSS style name. */
276    public static final String LABEL_ERROR = "o-label-error";
277
278    /** CSS style name. */
279    public static final String LOCK_OTHER = "o-lock-other";
280
281    /** CSS style name. */
282    public static final String LOCK_PUBLISH = "o-lock-publish";
283
284    /** CSS style name. */
285    public static final String LOCK_SHARED = "o-lock-shared";
286
287    /** CSS style name. */
288    public static final String LOCK_USER = "o-lock-user";
289    /** CSS style name. */
290    public static final String MAIN = "o-main";
291
292    /** CSS style name. */
293    public static final String NAVIGATOR_DROPDOWN = "o-navigator-dropdown";
294    /** CSS style name. */
295    public static final String NO_TRANSLATION_ICON = "o-notranslation";
296
297    /** Path to the OpenCms logo theme resource. */
298    public static final String OPENCMS_LOGO_PATH = "img/opencmsLogo.png";
299
300    /** CSS style name. */
301    public static final String PADDING_HORIZONTAL = "o-padding-horizontal";
302
303    /** CSS style name. */
304    public static final String POINTER = "o-pointer";
305
306    /** CSS style name. */
307    public static final String PROJECT_OTHER = "o-project-other";
308
309    /** CSS style name. */
310    public static final String REDUCED_MARGIN = "o-reduced-margin";
311
312    /** CSS style name. */
313    public static final String REDUCED_SPACING = "o-reduced-spacing";
314
315    /** CSS style name. */
316    public static final String REQUIRED_BUTTON = "o-required-button";
317
318    /** CSS style name. */
319    public static final String RESINFO_HIDDEN_ICON = "o-resinfo-hidden-icon";
320
321    /** CSS style name. */
322    public static final String RESINFO_POINTER = "o-resinfo-pointer";
323
324    /** CSS style name. */
325    public static final String RESOURCE_ICON = "o-resource-icon";
326
327    /** CSS style name. */
328    public static final String RESOURCE_INFO = "o-resource-info";
329
330    /** CSS style name. */
331    public static final String RESOURCE_INFO_DIRECTLINK = "o-resourceinfo-directlink";
332
333    /** CSS style name. */
334    public static final String RESOURCE_INFO_WEAK = "o-resourceinfo-weak";
335
336    /** CSS style name. */
337    public static final String RESPONSIVE = "o-responsive";
338
339    /** CSS style name. */
340    public static final String SECURITY = "o-security";
341
342    /** CSS style name. */
343    public static final String SECURITY_INVALID = SECURITY + "-invalid";
344
345    /** CSS style name. */
346    public static final String SECURITY_STRONG = SECURITY + "-strong";
347
348    /** CSS style name. */
349    public static final String SECURITY_WEAK = SECURITY + "-weak";
350
351    /** CSS style name. */
352    public static final String SIBLING = "o-sibling";
353
354    /** CSS style name. */
355    public static final String SIMPLE_DRAG = "o-simple-drag";
356
357    /** CSS style name. */
358    public static final String SITEMAP_LOCALE_BAR = "o-sitemap-locale-bar";
359
360    /** CSS style name. */
361    public static final String STATE_CHANGED = "o-state-changed";
362
363    /** CSS style name. */
364    public static final String STATE_DELETED = "o-state-deleted";
365
366    /** CSS style name. */
367    public static final String STATE_NEW = "o-state-new";
368
369    /** CSS style name.*/
370    public static final String TABLE_CELL_DISABLED = "o-table-cell-disabled";
371
372    /** CSS style name. */
373    public static final String TABLE_CELL_PADDING = "o-table-cell-padding";
374
375    /** CSS style name. */
376    public static final String TABLE_COLUMN_BOX_BLACK = " o-box-black";
377
378    /** CSS style name. */
379    public static final String TABLE_COLUMN_BOX_BLUE = " o-box-blue";
380
381    /** CSS style name. */
382    public static final String TABLE_COLUMN_BOX_BLUE_LIGHT = " o-box-blue-light";
383
384    /** CSS style name. */
385    public static final String TABLE_COLUMN_BOX_CYAN = " o-box-cyan";
386
387    /** CSS style name. */
388    public static final String TABLE_COLUMN_BOX_DARKGRAY = " o-box-gray-darker";
389
390    /** CSS style name. */
391    public static final String TABLE_COLUMN_BOX_DARKRED = " o-box-red-dark";
392
393    /** CSS style name. */
394    public static final String TABLE_COLUMN_BOX_GRAY = " o-box-gray";
395
396    /** CSS style name. */
397    public static final String TABLE_COLUMN_BOX_GRAY_DARKER = " o-box-gray-darker";
398
399    /** CSS style name. */
400    public static final String TABLE_COLUMN_BOX_GREEN = " o-box-green";
401
402    /** CSS style name. */
403    public static final String TABLE_COLUMN_BOX_ORANGE = " o-box-orange";
404
405    /** CSS style name. */
406    public static final String TABLE_COLUMN_BOX_ORANGE_DARK = " o-box-orange-dark";
407
408    /** CSS style name. */
409    public static final String TABLE_COLUMN_BOX_RED = " o-box-red";
410
411    /** CSS style name. */
412    public static final String TABLE_CONST_COLOR = "o-table-const-color";
413
414    /** CSS style name. */
415    public static final String TOOLABER_APP_INDICATOR = "o-toolbar-app-indicator";
416
417    /** CSS style name. */
418    public static final String TOOLABER_APP_INDICATOR_ONLINE = "o-toolbar-app-indicator-online";
419
420    /** CSS style name. */
421    public static final String TOOLBAR = "o-toolbar";
422
423    /** CSS style name. */
424    public static final String TOOLBAR_BUTTON = "o-toolbar-button";
425
426    /** CSS style name. */
427    public static final String TOOLBAR_CENTER = "o-toolbar-center";
428
429    /** CSS style name. */
430    public static final String TOOLBAR_FIELD = "o-toolbar-field";
431
432    /** CSS style name. */
433    public static final String TOOLBAR_INNER = "o-toolbar-inner";
434
435    /** CSS style name. */
436    public static final String TOOLBAR_ITEMS_LEFT = "o-toolbar-items-left";
437
438    /** CSS style name. */
439    public static final String TOOLBAR_ITEMS_RIGHT = "o-toolbar-items-right";
440
441    /** CSS style name. */
442    public static final String TOOLBAR_LOGO = "o-toolbar-logo";
443
444    /** CSS style name. */
445    public static final String TOOLS_BREADCRUMB = "o-tools-breadcrumb";
446
447    /** CSS style name. */
448    public static final String USER_IMAGE = "o-user-image";
449
450    /** CSS style name. */
451    public static final String USER_INFO = "o-user-info";
452
453    /** CSS style name. */
454    public static final String VERTICAL_MENU = "o-verticalmenu";
455
456    /** CSS style name. */
457    public static final String VERTICAL_MENU_ITEM = "o-verticalmenu-menuitem";
458
459    /** CSS style name. */
460    public static final String WORKPLACE_MAXWIDTH = "o-workplace-maxwidth";
461
462    /** CSS style name. */
463    protected static final String QUICK_LAUNCH = "o-quicklaunch";
464
465    /**
466     * Hidden default constructor.
467     */
468    private OpenCmsTheme() {
469        // hidden default constructor, do nothing
470    }
471
472    /**
473     * Gets the link to an image below the img-extra folder.<p>
474     *
475     * @param imagePath the image path below img-extra
476     *
477     * @return the complete image link
478     */
479    public static String getImageLink(String imagePath) {
480
481        return CmsStringUtil.joinPaths(
482            OpenCms.getSystemInfo().getContextPath(),
483            "VAADIN/themes/opencms/img-extra",
484            imagePath);
485    }
486
487}