Holon Platform Vaadin 7 Module - Reference manual

Input<String> stringInput = Components.input.string().caption("String input").inputPrompt("Value here")
    .maxLength(100).styleName("mystyle").build(); (1)

stringInput.setValue("test"); (2)
String value = stringInput.getValue(); (3)

stringInput.addValueChangeListener(e -> System.out.println("Value: " + e.getValue())); (4)

Input<LocalDate> dateInput = Components.input.localDate().caption("Date input").lenient(true).build(); (1)

Component inputComponent = dateInput.getComponent(); (2)

Input<String> stringInput = Input.from(new TextField());

Field<Locale> localeField = Components.input.singleSelect(Locale.class).items(Locale.US, Locale.CANADA)
    .caption("Select Locale").fullWidth().withValue(Locale.US).asField(); (1)

Input<String> stringInput = Components.input.string().build();
ValidatableInput<String> validatableInput = ValidatableInput.from(stringInput); (1)

validatableInput.addValidator(Validator.email()); (2)
validatableInput.addValidator(Validator.max(100)); (3)

validatableInput.setValidationStatusHandler(e -> { (4)
  if (e.isInvalid()) {
    Notification.show(e.getErrorMessage(), Type.ERROR_MESSAGE);
  }
});

validatableInput.validate(); (5)

validatableInput.setValidateOnValueChange(true); (6)

ValidatableInput<String> validatableInput = ValidatableInput.from(Components.input.string().build()); (1)

validatableInput = ValidatableInput.from(new TextField()); (2)

validatableInput = Components.input.string().validatable() (3)
    .required("Value is required") (4)
    .withValidator(Validator.max(100)).build(); (5)

SingleSelect<TestData> singleSelect = Components.input.singleSelect(TestData.class).caption("Single select")
    .build(); (1)

singleSelect.setValue(new TestData(1)); (2)
singleSelect.select(new TestData(1)); (3)

singleSelect.clear(); (4)
singleSelect.deselectAll(); (5)

boolean selected = singleSelect.isSelected(new TestData(1)); (6)

singleSelect.addSelectionListener(
    s -> s.getFirstSelectedItem().ifPresent(i -> Notification.show("Selected: " + i.getId()))); (7)

MultiSelect<TestData> multiSelect = Components.input.multiSelect(TestData.class).caption("Multi select")
    .build(); (1)

Set<TestData> values = new HashSet<>();
values.add(new TestData(1));
values.add(new TestData(2));

multiSelect.setValue(values); (2)
multiSelect.select(new TestData(3)); (3)

multiSelect.deselect(new TestData(3)); (4)

multiSelect.clear(); (5)
multiSelect.deselectAll(); (6)

boolean selected = multiSelect.isSelected(new TestData(1)); (7)

multiSelect.addSelectionListener(s -> Notification.show(s.getAllSelectedItems().stream()
    .map(i -> String.valueOf(i.getId())).collect(Collectors.joining(";", "Selected: ", "")))); (8)

final PathProperty<Long> ID = PathProperty.create("id", Long.class);
final PathProperty<String> DESCRIPTION = PathProperty.create("description", String.class);

final PropertySet<?> PROPERTIES = PropertySet.of(ID, DESCRIPTION);

PropertyInputGroup group = Components.input.propertyGroup().properties(PROPERTIES) (1)
    .bind(ID, Components.input.number(Long.class).build()) (2)
    .bind(DESCRIPTION, Components.input.string().maxLength(100).build()) (3)
    .build();

group.setValue(PropertyBox.builder(PROPERTIES).set(ID, 1L).set(DESCRIPTION, "TestDescription").build()); (4)

PropertyBox value = group.getValue(); (5)

group.addValueChangeListener(e -> { (6)
  PropertyBox changedValue = e.getValue();
});

final PathProperty<Long> ID = PathProperty.create("id", Long.class);
final PathProperty<String> DESCRIPTION = PathProperty.create("description", String.class);

final PropertySet<?> PROPERTIES = PropertySet.of(ID, DESCRIPTION);

PropertyInputGroup group = Components.input.propertyGroup().properties(PROPERTIES).build(); (1)

final PathProperty<Long> ID = PathProperty.create("id", Long.class);
final PathProperty<String> DESCRIPTION = PathProperty.create("description", String.class);

final PropertySet<?> PROPERTIES = PropertySet.of(ID, DESCRIPTION);

PropertyInputGroup group = Components.input.propertyGroup().properties(PROPERTIES) //
    .withValidator(DESCRIPTION, Validator.max(100)) (1)
    .required(ID) (2)
    .required(ID, "The ID value is required") (3)
    .withValidator(Validator.create(propertyBox -> propertyBox.getValue(ID) > 0,
        "The ID value must be greater than 0")) (4)
    .build();

PropertyInputGroup group = createInputGroup();

group.validate(); (1)

PropertyBox value = group.getValue(); (2)

value = group.getValue(false); (3)

value = group.getValueIfValid().orElse(null); (4)

final PathProperty<Long> ID = PathProperty.create("id", Long.class);
final PathProperty<String> DESCRIPTION = PathProperty.create("description", String.class);

final PropertySet<?> PROPERTIES = PropertySet.of(ID, DESCRIPTION);

PropertyInputGroup group = Components.input.propertyGroup().properties(PROPERTIES) //
    .stopValidationAtFirstFailure(true) (1)
    .stopOverallValidationAtFirstFailure(true) (2)
    .validationStatusHandler(validationEvent -> { (3)
      // ...
    }).propertiesValidationStatusHandler(validationEvent -> { (4)
      // ...
    }).build();

final PathProperty<Long> ID = PathProperty.create("id", Long.class);
final PathProperty<String> DESCRIPTION = PathProperty.create("description", String.class);

final PropertySet<?> PROPERTIES = PropertySet.of(ID, DESCRIPTION);

PropertyInputForm form = Components.input.form(new FormLayout()).properties(PROPERTIES).required(ID).build(); (1)

form = Components.input.form(new FormLayout()).properties(PROPERTIES).required(ID)
    .composer((layout, source) -> { (2)
      source.getValueComponents().forEach(c -> layout.addComponent(c.getComponent()));
    }).build();

form.setValue(PropertyBox.builder(PROPERTIES).set(ID, 1L).set(DESCRIPTION, "Test").build()); (3)

PropertyBox value = form.getValue(); (4)

PropertyInputForm form = Components.input.form().properties(PROPERTY_SET).build(); (1)
form = Components.input.formVertical().properties(PROPERTY_SET).build(); (2)
form = Components.input.formHorizontal().properties(PROPERTY_SET).build(); (3)
form = Components.input.formGrid().properties(PROPERTY_SET)
    .initializer(gridLayout -> gridLayout.setSpacing(true)).build(); (4)

ViewComponent<String> view = Components.view.component(String.class)
    .caption("TheCaption", "caption.message.code").icon(FontAwesome.CAMERA).styleName("my-style").build(); (1)

view.setValue("TestValue"); (2)
String value = view.getValue(); (3)

private class TestData {

  private Long id;
  private String description;

  // getters and setters omitted

}

public void beanListing() {
  BeanListing<TestData> listing = Components.listing.items(TestData.class) (1)
      .header("id", "The ID") (2)
      .header("description", "The description") (3)
      .build();

  listing.refresh(); (4)

  listing = Components.listing.itemsUsingTable(TestData.class).build(); (5)
}

final PathProperty<Long> ID = PathProperty.create("id", Long.class);
final PathProperty<String> DESCRIPTION = PathProperty.create("description", String.class);

final PropertySet<?> PROPERTIES = PropertySet.of(ID, DESCRIPTION);

PropertyListing listing = Components.listing.properties(PROPERTIES).build(); (1)

listing = Components.listing.propertiesUsingTable(PROPERTIES).build(); (2)

ItemDataProvider<PropertyBox> dataProvider = getDataProvider();
PropertyListing listing = Components.listing.properties(PROPERTIES) //
    .dataSource(dataProvider) (1)
    .build();

ItemDataProvider<PropertyBox> dataProvider = getDataProvider();

PropertyListing listing = Components.listing.properties(PROPERTIES) //
    .dataSource(dataProvider, item -> item.getValue(ID)) (1)
    .build();

listing = Components.listing.properties(PROPERTIES) //
    .dataSource(dataProvider, ID) (2)
    .build();

Datastore datastore = getDatastore();

PropertyListing listing = Components.listing.properties(PROPERTIES) //
    .dataSource(datastore, DataTarget.named("test"), ID) (1)
    .build();

PropertyListing listing = Components.listing.properties(PROPERTIES) //
    .header(ID, "Custom ID header") (1)
    .columnHidingAllowed(true) (2)
    .hidable(ID, false) (3)
    .columnReorderingAllowed(true) (4)
    .alignment(ID, ColumnAlignment.RIGHT) (5)
    .hidden(DESCRIPTION, true) (6)
    .resizable(ID, false) (7)
    .width(ID, 100) (8)
    .expandRatio(DESCRIPTION, 1) (9)
    .minWidth(DESCRIPTION, 200) (10)
    .maxWidth(DESCRIPTION, 300) (11)
    .style(ID, (property, item) -> item.getValue(DESCRIPTION) != null ? "empty" : "not-empty") (12)
    .withPropertyReorderListener((properties, userOriginated) -> { (13)
      // ...
    }).withPropertyResizeListener((property, widthInPixel, userOriginated) -> { (14)
      // ...
    }).withPropertyVisibilityListener((property, hidden, userOriginated) -> { (15)
      // ...
    }).build();

PropertyListing listing = Components.listing.properties(PROPERTIES) //
    .render(ID, new NumberRenderer(Locale.US)) (1)
    .render(ID, new Converter<String, Long>() { (2)

      @Override
      public Long convertToModel(String value, Class<? extends Long> targetType, Locale locale)
          throws ConversionException {
        return Long.valueOf(value);
      }

      @Override
      public String convertToPresentation(Long value, Class<? extends String> targetType, Locale locale)
          throws ConversionException {
        return (value == null) ? null : String.valueOf(value);
      }

      @Override
      public Class<Long> getModelType() {
        return Long.class;
      }

      @Override
      public Class<String> getPresentationType() {
        return String.class;
      }
    }, new TextRenderer()).build();

PropertyListing listing = Components.listing.properties(PROPERTIES) //
    .heightByContents() (1)
    .frozenColumns(1) (2)
    .hideHeaders() (3)
    .withRowStyle(item -> { (4)
      return item.getValue(DESCRIPTION) != null ? "has-des" : "no-nes";
    }) //
    .itemDescriptionGenerator(item -> item.getValue(DESCRIPTION)) (5)
    .detailsGenerator(item -> { (6)
      VerticalLayout component = new VerticalLayout();
      // ...
      return component;
    }).withItemClickListener((item, property, event) -> { (7)
      // ...
    }).header(header -> { (8)
      header.getDefaultRow().setStyleName("my-header");
    }).footer(footer -> { (9)
      footer.appendRow().setStyleName("my-footer");
    }).footerGenerator((source, footer) -> { (10)
      footer.getRowAt(0).getCell(ID).setText("ID footer");
    }).withPostProcessor(grid -> { (11)
      // ...
    }).build();

PropertyListing listing = Components.listing.properties(PROPERTIES) //
    .selectionMode(SelectionMode.SINGLE) (1)
    .build();

final PropertyBox ITEM = PropertyBox.builder(PROPERTIES).set(ID, 1L).build();

PropertyBox selected = listing.getFirstSelectedItem().orElse(null); (2)

boolean isSelected = listing.isSelected(ITEM); (3)

listing.select(ITEM); (4)

listing.deselectAll(); (5)

PropertyListing listing = Components.listing.properties(PROPERTIES) //
    .build();

listing.setSelectionMode(SelectionMode.MULTI); (1)

final PropertyBox ITEM = PropertyBox.builder(PROPERTIES).set(ID, 1L).build();

Set<PropertyBox> selected = listing.getSelectedItems(); (2)

boolean isSelected = listing.isSelected(ITEM); (3)

listing.select(ITEM); (4)

listing.deselectAll(); (5)

listing.selectAll(); (6)

PropertyListing listing = Components.listing.properties(PROPERTIES) //
    .sortable(ID, true) (1)
    .sortUsing(ID, DESCRIPTION) (2)
    .sortGenerator(ID, (property, ascending) -> { (3)
      return ascending ? ID.asc() : ID.desc();
    }) //
    .fixedSort(ID.asc()) (4)
    .defaultSort(DESCRIPTION.asc()) (5)
    .fixedFilter(ID.gt(0L)) (6)
    .withQueryConfigurationProvider(() -> DESCRIPTION.isNotNull()) (7)
    .build();

Datastore datastore = getDatastore();

PropertyListing listing = Components.listing.properties(PROPERTIES) //
    .dataSource(datastore, DataTarget.named("test"), ID) (1)
    .commitHandler((addedItems, modifiedItems, removedItems) -> { (2)
      // ...
    }).build();

final PropertyBox ITEM = PropertyBox.builder(PROPERTIES).set(ID, 777L).set(DESCRIPTION, "A description")
    .build();

listing.addItem(ITEM); (3)

listing.refreshItem(ITEM); (4)

listing.removeItem(ITEM); (5)

PropertyListing listing = Components.listing.properties(PROPERTIES) //
    .editable(true) (1)
    .editorSaveCaption("Save item") (2)
    .editorCancelCaption("Discard") (3)
    .editable(ID, false) (4)
    .editor(DESCRIPTION, new TextField()) (5)
    .withValidator(DESCRIPTION, Validator.max(100)) (6)
    .required(ID) (7)
    .build();

Components.questionDialog() (1)
    .message("Can I do it for you?") (2)
    .yesButtonConfigurator(cfg -> cfg.caption("Ok, let's do it")) (3)
    .noButtonConfigurator(cfg -> cfg.caption("No, thanks")) (4)
    .callback(answeredYes -> { (5)
      Notification.show("Ok selected: " + answeredYes);
    }).build().open(); (6)

final PathProperty<String> TEXT = PathProperty.create("text", String.class);

InputPropertyRenderer<String> textAreaInputRenderer = p -> Components.input.string(true).build(); (1)

PropertyRendererRegistry.get().register(p -> p == TEXT, textAreaInputRenderer); (2)

Input<String> input = TEXT.render(Input.class); (3)

InputFieldPropertyRenderer<String> fieldRenderer = p -> new TextArea(); (4)

class AppUI extends UI {

  @Override
  protected void init(VaadinRequest request) {
    ViewNavigator navigator = ViewNavigator.builder() (1)
        .viewDisplay(this) (2)
        .addProvider(getViewProvider()) (3)
        .defaultViewName("home") (4)
        .errorView(MY_ERROR_VIEW) (5)
        .errorViewProvider(getErrorViewProvider()) (6)
        .maxNavigationHistorySize(1000) (7)
        .navigateToDefaultViewWhenViewNotAvailable(true) (8)
        .withViewChangeListener(new ViewChangeListener() { (9)

          @Override
          public boolean beforeViewChange(ViewChangeEvent event) {
            // ...
            return true;
          }

          @Override
          public void afterViewChange(ViewChangeEvent event) {
            // ...

          }
        }).buildAndBind(this); (10)
  }

}

UI ui = getUI();
ViewNavigator.builder() //
    .viewDisplay(ui) //
    .withView("view1", View1.class) (1)
    .withView("view2", View2.class) (2)
    .defaultViewName("view1") (3)
    .buildAndBind(ui);

@VolatileView
class VolatileViewExample implements View {

  @Override
  public void enter(ViewChangeEvent event) {
  }

}

@WindowView(windowWidth = "50%")
class WindowViewExample implements View {

  @Override
  public void enter(ViewChangeEvent event) {
  }

}

ViewNavigator navigator = getViewNavigator();

navigator.navigateTo("myView"); (1)

Map<String, Object> parameters = new HashMap<>();
parameters.put("parameter1", "test");
parameters.put("parameter2", 34.5);

navigator.navigateTo("myView", parameters); (2)

ViewNavigator navigator = getViewNavigator();

navigator.navigateInWindow("myView"); (1)

Map<String, Object> parameters = new HashMap<>();
parameters.put("parameter1", "test");
parameters.put("parameter2", 34.5);

navigator.navigateInWindow("myView", windowConfig -> {
  windowConfig.fullWidth();
  windowConfig.styleName("my-window-style");
}, parameters); (2)

ViewNavigator navigator = getViewNavigator();

navigator.toView("myView").withParameter("parameter1", "test").withParameter("parameter2", 34.5).navigate(); (1)

navigator.toView("myView").navigateInWindow(); (2)

navigator.toView("myView").navigateInWindow(windowConfig -> {
  windowConfig.fullWidth();
  windowConfig.styleName("my-window-style");
}); (3)

class SubViewContainerExample extends TabSheet implements SubViewContainer { (1)

  public SubViewContainerExample() {
    super();
    setSizeFull();
  }

  @Override
  public boolean display(View view, String viewName, Map<String, String> parameters)
      throws ViewNavigationException {
    addTab(ViewNavigator.getViewContent(view), viewName, FontAwesome.PUZZLE_PIECE);
    return true;
  }

  @Override
  public View getCurrentView() {
    return (View) getSelectedTab();
  }

  @Override
  public void enter(ViewChangeEvent event) {
  }

}

@SubViewOf("mycontainer")
public class SubViewExample extends VerticalLayout implements View { (2)

  public SubViewExample() {
    super();
    setMargin(true);
    addComponent(new Label("The sub view 1"));
  }

  @Override
  public void enter(ViewChangeEvent event) {
  }

}

class ViewContextExample implements View {

  @ViewContext
  private LocalizationContext localizationContext;

  @ViewContext
  private AuthContext authContext;

  @Override
  public void enter(ViewChangeEvent event) {
  }

}

Optional<ViewNavigator> navigator = ViewNavigator.getCurrent(); (1)

ViewNavigator viewNavigator = ViewNavigator.require(); (2)

@Configuration (1)
@ComponentScan(basePackageClasses = ViewOne.class) (2)
@EnableViewNavigator (3)
@EnableBeanContext (4)
class SpringConfig {

}

@SpringView(name = "view1") (5)
@DefaultView (6)
class ViewOne extends VerticalLayout implements View {

  @Override
  public void enter(ViewChangeEvent event) {
  }

}

@SpringView(name = "view2") (7)
@UIScope (8)
class ViewTwo extends VerticalLayout implements View {

  @Override
  public void enter(ViewChangeEvent event) {
  }

}

@SpringUI (9)
@SpringViewDisplay (10)
class AppUI extends UI {

  @Autowired
  ViewNavigator navigator; (11)

  @Override
  protected void init(VaadinRequest request) {
    // ...
  }

}

@Configuration
@ComponentScan(basePackageClasses = ViewOne.class)
@EnableViewNavigator
@EnableBeanContext (1)
@EnableViewAuthorization (2)
class SpringConfig {

  @Bean (3)
  @VaadinSessionScope
  public AuthContext authContext() {
    AccountProvider ap = id -> {
      // Only a user with username 'username1' is available
      if ("username1".equals(id)) {
        // setup the user password and assign the role 'role1'
        return Optional.of(Account.builder(id).credentials(Credentials.builder().secret("s3cr3t").build())
            .withPermission("role1").build());
      }
      return Optional.empty();
    };
    return AuthContext.create(Realm.builder()
        // authenticator using the AccountProvider
        .withAuthenticator(Account.authenticator(ap))
        // default authorizer
        .withDefaultAuthorizer().build());
  }

}

@SpringView(name = "view1")
@PermitAll (4)
class ViewOne extends VerticalLayout implements View {

  @Override
  public void enter(ViewChangeEvent event) {
  }

}

@SpringView(name = "view2")
@RolesAllowed("role1") (5)
class ViewTwo extends VerticalLayout implements View {

  @Override
  public void enter(ViewChangeEvent event) {
  }

}

@AccessDeniedView (6)
@UIScope
@SpringView(name = "forbidden")
class AccessDenied extends VerticalLayout implements View {

  private static final long serialVersionUID = 1L;

  private final Label message;

  public AccessDenied() {
    super();
    Components.configure(this).margin()
        .add(message = Components.label().styleName(ValoTheme.LABEL_FAILURE).build());
  }

  @Override
  public void enter(ViewChangeEvent event) {
    message.setValue("Access denied [" + event.getViewName() + "]");
  }

}

<groupId>com.holon-platform.vaadin7</groupId>
<artifactId>holon-starter-vaadin</artifactId>
<version>5.2.4</version>

<groupId>com.holon-platform.vaadin7</groupId>
<artifactId>holon-starter-vaadin-undertow</artifactId>
<version>5.2.4</version>