This document provides an agenda for discussing how to build GWT UI's using Polymer elements. It covers motivations for using this approach, an overview of web components and Polymer, how to consume web components in GWT using JsInterop and custom interfaces, introducing the gwt-polymer-elements library, and demonstrates a full-stack GWT app using Polymer and REST services.
17. Polymer
- Polymer makes it easier and faster to create anything
from a button to a complete application across
desktop, mobile, and beyond.
- Polymer ecosystem enables sharing UI components
between developers.
- JS estable API & polyfills
- Production ready reusable components
- Documentation system
- Let's GWT take advantage of the JS ecosystem to
create amazing UIs.
18. Catalog
- Iron Elements
- Paper Elements -> Material Design
- Neon Elements
- Platinum Elements
- Google Elements
- Vaadin Elements
20. 1. Why JsInterop
a. Nowadays most GWT big projects interact with JS libs.
b. JSNI is a bad option for complex scenarios
2. JsInterop magic allows interact natively with Js. No JSNI anymore!
a. @JsType
b. @JsProperty @JsConstructor @JsMethod @JsFunction
c. Issues ? : experimental, does not extend JSO
3. Elemental-2.0 Interfaces for all HTML
a. Window, Document, Element, Style, Events, …
b. Issue: not available yet 2.8.x ?
4. Code generation
a. Let’s explore ways to create java boilerplate code
GWT JsInterop
22. 1. Code Interfaces for Native Objects (Elemental-2)
2. Code methods for interacting with Web
Components Spec (create, import ...).
3. Define an annotated Java Interface per component,
event or behavior.
- Extends HTMLElement or Event
4. Optionally Wrap each Interface in a Widget class for
classic GWT apps.
Steps to consume WC in Java
23. Interfaces for native JS objects
@JsType
public interface HTMLElement extends Element {
}
@JsType
public interface Element extends Node {
@JsProperty String getInnerHTML();
@JsProperty DOMTokenList getClassList();
void setAttribute(String name, String value);
String getAttribute(String name);
void removeAttribute(String name);
}
@JsType
public interface Node extends EventTarget {
}
@JsType
public interface EventTarget {
void addEventListener(String type, EventListener listener);
}
Elemental-2 (gwt-2.8.1)
24. Utility methods
public class Polymer {
...
// Ensures that the tagName has been registered, otherwise injects
// the appropriate <import> tag in the document header
public static void ensureHTMLImport(String tagName) {
if ( !registered(tagName)) {
String href =
GWT.getModuleBaseForStaticFiles() + "bower_components/" + tagName + "/" + tagName + ".html";
Polymer.Base.importHref(href);
}
}
// Returns a new instance of the Element. It loads the webcomponent
// if not loaded yet.
public static <T> T createElement(String tagName) {
ensureHTMLImport(tagName);
return (T)Document.get().createElement(tagName);
}
...
}
26. Consuming WC in Java (Element API)
// Create a new instance of PaperButton
PaperButtonElement button = Polymer.create(PaperButtonElement.TAG);
// Set some properties
button.icon("polymer");
button.label("Polymer");
button.raisedButton(false);
// Add event listeners
button.addEventListener("click", e -> {
});
// Append to the document
document.get().ppendChild(button);
27. The WebComponentWidget.java
public class PaperButton extends PolymerWidget {
//Default Constructor.
public PaperButton() {
this("");
}
//Constructor used by UIBinder
public PaperButton(String html) {
this(PaperButtonElement.TAG, html);
}
// Used when this element is extended by another.
protected PaperButton(String tag, String html) {
super(tag, html);
}
// Gets a handle to the Polymer object's underlying DOM element.
public PaperButtonElement getPolymerElement() {
return (PaperButtonElement) getElement();
}
public boolean isRaised() {
return getPolymerElement().isRaised();
}
}
public class PolymerWidget extends HTMLPanel {
public PolymerWidget(String tag, String src, String html) {
super(tag, html);
Polymer.ensureCustomElement(getElement(), src);
}
...
}
28. Consuming WC in Java (Widget API)
// Widgets allow consume WC using the GWT classic way.
PaperButton button = new PaperButton();
button.addClickHandler(new ClickHandler() {
public void onClick(ClickEvent event) {
// ...
}
});
RootPanel.get().add(button);
29. Consuming WC in UIBinder
<ui:UiBinder xmlns:ui='urn:ui:com.google.gwt.uibinder'
xmlns:g='urn:import:com.google.gwt.user.client.ui'
xmlns:p='urn:import:com.vaadin.components.gwt.polymer.client.widget'>
<ui:style>
.container paper-button.colored {
background: #4285f4;
color: #fff;
}
</ui:style>
<g:HTMLPanel>
<!-- to use widgets we don’t need to import webcomponents by hand -->
<p:PaperButton toggle="" raised="" active="" addStyleNames="{style.colored}">active</p:PaperButton>
<!-- to use elements it’s mandatory to import webcomponents previously -->
<paper-button raised="" noink="">Click me</paper-button>
</g:HTMLPanel>
31. Two Projects
1. gwt-api-generator: It’s a code generator to produce
GWT wrappers for JS components
a. Scrapes source documentation
b. Right now polymer, but considering other sources.
c. Uses standard JS libraries to parse components.
- node.js, npm, bower, gulp
- hydrolysis parser + lodash.template
2. gwt-polymer-elements: a ready-to-use library for
using polymer elements in gwt (iron, paper, neon, vaadin)
a. Version 1.2.1.0.alpha1 (polymer 1.2.1)
b. Still under definition, expect package name changes, etc
33. 1. Add java dependency to your project.
- vaadin-gwt-polymer-elements-1.2.1.0-alpha1.jar
2. Inherit it in your GWT module
- <inherits name="com.vaadin.polymer.Elements"/>
3. Use new Widgets or Elements as usual
- Document.get().createElement("PaperSliderElement")
4. Run mvn clean install to produce your package .jar
5. Everything is contained in the artefact
- polyfill, components, java code.
gwt-polymer-elements (bundle)
34. 1. Install the generator
- sudo npm install gwt-api-generator -g
2. Install all the components you need for your project.
- bower install my-github-account/my-custom-polymer-element
3. Run the script to generate .java classes
- gwt-api-generator [--pom --groupId=xx --artifactId=xx]
4. Run mvn clean install to produce your gwt-package .jar
gwt-api-generator (custom elements)
35. gwt-api-generator goals
1. Very little code to maintain.
a. 1500 LOC / 100 KB
2. But it produces a lot of java code
a. 50000 LOC (paper & core elements)
3. It uses native JS parsers for JS code.
a. The same tools that polymer developers use
b. No GWT generators nor APT processors.
4. Standard tools for web developers.
a. They can deliver gwt libraries without knowing any java
38. Demo Components
- GWT + Polymer
- CouchDB is a database that completely embraces
the web.
- Store your data with JSON documents
- Access your data via HTTP
- Serve pages directly
- PouchDB is database inspired by Apache CouchDB
that is designed to run well within the browser.