1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
|
/*
* Copyright 2000-2014 Vaadin Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.vaadin.ui.themes;
import com.vaadin.server.FontAwesome;
import com.vaadin.ui.Notification.Type;
import com.vaadin.ui.Table.ColumnHeaderMode;
/**
* <p>
* Additional style names which can be used with the Valo theme.
* </p>
*
* <p>
* These styles are only available if the
* <code>$v-included-additional-styles</code> Sass list variable contains the
* name of the component for that additional style name (e.g.
* <code>button, textfield, table</code>).
* </p>
*
* <p>
* Most of these additional style names can be included individually into your
* custom theme using the component specific Sass mixins, in which case you can
* also define the style names yourself. See the Valo theme Sass API
* documentation for additional information.
* </p>
*
* TODO link to Sass API documentation
*
* @since 7.3
* @author Vaadin Ltd
*/
public class ValoTheme {
public static final String THEME_NAME = "valo";
/***************************************************************************
*
* Notification styles
*
**************************************************************************/
/**
* Styles the notification to look like {@link Type#TRAY_NOTIFICATION},
* without setting the position and delay. Can be combined with any other
* Notification style.
*/
public static final String NOTIFICATION_TRAY = "tray";
/**
* Styles the notification to look like {@link Type#WARNING_MESSAGE},
* without setting the position and delay. Can be combined with any other
* Notification style.
*/
public static final String NOTIFICATION_WARNING = "warning";
/**
* Styles the notification to look like {@link Type#ERROR_MESSAGE}, without
* setting the position and delay. Can be combined with any other
* Notification style.
*/
public static final String NOTIFICATION_ERROR = "error";
/**
* Styles the notification to look like a system notification. Can be
* combined with any other Notification style.
*/
public static final String NOTIFICATION_SYSTEM = "system";
/**
* Styles the notification to span the entire width of the viewport. Can be
* combined with any other Notification style.
*/
public static final String NOTIFICATION_BAR = "bar";
/**
* Smaller padding and font size for the notification. Can be combined with
* any other Notification style.
*/
public static final String NOTIFICATION_SMALL = "small";
/**
* Adds a close button to the notification to imply that the user must click
* on the notification to dismiss it. Use in combination with an infinite
* delay (<code>-1</code>). Can be combined with any other Notification
* style.
*/
public static final String NOTIFICATION_CLOSABLE = "closable";
/**
* Success notification style. Adds a border around the notification and an
* icon next to the title. Can be combined with any other Label style.
*/
public static final String NOTIFICATION_SUCCESS = "success";
/**
* Failure notification style. Adds a border around the notification and an
* icon next to the title. Can be combined with any other Label style.
*/
public static final String NOTIFICATION_FAILURE = "failure";
/***************************************************************************
*
* Label styles
*
**************************************************************************/
/**
* Header style for main application headings. Can be combined with any
* other Label style.
*/
public static final String LABEL_H1 = "h1";
/**
* Header style for different sections in the application. Can be combined
* with any other Label style.
*/
public static final String LABEL_H2 = "h2";
/**
* Header style for different sub-sections in the application. Can be
* combined with any other Label style.
*/
public static final String LABEL_H3 = "h3";
/**
* Header style for different sub-sections in the application. Can be
* combined with any other Label style.
*/
public static final String LABEL_H4 = "h4";
/**
* A utility style that can be combined with the {@link #LABEL_H1},
* {@link #LABEL_H2}, {@link #LABEL_H3} and {@link #LABEL_H4} styles to
* remove the default margins from the header.
*/
public static final String LABEL_NO_MARGIN = "no-margin";
/**
* Tiny font size. Suitable for additional/supplementary UI text. Can be
* combined with any other Label style.
*/
public static final String LABEL_TINY = "tiny";
/**
* Small font size. Suitable for additional/supplementary UI text. Can be
* combined with any other Label style.
*/
public static final String LABEL_SMALL = "small";
/**
* Large font size. Suitable for important/prominent UI text. Can be
* combined with any other Label style.
*/
public static final String LABEL_LARGE = "large";
/**
* Huge font size. Suitable for important/prominent UI text. Can be combined
* with any other Label style.
*/
public static final String LABEL_HUGE = "huge";
/**
* Lighter font weight. Suitable for additional/supplementary UI text. Can
* be combined with any other Label style.
*/
public static final String LABEL_LIGHT = "light";
/**
* Bolder font weight. Suitable for important/prominent UI text. Can be
* combined with any other Label style.
*/
public static final String LABEL_BOLD = "bold";
/**
* Colored text. Can be combined with any other Label style.
*/
public static final String LABEL_COLORED = "colored";
/**
* Success badge style. Adds a border around the label and an icon next to
* the text. Suitable for UI notifications that need to in the direct
* context of some component. Can be combined with any other Label style.
*/
public static final String LABEL_SUCCESS = "success";
/**
* Failure badge style. Adds a border around the label and an icon next to
* the text. Suitable for UI notifications that need to in the direct
* context of some component. Can be combined with any other Label style.
*/
public static final String LABEL_FAILURE = "failure";
/**
* Spinner style. Add this style name to an empty Label to create a spinner.
*
* <h4>Example</h4>
*
* <pre>
* Label spinner = new Label();
* spinner.addStyleName(ValoTheme.LABEL_SPINNER);
* </pre>
*/
public static final String LABEL_SPINNER = "spinner";
/***************************************************************************
*
* Button styles
*
**************************************************************************/
/**
* Primary action button (e.g. the button that should get activated when the
* user presses the <code>enter</code> key in a form). Use sparingly, only
* one default button per view should be visible. Can be combined with any
* other Button style.
*/
public static final String BUTTON_PRIMARY = "primary";
/**
* A prominent button that can be used instead of the
* {@link #BUTTON_PRIMARY} for primary actions when the action is considered
* <b>safe</b> for the user (i.e. does not cause any data loss or any other
* irreversible action). Can be combined with any other Button style.
*/
public static final String BUTTON_FRIENDLY = "friendly";
/**
* A prominent button that can be used when the action is considered
* <b>unsafe</b> for the user (i.e. it causes data loss or some other
* irreversible action). Can be combined with any other Button style.
*/
public static final String BUTTON_DANGER = "danger";
/**
* Borderless button. Can be combined with any other Button style.
*/
public static final String BUTTON_BORDERLESS = "borderless";
/**
* Borderless button with a colored caption text. Can be combined with any
* other Button style.
*/
public static final String BUTTON_BORDERLESS_COLORED = "borderless-colored";
/**
* "Quiet" button, which looks like {@link #BUTTON_BORDERLESS} until you
* hover over it with the mouse. Can be combined with any other Button
* style.
*/
public static final String BUTTON_QUIET = "quiet";
/**
* Makes the button look like the Link component. Can be combined with any
* other Button style.
*/
public static final String BUTTON_LINK = "link";
/**
* Tiny size button. Can be combined with any other Button style.
*/
public static final String BUTTON_TINY = "tiny";
/**
* Small size button. Can be combined with any other Button style.
*/
public static final String BUTTON_SMALL = "small";
/**
* Large size button. Can be combined with any other Button style.
*/
public static final String BUTTON_LARGE = "large";
/**
* Huge size button. Can be combined with any other Button style.
*/
public static final String BUTTON_HUGE = "huge";
/**
* Align the icon to the right side of the button caption. Can be combined
* with any other Button style.
*/
public static final String BUTTON_ICON_ALIGN_RIGHT = "icon-align-right";
/**
* Stack the icon on top of the button caption. Can be combined with any
* other Button style.
*/
public static final String BUTTON_ICON_ALIGN_TOP = "icon-align-top";
/**
* Only show the icon in the button, and size the button to a square shape.
*/
public static final String BUTTON_ICON_ONLY = "icon-only";
/***************************************************************************
*
* Link styles
*
**************************************************************************/
/**
* Small size link.
*/
public static final String LINK_SMALL = "small";
/**
* Large size link.
*/
public static final String LINK_LARGE = "large";
/***************************************************************************
*
* TextField styles
*
**************************************************************************/
/**
* Tiny size text field. Can be combined with any other TextField style.
*/
public static final String TEXTFIELD_TINY = "tiny";
/**
* Small size text field. Can be combined with any other TextField style.
*/
public static final String TEXTFIELD_SMALL = "small";
/**
* Large size text field. Can be combined with any other TextField style.
*/
public static final String TEXTFIELD_LARGE = "large";
/**
* Huge size text field. Can be combined with any other TextField style.
*/
public static final String TEXTFIELD_HUGE = "huge";
/**
* Removes the border and background from the text field. Can be combined
* with any other TextField style.
*/
public static final String TEXTFIELD_BORDERLESS = "borderless";
/**
* Align the text inside the field to the right. Can be combined with any
* other TextField style.
*/
public static final String TEXTFIELD_ALIGN_RIGHT = "align-right";
/**
* Align the text inside the field to center. Can be combined with any other
* TextField style.
*/
public static final String TEXTFIELD_ALIGN_CENTER = "align-center";
/**
* Move the default caption icon inside the text field. Can be combined with
* any other TextField style.
*/
public static final String TEXTFIELD_INLINE_ICON = "inline-icon";
/***************************************************************************
*
* TextArea styles
*
**************************************************************************/
/**
* Tiny size text area. Can be combined with any other TextArea style.
*/
public static final String TEXTAREA_TINY = "tiny";
/**
* Small size text area. Can be combined with any other TextArea style.
*/
public static final String TEXTAREA_SMALL = "small";
/**
* Large size text area. Can be combined with any other TextArea style.
*/
public static final String TEXTAREA_LARGE = "large";
/**
* Huge size text area. Can be combined with any other TextArea style.
*/
public static final String TEXTAREA_HUGE = "huge";
/**
* Removes the border and background from the text area. Can be combined
* with any other TextArea style.
*/
public static final String TEXTAREA_BORDERLESS = "borderless";
/**
* Align the text inside the area to the right. Can be combined with any
* other TextArea style.
*/
public static final String TEXTAREA_ALIGN_RIGHT = "align-right";
/**
* Align the text inside the area to center. Can be combined with any other
* TextArea style.
*/
public static final String TEXTAREA_ALIGN_CENTER = "align-center";
/***************************************************************************
*
* DateField styles
*
**************************************************************************/
/**
* Tiny size date field. Can be combined with any other DateField style.
*/
public static final String DATEFIELD_TINY = "tiny";
/**
* Small size date field. Can be combined with any other DateField style.
*/
public static final String DATEFIELD_SMALL = "small";
/**
* Large size date field. Can be combined with any other DateField style.
*/
public static final String DATEFIELD_LARGE = "large";
/**
* Huge size date field. Can be combined with any other DateField style.
*/
public static final String DATEFIELD_HUGE = "huge";
/**
* Removes the border and background from the date field. Can be combined
* with any other DateField style.
*/
public static final String DATEFIELD_BORDERLESS = "borderless";
/**
* Align the text inside the field to the right. Can be combined with any
* other DateField style.
*/
public static final String DATEFIELD_ALIGN_RIGHT = "align-right";
/**
* Align the text inside the field to center. Can be combined with any other
* DateField style.
*/
public static final String DATEFIELD_ALIGN_CENTER = "align-center";
/***************************************************************************
*
* ComboBox styles
*
**************************************************************************/
/**
* Tiny size combo box. Can be combined with any other ComboBox style.
*/
public static final String COMBOBOX_TINY = "tiny";
/**
* Small size combo box. Can be combined with any other ComboBox style.
*/
public static final String COMBOBOX_SMALL = "small";
/**
* Large size combo box. Can be combined with any other ComboBox style.
*/
public static final String COMBOBOX_LARGE = "large";
/**
* Huge size combo box. Can be combined with any other ComboBox style.
*/
public static final String COMBOBOX_HUGE = "huge";
/**
* Removes the border and background from the combo box. Can be combined
* with any other ComboBox style.
*/
public static final String COMBOBOX_BORDERLESS = "borderless";
/**
* Align the text inside the combo box to the right. Can be combined with
* any other TextField style.
*/
public static final String COMBOBOX_ALIGN_RIGHT = "align-right";
/**
* Align the text inside the combo box to center. Can be combined with any
* other TextField style.
*/
public static final String COMBOBOX_ALIGN_CENTER = "align-center";
/***************************************************************************
*
* CheckBox styles
*
**************************************************************************/
/**
* Small size check box. Can be combined with any other CheckBox style.
*/
public static final String CHECKBOX_SMALL = "small";
/**
* Large size check box. Can be combined with any other CheckBox style.
*/
public static final String CHECKBOX_LARGE = "large";
/***************************************************************************
*
* OptionGroup styles
*
**************************************************************************/
/**
* Small size option group. Can be combined with any other OptionGroup
* style.
*/
public static final String OPTIONGROUP_SMALL = "small";
/**
* Large size option group. Can be combined with any other OptionGroup
* style.
*/
public static final String OPTIONGROUP_LARGE = "large";
/**
* Display the options horizontally in a row (by default the items are
* stacked vertically).
*/
public static final String OPTIONGROUP_HORIZONTAL = "horizontal";
/***************************************************************************
*
* Slider styles
*
**************************************************************************/
/**
* Hide the indicator bar from the slider. Can be combined with any other
* Slider style.
*/
public static final String SLIDER_NO_INDICATOR = "no-indicator";
/***************************************************************************
*
* ProgressBar styles
*
**************************************************************************/
/**
* Make the progress bar indicator appear as a dot which progresses over the
* progress bar track (instead of a growing bar).
*/
public static final String PROGRESSBAR_POINT = "point";
/***************************************************************************
*
* MenuBar styles
*
**************************************************************************/
/**
* Small size menu bar. Can be combined with any other MenuBar style.
*/
public static final String MENUBAR_SMALL = "small";
/**
* Borderless menu bar. Can be combined with any other MenuBar style.
*/
public static final String MENUBAR_BORDERLESS = "borderless";
/***************************************************************************
*
* Table and TreeTable styles
*
**************************************************************************/
/**
* Remove the alternating row colors. Can be combined with any other
* Table/TreeTable style.
*/
public static final String TABLE_NO_STRIPES = "no-stripes";
/**
* See {@link #TABLE_NO_STRIPES}
*/
public static final String TREETABLE_NO_STRIPES = TABLE_NO_STRIPES;
/**
* Remove the vertical divider lines between the table columns. Can be
* combined with any other Table/TreeTable style.
*/
public static final String TABLE_NO_VERTICAL_LINES = "no-vertical-lines";
/**
* See {@link #TABLE_NO_VERTICAL_LINES}
*/
public static final String TREETABLE_NO_VERTICAL_LINES = TABLE_NO_VERTICAL_LINES;
/**
* Remove the horizontal divider lines between the table rows. Can be
* combined with any other Table/TreeTable style.
*/
public static final String TABLE_NO_HORIZONTAL_LINES = "no-horizontal-lines";
/**
* See {@link #TABLE_NO_HORIZONTAL_LINES}
*/
public static final String TREETABLE_NO_HORIZONTAL_LINES = TABLE_NO_HORIZONTAL_LINES;
/**
* Hide the table column headers (effectively the same as
* {@link ColumnHeaderMode#HIDDEN}). Can be combined with any other
* Table/TreeTable style.
*/
public static final String TABLE_NO_HEADER = "no-header";
/**
* See {@link #TABLE_NO_HEADER}
*/
public static final String TREETABLE_NO_HEADER = TABLE_NO_HEADER;
/**
* Remove the outer border of the table. Can be combined with any other
* Table/TreeTable style.
*/
public static final String TABLE_BORDERLESS = "borderless";
/**
* See {@link #TABLE_BORDERLESS}
*/
public static final String TREETABLE_BORDERLESS = TABLE_BORDERLESS;
/**
* Reduce the white space inside the table cells. Can be combined with any
* other Table/TreeTable style.
*/
public static final String TABLE_COMPACT = "compact";
/**
* See {@link #TABLE_COMPACT}
*/
public static final String TREETABLE_COMPACT = TABLE_COMPACT;
/**
* Small font size and reduced the white space inside the table cells. Can
* be combined with any other Table/TreeTable style.
*/
public static final String TABLE_SMALL = "small";
/**
* See {@link #TABLE_SMALL}
*/
public static final String TREETABLE_SMALL = TABLE_SMALL;
/***************************************************************************
*
* DragAndDropWrapper styles
*
**************************************************************************/
/**
* Hide the "box drag hints" (i.e. the style which gets applied when the
* drag is in the middle/center area of the drag target).
*/
public static final String DRAG_AND_DROP_WRAPPER_NO_BOX_DRAG_HINTS = "no-box-drag-hints";
/**
* Hide the "vertical drag hints" (i.e. the style which gets applied when
* the drag is in the top/bottom part of the drag target).
*/
public static final String DRAG_AND_DROP_WRAPPER_NO_VERTICAL_DRAG_HINTS = "no-vertical-drag-hints";
/**
* Hide the "horizontal drag hints" (i.e. the style which gets applied when
* the drag is in the left/right part of the drag target).
*/
public static final String DRAG_AND_DROP_WRAPPER_NO_HORIZONTAL_DRAG_HINTS = "no-horizontal-drag-hints";
/***************************************************************************
*
* Panel styles
*
**************************************************************************/
/**
* Remove borders and the background color of the panel. Can be combined
* with any other Panel style.
*/
public static final String PANEL_BORDERLESS = "borderless";
/**
* Show a divider between the panel caption and content when the content
* area is scrolled. Suitable with the {@link #PANEL_BORDERLESS} style. Can
* be combined with any other Panel style.
*/
public static final String PANEL_SCROLL_INDICATOR = "scroll-divider";
/**
* Inset panel style. Can be combined with any other Panel style.
*/
public static final String PANEL_WELL = "well";
/***************************************************************************
*
* SplitPanel styles
*
**************************************************************************/
/**
* Make the split handle wider.
*/
public static final String SPLITPANEL_LARGE = "large";
/***************************************************************************
*
* TabSheet styles
*
**************************************************************************/
/**
* Adds a border around the whole component as well as around individual
* tabs in the tab bar. Can be combined with any other TabSheet style.
*/
public static final String TABSHEET_FRAMED = "framed";
/**
* Center the tabs inside the tab bar. Works best if all the tabs fit
* completely in the tab bar (i.e. no tab bar scrolling). Can be combined
* with any other TabSheet style.
*/
public static final String TABSHEET_CENTERED_TABS = "centered-tabs";
/**
* Give equal amount of space to all tabs in the tab bar (.i.e expand ratio
* == 1 for all tabs). The tab captions will be truncated if they do not fit
* in to the tab. Tab scrolling will be disabled when this style is applied
* (all tabs will be visible at the same time). Can be combined with any
* other TabSheet style.
*/
public static final String TABSHEET_EQUAL_WIDTH_TABS = "equal-width-tabs";
/**
* Add a small amount of padding around the tabs in the tab bar, so that
* they don't touch the outer edges of the component. Can be combined with
* any other TabSheet style.
*/
public static final String TABSHEET_PADDED_TABBAR = "padded-tabbar";
/**
* Reduce the whitespace around the tabs in the tab bar. Can be combined
* with any other TabSheet style.
*/
public static final String TABSHEET_COMPACT_TABBAR = "compact-tabbar";
/**
* Display tab icons on top of the tab captions (by default the icons are
* place on the left side of the caption). Can be combined with any other
* TabSheet style.
*/
public static final String TABSHEET_ICONS_ON_TOP = "icons-on-top";
/**
* Only the selected tab has the close button visible. Does not prevent
* closing the tab programmatically, it only hides the button from the end
* user. Can be combined with any other TabSheet style.
*/
public static final String TABSHEET_ONLY_SELECTED_TAB_IS_CLOSABLE = "only-selected-closable";
/***************************************************************************
*
* Accordion styles
*
**************************************************************************/
/**
* Remove the outer border from the accordion. Can be combined with any
* other Accordion style.
*/
public static final String ACCORDION_BORDERLESS = "borderless";
/***************************************************************************
*
* Window and related styles
*
**************************************************************************/
/**
* Add this style to any layout component (e.g. CssLayout, VerticalLayout or
* HorizontalLayout) and place it inside the root layout of the window to
* create a toolbar area for the window. You can then place any other
* components inside the toolbar layout, e.g. a MenuBar.
*/
public static final String WINDOW_TOP_TOOLBAR = "v-window-top-toolbar";
/**
* Add this style to any layout component (e.g. CssLayout, VerticalLayout or
* HorizontalLayout) and place it inside the root layout of the window to
* create a toolbar area for the window. You can then place any other
* components inside the toolbar layout, e.g. a MenuBar.
*/
public static final String WINDOW_BOTTOM_TOOLBAR = "v-window-bottom-toolbar";
/***************************************************************************
*
* FormLayout styles
*
**************************************************************************/
/**
* Removes the borders and background from any direct child field components
* (TextField, TextArea, DateField, ComboBox) in the layout. Reduces the
* spacing between the form rows and adds separator lines between them.
*/
public static final String FORMLAYOUT_LIGHT = "light";
/***************************************************************************
*
* Layout styles
*
**************************************************************************/
/**
* Make a layout look like the Panel component (resembles visually a card).
* Add an additional <code>v-panel-caption</code> style name to any layout
* inside the card layout to make it look like a Panel's caption.
*/
public static final String LAYOUT_CARD = "card";
/**
* Make a layout look like the {@link #PANEL_WELL} style. Add an additional
* <code>v-panel-caption</code> style name to any layout inside the card
* layout to make it look like a Panel's caption.
*/
public static final String LAYOUT_WELL = "well";
/**
* Make a HorizontalLayout wrap contained components to a new line when the
* isn't enough space.
*/
public static final String LAYOUT_HORIZONTAL_WRAPPING = "wrapping";
/**
* Add this style name to a CssLayout to create a grouped set of components,
* i.e. a row of components which are joined seamlessly together.
*
* <h4>Example</h4>
*
* <pre>
* CssLayout group = new CssLayout();
* group.addStyleName(ValoTheme.LAYOUT_COMPONENT_GROUP);
*
* TextField field = new TextField();
* group.addComponent(field);
*
* Button button = new Button("Action");
* group.addComponent(button);
* </pre>
*/
public static final String LAYOUT_COMPONENT_GROUP = "v-component-group";
/***************************************************************************
*
* Valo menu styles
*
**************************************************************************/
/**
* <p>
* When you use the Valo menu and wish to enable responsive features of the
* menu, you need to add this style name to the UI containing the menu.
* </p>
*
* <p>
* You only need to add this style name to the UI containing a Valo menu, if
* you're using the Responsive extension with the UI.
* </p>
*
* <h4>Example</h4>
*
* <p>
* To enable responsivity in the Valo menu, the following example code
* should be executed in your UI containing the menu.
* </p>
*
* <pre>
* Responsive.makeResponsive(this);
* addStyleName(ValoTheme.UI_WITH_MENU);
* </pre>
*/
public static final String UI_WITH_MENU = "valo-menu-responsive";
/**
* <p>
* Set the <em><b>primary</b></em> style name of a CssLayout to this, and
* add any number of layouts with the {@link #MENU_PART} style inside it.
* </p>
*
* <p>
* The menu style is used to create a sidebar navigation menu for the
* application, usually action as the main navigation for the different
* sections of the application. It usually consists of at least a number of
* {@link #MENU_ITEM}s, and possibly some {@link #MENU_SUBTITLE}s and a
* {@link #MENU_TITLE}.
* </p>
*
* <h4>Example</h4>
*
* <pre>
* CssLayout menuArea = new CssLayout();
* menuArea.setPrimaryStyleName(ValoTheme.MENU_ROOT);
* </pre>
*/
public static final String MENU_ROOT = "valo-menu";
/**
* Add this style name to any layout and place it inside a layout with the
* {@link #MENU_ROOT} style to build a menu component. Use the additional
* MENU styles for individual components inside the layout.
*
* <h4>Example</h4>
*
* <pre>
* CssLayout menu = new CssLayout();
* menu.addStyleName(ValoTheme.MENU_PART);
* </pre>
*/
public static final String MENU_PART = "valo-menu-part";
/**
* Add this style name to any layout with the {@link #MENU_PART} style name
* to make any menu items inside the menu emphasize the icons more than the
* captions. Useful on narrower viewport widths, since the menu width is
* decreased quite dramatically, making more space for the content of the
* application.
*
* <h4>Example</h4>
*
* <pre>
* CssLayout menu = new CssLayout();
* menu.addStyleName(ValoTheme.MENU_PART);
* menu.addStyleName(ValoTheme.MENU_PART_LARGE_ICONS);
* </pre>
*/
public static final String MENU_PART_LARGE_ICONS = "large-icons";
/**
* <p>
* Add this style name to any layout to make a header area for a menu
* (intended to be placed in side a {@link #MENU_PART} layout). You can add
* any components inside it, but usually you would place a Label inside.
* </p>
*
* <p>
* Any MenuBar component that you place inside this layout will match the
* style of the title, allowing an easy way to add a toolbar to the title
* layout.
* </p>
*/
public static final String MENU_TITLE = "valo-menu-title";
/**
* Set the <em><b>primary</b></em> style name of a Label or a Button to this
* style name to create a section divider in a menu.
*/
public static final String MENU_SUBTITLE = "valo-menu-subtitle";
/**
* <p>
* Set the <em><b>primary</b></em> style name of a Button to this style name
* to create a clickable menu item in the menu.
* </p>
*
* <h4>Selected item</h4>
* <p>
* Add an additional style name <b><code>selected</code></b> to it to make
* it the selected item in the menu.
* </p>
*
* <h4>Example</h4>
*
* <pre>
* Button item = new Button();
* item.setPrimaryStyleName(ValoTheme.MENU_ITEM);
* item.addStyleName("selected");
* </pre>
*/
public static final String MENU_ITEM = "valo-menu-item";
/**
* Add a SPAN element with this style name inside a {@link #MENU_SUBTITLE}
* or {@link #MENU_ITEM} to add an additional badge indicator to the
* subtitle/item. The Label/Button needs to allow HTML content in order to
* use this style name.
*
* <h4>Examples</h4>
*
* <pre>
* Button item = new Button();
* item.setPrimaryStyleName(ValoTheme.MENU_ITEM);
* item.setHtmlContentAllowed(true);
* item.setCaption("Item Caption <span class=\"" + ValoTheme.MENU_BADGE
* + "\">Badge text</span>");
* </pre>
*
* <pre>
* Label item = new Label();
* item.setPrimaryStyleName(ValoTheme.MENU_ITEM);
* item.setContentMode(ContentMode.HTML);
* item.setCaption("Item Caption <span class=\"" + ValoTheme.MENU_BADGE
* + "\">Badge text</span>");
* </pre>
*/
public static final String MENU_BADGE = "valo-menu-badge";
/**
* <p>
* Set the <em><b>primary</b></em> style name of a Label or a Button to this
* style name to create an application logo. The logo is designed to be
* placed inside a {@link #MENU_PART} layout.
* </p>
*
* <p>
* The text content of the logo should be very short, since the logo area
* only shows approximately three letters. Using one of the
* {@link FontAwesome} icons is a good way to quickly create a logo for your
* application.
* </p>
* </p>
*
* <h4>Example</h4>
*
* <pre>
* Label logo = new Label(FontAwesome.ROCKET.getHtml(), ContentMode.HTML);
* logo.setSizeUndefined();
* logo.setPrimaryStyleName(ValoTheme.MENU_LOGO);
* </pre>
*/
public static final String MENU_LOGO = "valo-menu-logo";
}
|