migrating from ext gwt 2.x to 3.0

Thursday, November 3, 2011

Darrell MeyerExt GWT Lead

Sencha Inc.

[email protected]#darrellmeyer

2.0 to 3.0 MIGRATION GUIDE


mailto:[email protected]

mailto:[email protected]

OverviewGeneral Changes

ComponentsLayoutsModels

Data WidgetsStores & Loaders

Theming


General Changes


General ChangesPackage namespace change com.extjs to com.senchaModule breakupcom.sencha.gxt.core.Corecom.sencha.gxt.cell.Corecom.sencha.gxt.data.Datacom.sencha.gxt.dnd.DNDcom.sencha.gxt.fx.Fxcom.sencha.gxt.messages.Messagescom.sencha.gxt.state.Statecom.sencha.gxt.theme.Basecom.sencha.gxt.theme.Bluecom.sencha.gxt.widget.Corecom.sencha.gxt.ui.GXT - works like 2.0 GXT module


Legacy ModuleBindingsModelDataMVCOld XTemplate


Deprecated Code

All GXT 2.0 deprecated code removed from 3.0com.extjs.gxt.ui.client.binder - move to legacycom.extjs.gxt.ui.client.treecom.extjs.gxt.ui.client.treetable


Components


El vs. XElementXElement replaces El classXElement extends JavaScriptObject is not wrappercomponent.el() now component.getElement()Any GWT Element can be cast to XElement

// 2.0 ContentPanel panel = new ContentPanel(); panel.el().getFrameWidth("lr"); // 3.0 ContentPanel panel = new ContentPanel(); panel.getElement().getFrameWidth(Side.LEFT, Side.RIGHT); // casting Element to XElement HTML html = new HTML("I am a GWT Widget"); html.getElement().<XElement>cast().getFrameWidth(Side.LEFT, Side.RIGHT);


XTemplateReplaced runtime JavaScript XTemplateCompile time using Deferred BindingCan retrieve data from any Java BeanWorks with SafeHtml


2.0 XTemplate

XTemplate.create(getDetailTemplate());

public native String getDetailTemplate() /*-{ return ['<div class="details">', '<tpl for=".">', '<img src="{modPath}"><div class="details-info">', '<b>Image Name:</b>', '<span>{name}</span>', '<b>Size:</b>', '<span>{sizeString}</span>', '<b>Last Modified:</b>', '<span>{dateString}</span></div></tpl></div>'].join(""); }-*/;


3.0 XTemplate

interface DetailRenderer extends XTemplates { @XTemplate(source = "AdvancedListViewDetail.html") public SafeHtml render(Photo photo);}

DetailRenderer renderer = GWT.create(DetailRenderer.class);

<div class="details"> <img src="{path}"><div class="details-info"> <b>Image Name:</b><span>{name}</span> <b>Size:</b><span>{size:number("#0")}k</span> <b>Last Modified:</b><span>{date:date("M/d/yyyy")}</span></div>


Lazy Rendering


Lazy Rendering2.0Components create their DOM lazilyCan’t work on DOM before Component rendered



3.0Component create their DOM at constructionDOM available immediately



// 2.0 ContentPanel panel = new ContentPanel(); panel.el().setLeft(10); // fails, DOM does not exist // 3.0 ContentPanel panel = new ContentPanel(); panel.getElement().setLeft(10); // works

3.0Component create their DOM at constructionDOM available immediately


Events & Handlers


Events & Handlers

2.0Custom GXT events & handlersEvents have getters not applicable to all eventsMust read docs


Events & Handlers

2.0Custom GXT events & handlersEvents have getters not applicable to all eventsMust read docs

3.0GWT HandlersStrongly TypedTyped events vs. generic events


Events & Handlers


// 2.0 generic listeners, must match event with correct event type ContentPanel panel = new ContentPanel(); panel.addListener(Events.Expand, new Listener<ComponentEvent>() { public void handleEvent(ComponentEvent be) { // generic event } });

Events & Handlers


// 2.0 generic listeners, must match event with correct event type ContentPanel panel = new ContentPanel(); panel.addListener(Events.Expand, new Listener<ComponentEvent>() { public void handleEvent(ComponentEvent be) { // generic event } });

Events & Handlers

// 3.0 strongly typed, can’t misuse API ContentPanel panel = new ContentPanel(); panel.addExpandHandler(new ExpandHandler() { @Override public void onExpand(ExpandEvent event) { // typed event } });


ContentPanel Changes



2.0ContentPanel supports “framed / unframed”Support top component and bottom component



2.0ContentPanel supports “framed / unframed”Support top component and bottom component

3.0ContentPanel & FramedPanelRemoved support of top and bottom component


2.0 ContentPanel

ContentPanel panel = new ContentPanel(); panel.setFrame(true); panel.setLayout(new FitLayout()); ToolBar toolBar = new ToolBar(); toolBar.add(new LabelToolItem("ToolBar")); panel.setTopComponent(toolBar); panel.add(new Html("Fill panel"));


3.0 ContentPanel FramedPanel panel = new FramedPanel(); // panel extends SimpleContainer VerticalLayoutContainer con = new VerticalLayoutContainer(); panel.setWidget(con); ToolBar toolBar = new ToolBar(); toolBar.add(new LabelToolItem("ToolBar")); con.add(toolBar, new VerticalLayoutData(1, -1)); con.add(new HTML("Fill panel"), new VerticalLayoutData(1, 1));


Fields & FormLayout


Fields & FormLayout

2.0Label set of fields directlyField labels can only be rendered into FormLayout


Fields & FormLayout

2.0Label set of fields directlyField labels can only be rendered into FormLayout

3.0Labels provided via FieldLabelFields and FieldLabel can render any any layoutFormLayout no longer needed and removed


Field Validation


Field Validation2.0Validation built into fields themselvesValidator interface only supported with TextFieldHard to add custom validation


Field Validation2.0Validation built into fields themselvesValidator interface only supported with TextFieldHard to add custom validation

3.0Validation removed from FieldsAll fields support adding zero to many Validators


Field Validators

field = new TextField(); field.addValidator(new MinLengthValidator(4)); field.addValidator(new EmptyValidator<String>()); number = new NumberField<Integer>(new IntegerPropertyEditor()); number.addValidator(new MinNumberValidator<Integer>(3));


Layouts


Layouts

2.0Generic container supports all layoutsPossible to use wrong layout data with layout


Layouts

2.0Generic container supports all layoutsPossible to use wrong layout data with layout

3.0Layout collapsed into containerStrongly typed layout containers


Layouts

Container

BorderLayoutContainerBorderLayout

CenterLayout

FlowLayout

CenterLayoutContainer

FlowLayoutContainer

3.02.0


Layout Example


// 2.0 LayoutContainer con = new LayoutContainer(); con.setLayout(new FlowLayout()); con.add(new HTML("child 1")); // 2nd param takes any layout data instance con.add(new HTML("child 2"), new MarginData(5));

Layout Example


// 2.0 LayoutContainer con = new LayoutContainer(); con.setLayout(new FlowLayout()); con.add(new HTML("child 1")); // 2nd param takes any layout data instance con.add(new HTML("child 2"), new MarginData(5));

Layout Example

// 3.0 FlowLayoutContainer con = new FlowLayoutContainer(); con.add(new HTML("child 1")); // 2nd param only takes margin data con.add(new HTML("child 2"), new MarginData(5));


Models


2.0 ModelDataGWT does not provide introspectionModelData provides access to property and valuesStores data in map

public interface ModelData { public <X> X get(String property); public Map<String, Object> getProperties(); public Collection<String> getPropertyNames(); public <X> X remove(String property); public <X> X set(String property, X value);}


3.0 ModelsSupport any bean-like objectNot forced to implement GXT interfacesNot forced to use GXT model classesInteroperability with RPC, RequestFactor, AutoBean


ValueProvider interface PostProperties extends PropertyAccess<Post> { ModelKeyProvider<Post> id();

ValueProvider<Post, String> username();

ValueProvider<Post, String> forum();

ValueProvider<Post, String> subject();

ValueProvider<Post, Date> date(); }

// create properties instance via deferred binding PostProperties props = GWT.create(PostProperties.class);

// use model key provider and value providers ListStore<Post> store = new ListStore<Post>(props.id()); new ColumnConfig<Post, String>(props.forum(), 150, "Forum");


interface XmlAutoBeanFactory extends AutoBeanFactory { static XmlAutoBeanFactory instance = GWT.create(XmlAutoBeanFactory.class);

AutoBean<EmailCollection> items(); }

interface ContactCollection { @PropertyName("records/record") List<Email> getValues(); }

interface Contact { @PropertyName("Name") String getName();

@PropertyName("Email") String getEmail();

@PropertyName("Phone") String getPhone(); }

Xml AutoBeans


Data Widgets


Renderers Vs Cells


Renderers Vs Cells

2.0Customize data via renderers which return HTML or WidgetsRenderers do not support events


Renderers Vs Cells

2.0Customize data via renderers which return HTML or WidgetsRenderers do not support events

3.0All data widgets support cellsCells support events and can fire eventsHigh performance via flyweight pattern


Event Cell Example

cell = new SimpleSafeHtmlCell<String>(SimpleSafeHtmlRenderer.getInstance(), "click") {

@Override public void onBrowserEvent(Context context, Element parent, String value, NativeEvent event, ValueUpdater<String> valueUpdater) { super.onBrowserEvent(context, parent, value, event, valueUpdater); if ("click".equals(event.getType())) { Info.display("Click", "You clicked \"" + value + "\"!"); } } };

tree.setCell(cell);


2.0 Renderer

renderer = new GridCellRenderer<ModelData>() {

public Object render(ModelData model, String property, ColumnData config, int rowIndex, int colIndex, ListStore<ModelData> store, Grid<ModelData> grid) {

Button button = new Button("Click Me"); button.addSelectionListener(new SelectionListener<ButtonEvent>() { @Override public void componentSelected(ButtonEvent ce) { Info.display("Event", "Button Clicked"); } }); return button; } };


3.0 Cells

ColumnConfig column = new ColumnConfig(); column.setRenderer(renderer);

cc1 = new ColumnConfig<Plant, String>(properties.name(), 100, "Name"); TextButtonCell button = new TextButtonCell(); button.addSelectHandler(new SelectHandler() { @Override public void onSelect(SelectEvent event) { Context c = event.getContext(); int row = c.getIndex(); Plant p = store.get(row); Info.display("Event", "The " + p.getName() + " was clicked."); } }); cc1.setCell(button);


Stores & Loaders


Stores


Stores2.0Only works with ModelData instancesCan have reference to Loaders


Stores2.0Only works with ModelData instancesCan have reference to Loaders

3.0Work with any object typeRequires ModelKeyProviderStores are not aware of LoadersLoaders bound to Stores via LoadListeners


LoadersRefactored generic usageBetter static code checking from IDEStores no longer use loaders directly


Loader Example

final ExampleServiceAsync service = GWT.create(ExampleService.class);

proxy = new RpcProxy<PagingLoadConfig, PagingLoadResult<Post>>() { @Override public void load(PagingLoadConfig loadConfig, AsyncCallback<PagingLoadResult<Post>> callback) { service.getPosts(loadConfig, callback); } };

ListStore<Post> store = new ListStore<Post>(props.id());

loader = new PagingLoader<PagingLoadConfig, PagingLoadResult<Post>>(proxy);loader.setRemoteSort(true);loader.addLoadHandler(new LoadResultListStoreBinding<PagingLoadConfig, Post, PagingLoadResult<Post>>(store));


DataProxiesHttpProxy & SciptTagProxy can generate Json & XmlBoth proxies use writers to serialize data or else toString


Readers

Easily map Json to propertiesEasily map Xml xpaths to bean propertiesModelType replaced with annotations

// 2.0 defines the JSON structure ModelType type = new ModelType(); type.setRoot("records"); type.addField("Sender", "name"); type.addField("Email", "email"); type.addField("Phone", "phone"); type.addField("State", "state"); type.addField("Zip", "zip");


public interface EmailAutoBeanFactory extends AutoBeanFactory { AutoBean<RecordResult> items(); AutoBean<ListLoadConfig> loadConfig(); }

public interface Email { String getName(); String getEmail(); String getPhone(); String getState(); String getZip(); }

public interface RecordResult { List<Email> getRecords(); }

3.0 Readers Pt. 1


class DataRecordJsonReader extends JsonReader<ListLoadResult<Email>, RecordResult> {

public DataRecordJsonReader(AutoBeanFactory factory, Class<RecordResult> rootBeanType) { super(factory, rootBeanType); }

protected ListLoadResult<Email> createReturnData(Object loadConfig, RecordResult incomingData) { return new BaseListLoadResult<Email>(incomingData.getRecords()); } } EmailAutoBeanFactory factory = GWT.create(EmailAutoBeanFactory.class); DataRecordJsonReader reader = new DataRecordJsonReader(factory, RecordResult.class);

3.0 Readers Pt. 2


Theming


Resource Changes


Resource Changes2.0Must include gxt-all.css and all images


Resource Changes2.0Must include gxt-all.css and all images

3.0Removed gxt-all.css and image resourcesOnly required to add link to reset.cssImplemented Appearance patternCSS & images now ClientBundle based


Appearance Example

// non framedContentPanel panel = new ContentPanel(); // framed using appearanceFramedPanelAppearance appearance = GWT.create(FramedPanelAppearance.class);ContentPanel framed = new ContentPanel(appearance); // convenience subclassFramedPanel framed2 = new FramedPanel();


Questions?


migrating from ext gwt 2.x to 3.0

Technology

new contentpanel panel

new framedpanel panel

new contentpanelpanel

setframetrue panel

settopcomponenttoolbar

contentpanelframedpanel

new listener

new verticallayoutdata1