]> git.argeo.org Git - lgpl/argeo-commons.git/blob - org.argeo.cms.ui/src/org/argeo/cms/ui/eclipse/forms/IFormColors.java
Improve documentation.
[lgpl/argeo-commons.git] / org.argeo.cms.ui / src / org / argeo / cms / ui / eclipse / forms / IFormColors.java
1 package org.argeo.cms.ui.eclipse.forms;
2
3 /**
4 * A place to hold all the color constants used in the forms package.
5 *
6 * @since 1.0
7 */
8
9 public interface IFormColors {
10 /**
11 * A prefix for all the keys.
12 */
13 String PREFIX = "org.eclipse.ui.forms."; //$NON-NLS-1$
14 /**
15 * Key for the form title foreground color.
16 */
17 String TITLE = PREFIX + "TITLE"; //$NON-NLS-1$
18
19 /**
20 * A prefix for the header color constants.
21 */
22 String H_PREFIX = PREFIX + "H_"; //$NON-NLS-1$
23 /*
24 * A prefix for the section title bar color constants.
25 */
26 String TB_PREFIX = PREFIX + "TB_"; //$NON-NLS-1$
27 /**
28 * Key for the form header background gradient ending color.
29 */
30 String H_GRADIENT_END = H_PREFIX + "GRADIENT_END"; //$NON-NLS-1$
31
32 /**
33 * Key for the form header background gradient starting color.
34 *
35 */
36 String H_GRADIENT_START = H_PREFIX + "GRADIENT_START"; //$NON-NLS-1$
37 /**
38 * Key for the form header bottom keyline 1 color.
39 *
40 */
41 String H_BOTTOM_KEYLINE1 = H_PREFIX + "BOTTOM_KEYLINE1"; //$NON-NLS-1$
42 /**
43 * Key for the form header bottom keyline 2 color.
44 *
45 */
46 String H_BOTTOM_KEYLINE2 = H_PREFIX + "BOTTOM_KEYLINE2"; //$NON-NLS-1$
47 /**
48 * Key for the form header light hover color.
49 *
50 */
51 String H_HOVER_LIGHT = H_PREFIX + "H_HOVER_LIGHT"; //$NON-NLS-1$
52 /**
53 * Key for the form header full hover color.
54 *
55 */
56 String H_HOVER_FULL = H_PREFIX + "H_HOVER_FULL"; //$NON-NLS-1$
57
58 /**
59 * Key for the tree/table border color.
60 */
61 String BORDER = PREFIX + "BORDER"; //$NON-NLS-1$
62
63 /**
64 * Key for the section separator color.
65 */
66 String SEPARATOR = PREFIX + "SEPARATOR"; //$NON-NLS-1$
67
68 /**
69 * Key for the section title bar background.
70 */
71 String TB_BG = TB_PREFIX + "BG"; //$NON-NLS-1$
72
73 /**
74 * Key for the section title bar foreground.
75 */
76 String TB_FG = TB_PREFIX + "FG"; //$NON-NLS-1$
77
78 /**
79 * Key for the section title bar gradient.
80 * @deprecated Since 3.3, this color is not used any more. The
81 * tool bar gradient is created starting from {@link #TB_BG} to
82 * the section background color.
83 */
84 String TB_GBG = TB_BG;
85
86 /**
87 * Key for the section title bar border.
88 */
89 String TB_BORDER = TB_PREFIX + "BORDER"; //$NON-NLS-1$
90
91 /**
92 * Key for the section toggle color. Since 3.1, this color is used for all
93 * section styles.
94 */
95 String TB_TOGGLE = TB_PREFIX + "TOGGLE"; //$NON-NLS-1$
96
97 /**
98 * Key for the section toggle hover color.
99 *
100 */
101 String TB_TOGGLE_HOVER = TB_PREFIX + "TOGGLE_HOVER"; //$NON-NLS-1$
102 }