com.vaadin.ui.themes.

Class ValoTheme

  • public class ValoTheme
    extends Object

    Additional style names which can be used with the Valo theme.

    These styles are only available if the $v-included-additional-styles Sass list variable contains the name of the component for that additional style name (e.g. button, textfield, table).

    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.

    TODO link to Sass API documentation

    Since:

    7.3

    Author:

    Vaadin Ltd

    • Field Detail

      • NOTIFICATION_SYSTEM

        public static final String NOTIFICATION_SYSTEM

        Styles the notification to look like a system notification. Can be combined with any other Notification style.

        See Also:

        Constant Field Values

      • NOTIFICATION_BAR

        public static final String NOTIFICATION_BAR

        Styles the notification to span the entire width of the viewport. Can be combined with any other Notification style.

        See Also:

        Constant Field Values

      • NOTIFICATION_SMALL

        public static final String NOTIFICATION_SMALL

        Smaller padding and font size for the notification. Can be combined with any other Notification style.

        See Also:

        Constant Field Values

      • NOTIFICATION_CLOSABLE

        public static final String NOTIFICATION_CLOSABLE

        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 (-1). Can be combined with any other Notification style.

        See Also:

        Constant Field Values

      • NOTIFICATION_SUCCESS

        public static final String NOTIFICATION_SUCCESS

        Success notification style. Adds a border around the notification and an icon next to the title. Can be combined with any other Notification style.

        See Also:

        Constant Field Values

      • NOTIFICATION_FAILURE

        public static final String NOTIFICATION_FAILURE

        Failure notification style. Adds a border around the notification and an icon next to the title. Can be combined with any other Notification style.

        See Also:

        Constant Field Values

      • NOTIFICATION_CRITICAL_ERROR

        public static final String NOTIFICATION_CRITICAL_ERROR

        Styles the notification to look like Notification.Type.ERROR_MESSAGE, without setting the position and delay and without the close button. Can be combined with any other Notification style.

        See Also:

        Constant Field Values

      • NOTIFICATION_DARK

        public static final String NOTIFICATION_DARK

        Styles the notification to be dark variant. Can be combined with any other Notification style.

        See Also:

        Constant Field Values

      • LABEL_H1

        public static final String LABEL_H1

        Header style for main application headings. Can be combined with any other Label style.

        See Also:

        Constant Field Values

      • LABEL_H2

        public static final String LABEL_H2

        Header style for different sections in the application. Can be combined with any other Label style.

        See Also:

        Constant Field Values

      • LABEL_H3

        public static final String LABEL_H3

        Header style for different sub-sections in the application. Can be combined with any other Label style.

        See Also:

        Constant Field Values

      • LABEL_H4

        public static final String LABEL_H4

        Header style for different sub-sections in the application. Can be combined with any other Label style.

        See Also:

        Constant Field Values

      • LABEL_TINY

        public static final String LABEL_TINY

        Tiny font size. Suitable for additional/supplementary UI text. Can be combined with any other Label style.

        See Also:

        Constant Field Values

      • LABEL_SMALL

        public static final String LABEL_SMALL

        Small font size. Suitable for additional/supplementary UI text. Can be combined with any other Label style.

        See Also:

        Constant Field Values

      • LABEL_LARGE

        public static final String LABEL_LARGE

        Large font size. Suitable for important/prominent UI text. Can be combined with any other Label style.

        See Also:

        Constant Field Values

      • LABEL_HUGE

        public static final String LABEL_HUGE

        Huge font size. Suitable for important/prominent UI text. Can be combined with any other Label style.

        See Also:

        Constant Field Values

      • LABEL_LIGHT

        public static final String LABEL_LIGHT

        Lighter font weight. Suitable for additional/supplementary UI text. Can be combined with any other Label style.

        See Also:

        Constant Field Values

      • LABEL_BOLD

        public static final String LABEL_BOLD

        Bolder font weight. Suitable for important/prominent UI text. Can be combined with any other Label style.

        See Also:

        Constant Field Values

      • LABEL_COLORED

        public static final String LABEL_COLORED

        Colored text. Can be combined with any other Label style.

        See Also:

        Constant Field Values

      • LABEL_SUCCESS

        public static final String LABEL_SUCCESS

        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.

        See Also:

        Constant Field Values

      • LABEL_FAILURE

        public static final String LABEL_FAILURE

        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.

        See Also:

        Constant Field Values

      • LABEL_SPINNER

        public static final String LABEL_SPINNER

        Spinner style. Add this style name to an empty Label to create a spinner.

        Example:

         Label spinner = new Label();
         spinner.addStyleName(ValoTheme.LABEL_SPINNER);
         

        See Also:

        Constant Field Values

      • BUTTON_PRIMARY

        public static final String BUTTON_PRIMARY

        Primary action button (e.g. the button that should get activated when the user presses the enter key in a form). Use sparingly, only one default button per view should be visible. Can be combined with any other Button style.

        See Also:

        Constant Field Values

      • BUTTON_FRIENDLY

        public static final String BUTTON_FRIENDLY

        A prominent button that can be used instead of the BUTTON_PRIMARY for primary actions when the action is considered safe for the user (i.e. does not cause any data loss or any other irreversible action). Can be combined with any other Button style.

        See Also:

        Constant Field Values

      • BUTTON_DANGER

        public static final String BUTTON_DANGER

        A prominent button that can be used when the action is considered unsafe for the user (i.e. it causes data loss or some other irreversible action). Can be combined with any other Button style.

        See Also:

        Constant Field Values

      • BUTTON_BORDERLESS

        public static final String BUTTON_BORDERLESS

        Borderless button. Can be combined with any other Button style.

        See Also:

        Constant Field Values

      • BUTTON_BORDERLESS_COLORED

        public static final String BUTTON_BORDERLESS_COLORED

        Borderless button with a colored caption text. Can be combined with any other Button style.

        See Also:

        Constant Field Values

      • BUTTON_QUIET

        public static final String BUTTON_QUIET

        "Quiet" button, which looks like BUTTON_BORDERLESS until you hover over it with the mouse. Can be combined with any other Button style.

        See Also:

        Constant Field Values

      • BUTTON_LINK

        public static final String BUTTON_LINK

        Makes the button look like the Link component. Can be combined with any other Button style.

        See Also:

        Constant Field Values

      • BUTTON_TINY

        public static final String BUTTON_TINY

        Tiny size button. Can be combined with any other Button style.

        See Also:

        Constant Field Values

      • BUTTON_SMALL

        public static final String BUTTON_SMALL

        Small size button. Can be combined with any other Button style.

        See Also:

        Constant Field Values

      • BUTTON_LARGE

        public static final String BUTTON_LARGE

        Large size button. Can be combined with any other Button style.

        See Also:

        Constant Field Values

      • BUTTON_HUGE

        public static final String BUTTON_HUGE

        Huge size button. Can be combined with any other Button style.

        See Also:

        Constant Field Values

      • BUTTON_ICON_ALIGN_RIGHT

        public static final String BUTTON_ICON_ALIGN_RIGHT

        Align the icon to the right side of the button caption. Can be combined with any other Button style.

        See Also:

        Constant Field Values

      • BUTTON_ICON_ALIGN_TOP

        public static final String BUTTON_ICON_ALIGN_TOP

        Stack the icon on top of the button caption. Can be combined with any other Button style.

        See Also:

        Constant Field Values

      • BUTTON_ICON_ONLY

        public static final String BUTTON_ICON_ONLY

        Only show the icon in the button, and size the button to a square shape.

        See Also:

        Constant Field Values

      • TEXTFIELD_TINY

        public static final String TEXTFIELD_TINY

        Tiny size text field. Can be combined with any other TextField style.

        See Also:

        Constant Field Values

      • TEXTFIELD_SMALL

        public static final String TEXTFIELD_SMALL

        Small size text field. Can be combined with any other TextField style.

        See Also:

        Constant Field Values

      • TEXTFIELD_LARGE

        public static final String TEXTFIELD_LARGE

        Large size text field. Can be combined with any other TextField style.

        See Also:

        Constant Field Values

      • TEXTFIELD_HUGE

        public static final String TEXTFIELD_HUGE

        Huge size text field. Can be combined with any other TextField style.

        See Also:

        Constant Field Values

      • TEXTFIELD_BORDERLESS

        public static final String TEXTFIELD_BORDERLESS

        Removes the border and background from the text field. Can be combined with any other TextField style.

        See Also:

        Constant Field Values

      • TEXTFIELD_ALIGN_RIGHT

        public static final String TEXTFIELD_ALIGN_RIGHT

        Align the text inside the field to the right. Can be combined with any other TextField style.

        See Also:

        Constant Field Values

      • TEXTFIELD_ALIGN_CENTER

        public static final String TEXTFIELD_ALIGN_CENTER

        Align the text inside the field to center. Can be combined with any other TextField style.

        See Also:

        Constant Field Values

      • TEXTFIELD_INLINE_ICON

        public static final String TEXTFIELD_INLINE_ICON

        Move the default caption icon inside the text field. Can be combined with any other TextField style.

        Note: Does not apply in FormLayout

        Note: TextFields with inlined icons in Grid header need to be wrapped into e.g. HorizontalLayout

        See Also:

        Constant Field Values

      • TEXTAREA_TINY

        public static final String TEXTAREA_TINY

        Tiny size text area. Can be combined with any other TextArea style.

        See Also:

        Constant Field Values

      • TEXTAREA_SMALL

        public static final String TEXTAREA_SMALL

        Small size text area. Can be combined with any other TextArea style.

        See Also:

        Constant Field Values

      • TEXTAREA_LARGE

        public static final String TEXTAREA_LARGE

        Large size text area. Can be combined with any other TextArea style.

        See Also:

        Constant Field Values

      • TEXTAREA_HUGE

        public static final String TEXTAREA_HUGE

        Huge size text area. Can be combined with any other TextArea style.

        See Also:

        Constant Field Values

      • TEXTAREA_BORDERLESS

        public static final String TEXTAREA_BORDERLESS

        Removes the border and background from the text area. Can be combined with any other TextArea style.

        See Also:

        Constant Field Values

      • TEXTAREA_ALIGN_RIGHT

        public static final String TEXTAREA_ALIGN_RIGHT

        Align the text inside the area to the right. Can be combined with any other TextArea style.

        See Also:

        Constant Field Values

      • TEXTAREA_ALIGN_CENTER

        public static final String TEXTAREA_ALIGN_CENTER

        Align the text inside the area to center. Can be combined with any other TextArea style.

        See Also:

        Constant Field Values

      • DATEFIELD_TINY

        public static final String DATEFIELD_TINY

        Tiny size date field. Can be combined with any other DateField style.

        See Also:

        Constant Field Values

      • DATEFIELD_SMALL

        public static final String DATEFIELD_SMALL

        Small size date field. Can be combined with any other DateField style.

        See Also:

        Constant Field Values

      • DATEFIELD_LARGE

        public static final String DATEFIELD_LARGE

        Large size date field. Can be combined with any other DateField style.

        See Also:

        Constant Field Values

      • DATEFIELD_HUGE

        public static final String DATEFIELD_HUGE

        Huge size date field. Can be combined with any other DateField style.

        See Also:

        Constant Field Values

      • DATEFIELD_BORDERLESS

        public static final String DATEFIELD_BORDERLESS

        Removes the border and background from the date field. Can be combined with any other DateField style.

        See Also:

        Constant Field Values

      • DATEFIELD_ALIGN_RIGHT

        public static final String DATEFIELD_ALIGN_RIGHT

        Align the text inside the field to the right. Can be combined with any other DateField style.

        See Also:

        Constant Field Values

      • DATEFIELD_ALIGN_CENTER

        public static final String DATEFIELD_ALIGN_CENTER

        Align the text inside the field to center. Can be combined with any other DateField style.

        See Also:

        Constant Field Values

      • COMBOBOX_TINY

        public static final String COMBOBOX_TINY

        Tiny size combo box. Can be combined with any other ComboBox style.

        See Also:

        Constant Field Values

      • COMBOBOX_SMALL

        public static final String COMBOBOX_SMALL

        Small size combo box. Can be combined with any other ComboBox style.

        See Also:

        Constant Field Values

      • COMBOBOX_LARGE

        public static final String COMBOBOX_LARGE

        Large size combo box. Can be combined with any other ComboBox style.

        See Also:

        Constant Field Values

      • COMBOBOX_HUGE

        public static final String COMBOBOX_HUGE

        Huge size combo box. Can be combined with any other ComboBox style.

        See Also:

        Constant Field Values

      • COMBOBOX_BORDERLESS

        public static final String COMBOBOX_BORDERLESS

        Removes the border and background from the combo box. Can be combined with any other ComboBox style.

        See Also:

        Constant Field Values

      • COMBOBOX_ALIGN_RIGHT

        public static final String COMBOBOX_ALIGN_RIGHT

        Align the text inside the combo box to the right. Can be combined with any other TextField style.

        See Also:

        Constant Field Values

      • COMBOBOX_ALIGN_CENTER

        public static final String COMBOBOX_ALIGN_CENTER

        Align the text inside the combo box to center. Can be combined with any other TextField style.

        See Also:

        Constant Field Values

      • CHECKBOX_SMALL

        public static final String CHECKBOX_SMALL

        Small size check box. Can be combined with any other CheckBox style.

        See Also:

        Constant Field Values

      • CHECKBOX_LARGE

        public static final String CHECKBOX_LARGE

        Large size check box. Can be combined with any other CheckBox style.

        See Also:

        Constant Field Values

      • OPTIONGROUP_SMALL

        public static final String OPTIONGROUP_SMALL

        Small size option group. Can be combined with any other RadioButtonGroup/CheckBoxGroup style.

        See Also:

        Constant Field Values

      • OPTIONGROUP_LARGE

        public static final String OPTIONGROUP_LARGE

        Large size option group. Can be combined with any other RadioButtonGroup/CheckBoxGroup style.

        See Also:

        Constant Field Values

      • OPTIONGROUP_HORIZONTAL

        public static final String OPTIONGROUP_HORIZONTAL

        Display the options horizontally in a row (by default the items are stacked vertically).

        See Also:

        Constant Field Values

      • SLIDER_NO_INDICATOR

        public static final String SLIDER_NO_INDICATOR

        Hide the indicator bar from the slider. Can be combined with any other Slider style.

        See Also:

        Constant Field Values

      • PROGRESSBAR_POINT

        public static final String PROGRESSBAR_POINT

        Make the progress bar indicator appear as a dot which progresses over the progress bar track (instead of a growing bar).

        See Also:

        Constant Field Values

      • MENUBAR_SMALL

        public static final String MENUBAR_SMALL

        Small size menu bar. Can be combined with any other MenuBar style.

        See Also:

        Constant Field Values

      • MENUBAR_BORDERLESS

        public static final String MENUBAR_BORDERLESS

        Borderless menu bar. Can be combined with any other MenuBar style.

        See Also:

        Constant Field Values

      • TABLE_NO_STRIPES

        public static final String TABLE_NO_STRIPES

        Remove the alternating row colors. Can be combined with any other Table/TreeTable style.

        See Also:

        Constant Field Values

      • TABLE_NO_VERTICAL_LINES

        public static final String TABLE_NO_VERTICAL_LINES

        Remove the vertical divider lines between the table columns. Can be combined with any other Table/TreeTable style.

        See Also:

        Constant Field Values

      • TABLE_NO_HORIZONTAL_LINES

        public static final String TABLE_NO_HORIZONTAL_LINES

        Remove the horizontal divider lines between the table rows. Can be combined with any other Table/TreeTable style.

        See Also:

        Constant Field Values

      • TABLE_NO_HEADER

        public static final String TABLE_NO_HEADER

        Hide the table column headers (effectively the same as ColumnHeaderMode.HIDDEN). Can be combined with any other Table/TreeTable style.

        See Also:

        Constant Field Values

      • TABLE_BORDERLESS

        public static final String TABLE_BORDERLESS

        Remove the outer border of the table. Can be combined with any other Table/TreeTable style.

        See Also:

        Constant Field Values

      • TABLE_COMPACT

        public static final String TABLE_COMPACT

        Reduce the white space inside the table cells. Can be combined with any other Table/TreeTable style.

        See Also:

        Constant Field Values

      • TABLE_SMALL

        public static final String TABLE_SMALL

        Small font size and reduced the white space inside the table cells. Can be combined with any other Table/TreeTable style.

        See Also:

        Constant Field Values

      • DRAG_AND_DROP_WRAPPER_NO_BOX_DRAG_HINTS

        public static final String DRAG_AND_DROP_WRAPPER_NO_BOX_DRAG_HINTS

        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).

        See Also:

        Constant Field Values

      • DRAG_AND_DROP_WRAPPER_NO_VERTICAL_DRAG_HINTS

        public static final String DRAG_AND_DROP_WRAPPER_NO_VERTICAL_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).

        See Also:

        Constant Field Values

      • DRAG_AND_DROP_WRAPPER_NO_HORIZONTAL_DRAG_HINTS

        public static final String DRAG_AND_DROP_WRAPPER_NO_HORIZONTAL_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).

        See Also:

        Constant Field Values

      • PANEL_BORDERLESS

        public static final String PANEL_BORDERLESS

        Remove borders and the background color of the panel. Can be combined with any other Panel style.

        See Also:

        Constant Field Values

      • PANEL_SCROLL_INDICATOR

        public static final String PANEL_SCROLL_INDICATOR

        Show a divider between the panel caption and content when the content area is scrolled. Suitable with the PANEL_BORDERLESS style. Can be combined with any other Panel style.

        See Also:

        Constant Field Values

      • PANEL_WELL

        public static final String PANEL_WELL

        Inset panel style. Can be combined with any other Panel style.

        See Also:

        Constant Field Values

      • TABSHEET_FRAMED

        public static final String TABSHEET_FRAMED

        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.

        See Also:

        Constant Field Values

      • TABSHEET_CENTERED_TABS

        public static final String TABSHEET_CENTERED_TABS

        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.

        See Also:

        Constant Field Values

      • TABSHEET_EQUAL_WIDTH_TABS

        public static final String TABSHEET_EQUAL_WIDTH_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.

        See Also:

        Constant Field Values

      • TABSHEET_PADDED_TABBAR

        public static final String TABSHEET_PADDED_TABBAR

        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.

        See Also:

        Constant Field Values

      • TABSHEET_COMPACT_TABBAR

        public static final String TABSHEET_COMPACT_TABBAR

        Reduce the whitespace around the tabs in the tab bar. Can be combined with any other TabSheet style.

        See Also:

        Constant Field Values

      • TABSHEET_ICONS_ON_TOP

        public static final String TABSHEET_ICONS_ON_TOP

        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.

        See Also:

        Constant Field Values

      • TABSHEET_ONLY_SELECTED_TAB_IS_CLOSABLE

        public static final String TABSHEET_ONLY_SELECTED_TAB_IS_CLOSABLE

        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.

        See Also:

        Constant Field Values

      • ACCORDION_BORDERLESS

        public static final String ACCORDION_BORDERLESS

        Remove the outer border from the accordion. Can be combined with any other Accordion style.

        See Also:

        Constant Field Values

      • WINDOW_TOP_TOOLBAR

        public static final String 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.

        See Also:

        Constant Field Values

      • WINDOW_BOTTOM_TOOLBAR

        public static final String WINDOW_BOTTOM_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.

        See Also:

        Constant Field Values

      • FORMLAYOUT_LIGHT

        public static final String FORMLAYOUT_LIGHT

        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.

        See Also:

        Constant Field Values

      • LAYOUT_CARD

        public static final String LAYOUT_CARD

        Make a layout look like the Panel component (resembles visually a card). Add an additional v-panel-caption style name to any layout inside the card layout to make it look like a Panel's caption.

        See Also:

        Constant Field Values

      • LAYOUT_WELL

        public static final String LAYOUT_WELL

        Make a layout look like the PANEL_WELL style. Add an additional v-panel-caption style name to any layout inside the card layout to make it look like a Panel's caption.

        See Also:

        Constant Field Values

      • LAYOUT_HORIZONTAL_WRAPPING

        public static final String LAYOUT_HORIZONTAL_WRAPPING

        Make a HorizontalLayout wrap contained components to a new line when the isn't enough space.

        See Also:

        Constant Field Values

      • LAYOUT_COMPONENT_GROUP

        public static final String LAYOUT_COMPONENT_GROUP

        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.

        Example:
         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);
         

        See Also:

        Constant Field Values

      • UI_WITH_MENU

        public static final String UI_WITH_MENU

        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.

        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.

        Example:

        To enable responsivity in the Valo menu, the following example code should be executed in your UI containing the menu.

         Responsive.makeResponsive(this);
         addStyleName(ValoTheme.UI_WITH_MENU);
         

        See Also:

        Constant Field Values

      • MENU_ROOT

        public static final String MENU_ROOT

        Set the primary style name of a CssLayout to this, and add any number of layouts with the MENU_PART style inside it.

        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 MENU_ITEMs, and possibly some MENU_SUBTITLEs and a MENU_TITLE.

        Example:
         CssLayout menuArea = new CssLayout();
         menuArea.setPrimaryStyleName(ValoTheme.MENU_ROOT);
         

        See Also:

        Constant Field Values

      • MENU_PART

        public static final String MENU_PART

        Add this style name to any layout and place it inside a layout with the MENU_ROOT style to build a menu component. Use the additional MENU styles for individual components inside the layout.

        Example:
         CssLayout menu = new CssLayout();
         menu.addStyleName(ValoTheme.MENU_PART);
         

        See Also:

        Constant Field Values

      • MENU_PART_LARGE_ICONS

        public static final String MENU_PART_LARGE_ICONS

        Add this style name to any layout with the 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.

        Example:
         CssLayout menu = new CssLayout();
         menu.addStyleName(ValoTheme.MENU_PART);
         menu.addStyleName(ValoTheme.MENU_PART_LARGE_ICONS);
         

        See Also:

        Constant Field Values

      • MENU_TITLE

        public static final String MENU_TITLE

        Add this style name to any layout to make a header area for a menu (intended to be placed in side a MENU_PART layout). You can add any components inside it, but usually you would place a Label inside.

        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.

        See Also:

        Constant Field Values

      • MENU_SUBTITLE

        public static final String MENU_SUBTITLE

        Set the primary style name of a Label or a Button to this style name to create a section divider in a menu.

        See Also:

        Constant Field Values

      • MENU_ITEM

        public static final String MENU_ITEM

        Set the primary style name of a Button to this style name to create a clickable menu item in the menu. Wrap the buttons in the layout having MENU_ITEMS style. If the button has icon, it is shown on the left when menu area is wide and on top when it is narrow.

        Selected item:

        Add an additional style name MENU_SELECTED to it to make it the selected item in the menu.

        Example:
         Button item = new Button();
         item.setPrimaryStyleName(ValoTheme.MENU_ITEM);
         item.addStyleName(ValoTheme.MENU_SELECTED);
         

        See Also:

        Constant Field Values

      • MENU_SELECTED

        public static final String MENU_SELECTED

        Add this style name to the MENU_ITEM Button to highlight it as selected. The text color will be white and icon blue unless overridden in theme.

        See Also:

        Constant Field Values

      • MENU_BADGE

        public static final String MENU_BADGE

        Add a SPAN element with this style name inside a MENU_SUBTITLE or 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.

        Examples:
         Button item = new Button();
         item.setPrimaryStyleName(ValoTheme.MENU_ITEM);
         item.setHtmlContentAllowed(true);
         item.setCaption("Item Caption <span class=\"" + ValoTheme.MENU_BADGE
                 + "\">Badge text</span>");
         
         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>");
         

        See Also:

        Constant Field Values

      • MENU_LOGO

        public static final String MENU_LOGO

        Set the primary 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 MENU_PART layout.

        The text content of the logo should be very short, since the logo area only shows approximately three letters. Using one of the Vaadin Icons is a good way to quickly create a logo for your application. Vaadin Icons are included in the Valo theme.

        Example:
         Label logo = new Label(VaadinIcons.ROCKET.getHtml(), ContentMode.HTML);
         logo.setSizeUndefined();
         logo.setPrimaryStyleName(ValoTheme.MENU_LOGO);
         

        See Also:

        Constant Field Values

      • MENU_APPEAR_ON_HOVER

        public static final String MENU_APPEAR_ON_HOVER

        Add this style name to your responsive valo menu element to make it appear automatically on hover - without adding any code.

        The menu will appear on mouse over on desktop, or when tapping on touch devices.

        Example:
         HorizontalLayout menu = new HorizontalLayout();
         Responsive.makeResponsive(menu);
         menu.addStyleName(ValoTheme.UI_WITH_MENU);
        
         CssLayout menuArea = new CssLayout();
         menuArea.setPrimaryStyleName(ValoTheme.MENU_ROOT);
         menuArea.addStyleName(ValoTheme.MENU_APPEAR_ON_HOVER);
         menu.addComponent(menuArea);
         

        See Also:

        Constant Field Values

      • MENU_TOGGLE

        public static final String MENU_TOGGLE

        Add this style name for your menu toggle button, which will appear when view port is narrow. The toggle button is hidden in normal mode. Place the toggle button in the layout having MENU_ROOT style name.

        Example:

         Button toggleButton = new Button("Menu");
         toggleButton.setIcon(VaadinIcons.LIST);
         toggleButton.addStyleName(ValoTheme.MENU_TOGGLE);
         toggleButton.addStyleName(ValoTheme.BUTTON_BORDERLESS);
         toggleButton.addStyleName(ValoTheme.BUTTON_SMALL);
         menu.addComponent(valoMenuToggleButton);
         

        See Also:

        Constant Field Values

      • MENU_VISIBLE

        public static final String MENU_VISIBLE

        Add this style name to make menu appear when view port is narrow. This is useful in combination with button using MENU_TOGGLE in order to programmatically showing / hiding the menu.

        Example:
         Button toggleButton = new Button("Menu", event -> {
             if (menu.getStyleName().contains(ValoTheme.MENU_VISIBLE)) {
                 menu.removeStyleName(ValoTheme.MENU_VISIBLE);
             } else {
                 menu.addStyleName(ValoTheme.MENU_VISIBLE);
             }
         });
         

        See Also:

        Constant Field Values

      • MENU_USER

        public static final String MENU_USER

        If you add MenuBar e.g. for user operations like logout in the layout using MENU_ROOT, add this style name to it. The MenuBar will have more discrete style to fit the menu and it will be placed in the top right corner when the view port is narrow and top bar is viewed.

        See Also:

        Constant Field Values

      • NAV_CONTENT

        public static final String NAV_CONTENT

        When using UI_WITH_MENU together with Navigator set this style as the primary style name to the view content placeholder layout. Note, it is in most cases useful to add SCROLLABLE style name as well. Example: (in UI)

         
         Responsive.makeResponsive(this);
         addStyleName(ValoTheme.UI_WITH_MENU);
         VerticalLayout content = new VerticalLayout();
         content.setPrimaryStyleName(ValoTheme.NAV_CONTENT);
         content.addStyleName(ValoTheme.SCROLLABLE);
         Navigator nav = new Navigator(this, content);
         setNavigator(nav);
         

        See Also:

        Constant Field Values

      • SCROLLABLE

        public static final String SCROLLABLE

        Add this stylename to enable the scrollbars in the component when content overflows. This is useful

        See Also:

        Constant Field Values

    • Constructor Detail

      • ValoTheme

        protected ValoTheme()