Styling a Widget

To make your widget look stylish, you need to style it. There are two basic ways to define CSS styles for a component: in the widget sources and in a theme. A default style should be defined in the widget sources, and different themes can then modify the style.

Determining the CSS Class

The CSS class of a widget element is normally defined in the widget class and set with setStyleName(). A widget should set the styles for its sub-elements as it desires.

For example, you could style a composite widget with an overall style and with separate styles for the sub-widgets as follows:

Java

  1. public class MyPickerWidget extends ComplexPanel {
  2.     public static final String CLASSNAME = "mypicker";
  4.     private final TextBox textBox = new TextBox();
  5.     private final PushButton button = new PushButton("...");
  7.     public MyPickerWidget() {
  8.         setElement(Document.get().createDivElement());
  9.         setStylePrimaryName(CLASSNAME);
  11.         textBox.setStylePrimaryName(CLASSNAME + "-field");
  12.         button.setStylePrimaryName(CLASSNAME + "-button");
  14.         add(textBox, getElement());
  15.         add(button, getElement());
  17.         button.addClickHandler(new ClickHandler() {
  18.             public void onClick(ClickEvent event) {
  19.               Window.alert("Calendar picker not yet supported!");
  20.             }
  21.         });
  22.     }
  23. }

In addition, all Vaadin components get the v-widget class. If it extends an existing Vaadin or GWT widget, it will inherit CSS classes from that as well.

Default Stylesheet

A client-side module, which is normally a widget set, can include stylesheets. They must be placed under the public folder under the folder of the widget set, a described in “Specifying a Stylesheet”.

For example, you could style the widget described above as follows:

  1. .mypicker {
  2.     white-space: nowrap;
  3. }
  5. .mypicker-button {
  6.     display: inline-block;
  7.     border: 1px solid black;
  8.     padding: 3px;
  9.     width: 15px;
  10.     text-align: center;
  11. }

Notice that some size settings may require more complex handling and calculating the sizes dynamically.