12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253 |
- /*
- * Copyright 2000-2014 Vaadin Ltd.
- *
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License. You may obtain a copy of
- * the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- * License for the specific language governing permissions and limitations under
- * the License.
- */
-
- package com.vaadin.client.connectors;
-
- import java.util.ArrayList;
- import java.util.Arrays;
- import java.util.Collection;
- import java.util.HashMap;
- import java.util.HashSet;
- import java.util.Iterator;
- import java.util.LinkedHashSet;
- import java.util.List;
- import java.util.Map;
- import java.util.Map.Entry;
- import java.util.Set;
- import java.util.logging.Logger;
-
- import com.google.gwt.core.client.Scheduler;
- import com.google.gwt.core.client.Scheduler.ScheduledCommand;
- import com.google.gwt.dom.client.NativeEvent;
- import com.google.gwt.user.client.Timer;
- import com.google.gwt.user.client.ui.Widget;
- import com.vaadin.client.ComponentConnector;
- import com.vaadin.client.ConnectorHierarchyChangeEvent;
- import com.vaadin.client.DeferredWorker;
- import com.vaadin.client.MouseEventDetailsBuilder;
- import com.vaadin.client.ServerConnector;
- import com.vaadin.client.annotations.OnStateChange;
- import com.vaadin.client.communication.StateChangeEvent;
- import com.vaadin.client.connectors.RpcDataSourceConnector.DetailsListener;
- import com.vaadin.client.connectors.RpcDataSourceConnector.RpcDataSource;
- import com.vaadin.client.data.DataSource.RowHandle;
- import com.vaadin.client.renderers.Renderer;
- import com.vaadin.client.ui.AbstractFieldConnector;
- import com.vaadin.client.ui.AbstractHasComponentsConnector;
- import com.vaadin.client.ui.SimpleManagedLayout;
- import com.vaadin.client.widget.grid.CellReference;
- import com.vaadin.client.widget.grid.CellStyleGenerator;
- import com.vaadin.client.widget.grid.DetailsGenerator;
- import com.vaadin.client.widget.grid.EditorHandler;
- import com.vaadin.client.widget.grid.RowReference;
- import com.vaadin.client.widget.grid.RowStyleGenerator;
- import com.vaadin.client.widget.grid.events.BodyClickHandler;
- import com.vaadin.client.widget.grid.events.BodyDoubleClickHandler;
- import com.vaadin.client.widget.grid.events.ColumnReorderEvent;
- import com.vaadin.client.widget.grid.events.ColumnReorderHandler;
- import com.vaadin.client.widget.grid.events.ColumnVisibilityChangeEvent;
- import com.vaadin.client.widget.grid.events.ColumnVisibilityChangeHandler;
- import com.vaadin.client.widget.grid.events.GridClickEvent;
- import com.vaadin.client.widget.grid.events.GridDoubleClickEvent;
- import com.vaadin.client.widget.grid.events.SelectAllEvent;
- import com.vaadin.client.widget.grid.events.SelectAllHandler;
- import com.vaadin.client.widget.grid.selection.AbstractRowHandleSelectionModel;
- import com.vaadin.client.widget.grid.selection.SelectionEvent;
- import com.vaadin.client.widget.grid.selection.SelectionHandler;
- import com.vaadin.client.widget.grid.selection.SelectionModel;
- import com.vaadin.client.widget.grid.selection.SelectionModelMulti;
- import com.vaadin.client.widget.grid.selection.SelectionModelNone;
- import com.vaadin.client.widget.grid.selection.SelectionModelSingle;
- import com.vaadin.client.widget.grid.sort.SortEvent;
- import com.vaadin.client.widget.grid.sort.SortHandler;
- import com.vaadin.client.widget.grid.sort.SortOrder;
- import com.vaadin.client.widgets.Grid;
- import com.vaadin.client.widgets.Grid.Column;
- import com.vaadin.client.widgets.Grid.FooterCell;
- import com.vaadin.client.widgets.Grid.FooterRow;
- import com.vaadin.client.widgets.Grid.HeaderCell;
- import com.vaadin.client.widgets.Grid.HeaderRow;
- import com.vaadin.shared.data.sort.SortDirection;
- import com.vaadin.shared.ui.Connect;
- import com.vaadin.shared.ui.grid.EditorClientRpc;
- import com.vaadin.shared.ui.grid.EditorServerRpc;
- import com.vaadin.shared.ui.grid.GridClientRpc;
- import com.vaadin.shared.ui.grid.GridColumnState;
- import com.vaadin.shared.ui.grid.GridConstants;
- import com.vaadin.shared.ui.grid.GridServerRpc;
- import com.vaadin.shared.ui.grid.GridState;
- import com.vaadin.shared.ui.grid.GridState.SharedSelectionMode;
- import com.vaadin.shared.ui.grid.GridStaticSectionState;
- import com.vaadin.shared.ui.grid.GridStaticSectionState.CellState;
- import com.vaadin.shared.ui.grid.GridStaticSectionState.RowState;
- import com.vaadin.shared.ui.grid.ScrollDestination;
-
- import elemental.json.JsonObject;
- import elemental.json.JsonValue;
-
- /**
- * Connects the client side {@link Grid} widget with the server side
- * {@link com.vaadin.ui.components.grid.Grid} component.
- * <p>
- * The Grid is typed to JSONObject. The structure of the JSONObject is described
- * at {@link com.vaadin.shared.data.DataProviderRpc#setRowData(int, List)
- * DataProviderRpc.setRowData(int, List)}.
- *
- * @since 7.4
- * @author Vaadin Ltd
- */
- @Connect(com.vaadin.ui.Grid.class)
- public class GridConnector extends AbstractHasComponentsConnector implements
- SimpleManagedLayout, DeferredWorker {
-
- private static final class CustomCellStyleGenerator implements
- CellStyleGenerator<JsonObject> {
- @Override
- public String getStyle(CellReference<JsonObject> cellReference) {
- JsonObject row = cellReference.getRow();
- if (!row.hasKey(GridState.JSONKEY_CELLSTYLES)) {
- return null;
- }
-
- Column<?, JsonObject> column = cellReference.getColumn();
- if (!(column instanceof CustomGridColumn)) {
- // Selection checkbox column
- return null;
- }
- CustomGridColumn c = (CustomGridColumn) column;
-
- JsonObject cellStylesObject = row
- .getObject(GridState.JSONKEY_CELLSTYLES);
- assert cellStylesObject != null;
-
- if (cellStylesObject.hasKey(c.id)) {
- return cellStylesObject.getString(c.id);
- } else {
- return null;
- }
- }
-
- }
-
- private static final class CustomRowStyleGenerator implements
- RowStyleGenerator<JsonObject> {
- @Override
- public String getStyle(RowReference<JsonObject> rowReference) {
- JsonObject row = rowReference.getRow();
- if (row.hasKey(GridState.JSONKEY_ROWSTYLE)) {
- return row.getString(GridState.JSONKEY_ROWSTYLE);
- } else {
- return null;
- }
- }
-
- }
-
- /**
- * Custom implementation of the custom grid column using a JSONObject to
- * represent the cell value and String as a column type.
- */
- private class CustomGridColumn extends Grid.Column<Object, JsonObject> {
-
- private final String id;
-
- private AbstractRendererConnector<Object> rendererConnector;
-
- private AbstractFieldConnector editorConnector;
-
- public CustomGridColumn(String id,
- AbstractRendererConnector<Object> rendererConnector) {
- super(rendererConnector.getRenderer());
- this.rendererConnector = rendererConnector;
- this.id = id;
- }
-
- /**
- * Sets a new renderer for this column object
- *
- * @param rendererConnector
- * a renderer connector object
- */
- public void setRenderer(
- AbstractRendererConnector<Object> rendererConnector) {
- setRenderer(rendererConnector.getRenderer());
- this.rendererConnector = rendererConnector;
- }
-
- @Override
- public Object getValue(final JsonObject obj) {
- final JsonObject rowData = obj.getObject(GridState.JSONKEY_DATA);
-
- if (rowData.hasKey(id)) {
- final JsonValue columnValue = rowData.get(id);
-
- return rendererConnector.decode(columnValue);
- }
-
- return null;
- }
-
- private AbstractFieldConnector getEditorConnector() {
- return editorConnector;
- }
-
- private void setEditorConnector(AbstractFieldConnector editorConnector) {
- this.editorConnector = editorConnector;
- }
- }
-
- /*
- * An editor handler using Vaadin RPC to manage the editor state.
- */
- private class CustomEditorHandler implements EditorHandler<JsonObject> {
-
- private EditorServerRpc rpc = getRpcProxy(EditorServerRpc.class);
-
- private EditorRequest<JsonObject> currentRequest = null;
- private boolean serverInitiated = false;
-
- public CustomEditorHandler() {
- registerRpc(EditorClientRpc.class, new EditorClientRpc() {
-
- @Override
- public void bind(final int rowIndex) {
- // call this finally to avoid issues with editing on init
- Scheduler.get().scheduleFinally(new ScheduledCommand() {
- @Override
- public void execute() {
- GridConnector.this.getWidget().editRow(rowIndex);
- }
- });
- }
-
- @Override
- public void cancel(int rowIndex) {
- serverInitiated = true;
- GridConnector.this.getWidget().cancelEditor();
- }
-
- @Override
- public void confirmBind(final boolean bindSucceeded) {
- endRequest(bindSucceeded, null, null);
- }
-
- @Override
- public void confirmSave(boolean saveSucceeded,
- String errorMessage, List<String> errorColumnsIds) {
- endRequest(saveSucceeded, errorMessage, errorColumnsIds);
- }
- });
- }
-
- @Override
- public void bind(EditorRequest<JsonObject> request) {
- startRequest(request);
- rpc.bind(request.getRowIndex());
- }
-
- @Override
- public void save(EditorRequest<JsonObject> request) {
- startRequest(request);
- rpc.save(request.getRowIndex());
- }
-
- @Override
- public void cancel(EditorRequest<JsonObject> request) {
- if (!handleServerInitiated(request)) {
- // No startRequest as we don't get (or need)
- // a confirmation from the server
- rpc.cancel(request.getRowIndex());
- }
- }
-
- @Override
- public Widget getWidget(Grid.Column<?, JsonObject> column) {
- assert column != null;
-
- if (column instanceof CustomGridColumn) {
- AbstractFieldConnector c = ((CustomGridColumn) column)
- .getEditorConnector();
- return c != null ? c.getWidget() : null;
- } else {
- throw new IllegalStateException("Unexpected column type: "
- + column.getClass().getName());
- }
- }
-
- /**
- * Used to handle the case where the editor calls us because it was
- * invoked by the server via RPC and not by the client. In that case,
- * the request can be simply synchronously completed.
- *
- * @param request
- * the request object
- * @return true if the request was originally triggered by the server,
- * false otherwise
- */
- private boolean handleServerInitiated(EditorRequest<?> request) {
- assert request != null : "Cannot handle null request";
- assert currentRequest == null : "Earlier request not yet finished";
-
- if (serverInitiated) {
- serverInitiated = false;
- request.success();
- return true;
- } else {
- return false;
- }
- }
-
- private void startRequest(EditorRequest<JsonObject> request) {
- assert currentRequest == null : "Earlier request not yet finished";
-
- currentRequest = request;
- }
-
- private void endRequest(boolean succeeded, String errorMessage,
- List<String> errorColumnsIds) {
- assert currentRequest != null : "Current request was null";
- /*
- * Clear current request first to ensure the state is valid if
- * another request is made in the callback.
- */
- EditorRequest<JsonObject> request = currentRequest;
- currentRequest = null;
- if (succeeded) {
- request.success();
- } else {
- Collection<Column<?, JsonObject>> errorColumns;
- if (errorColumnsIds != null) {
- errorColumns = new ArrayList<Grid.Column<?, JsonObject>>();
- for (String colId : errorColumnsIds) {
- errorColumns.add(columnIdToColumn.get(colId));
- }
- } else {
- errorColumns = null;
- }
-
- request.failure(errorMessage, errorColumns);
- }
- }
- }
-
- private class ItemClickHandler implements BodyClickHandler,
- BodyDoubleClickHandler {
-
- @Override
- public void onClick(GridClickEvent event) {
- if (hasEventListener(GridConstants.ITEM_CLICK_EVENT_ID)) {
- fireItemClick(event.getTargetCell(), event.getNativeEvent());
- }
- }
-
- @Override
- public void onDoubleClick(GridDoubleClickEvent event) {
- if (hasEventListener(GridConstants.ITEM_CLICK_EVENT_ID)) {
- fireItemClick(event.getTargetCell(), event.getNativeEvent());
- }
- }
-
- private void fireItemClick(CellReference<?> cell, NativeEvent mouseEvent) {
- String rowKey = getRowKey((JsonObject) cell.getRow());
- String columnId = getColumnId(cell.getColumn());
- getRpcProxy(GridServerRpc.class)
- .itemClick(
- rowKey,
- columnId,
- MouseEventDetailsBuilder
- .buildMouseEventDetails(mouseEvent));
- }
- }
-
- private ColumnReorderHandler<JsonObject> columnReorderHandler = new ColumnReorderHandler<JsonObject>() {
-
- @Override
- public void onColumnReorder(ColumnReorderEvent<JsonObject> event) {
- if (!columnsUpdatedFromState) {
- List<Column<?, JsonObject>> columns = getWidget().getColumns();
- final List<String> newColumnOrder = new ArrayList<String>();
- for (Column<?, JsonObject> column : columns) {
- if (column instanceof CustomGridColumn) {
- newColumnOrder.add(((CustomGridColumn) column).id);
- } // the other case would be the multi selection column
- }
- getRpcProxy(GridServerRpc.class).columnsReordered(
- newColumnOrder, columnOrder);
- columnOrder = newColumnOrder;
- getState().columnOrder = newColumnOrder;
- }
- }
- };
-
- private ColumnVisibilityChangeHandler<JsonObject> columnVisibilityChangeHandler = new ColumnVisibilityChangeHandler<JsonObject>() {
-
- @Override
- public void onVisibilityChange(
- ColumnVisibilityChangeEvent<JsonObject> event) {
- if (!columnsUpdatedFromState) {
- Column<?, JsonObject> column = event.getColumn();
- if (column instanceof CustomGridColumn) {
- getRpcProxy(GridServerRpc.class).columnVisibilityChanged(
- ((CustomGridColumn) column).id, column.isHidden(),
- event.isUserOriginated());
- for (GridColumnState state : getState().columns) {
- if (state.id.equals(((CustomGridColumn) column).id)) {
- state.hidden = event.isHidden();
- break;
- }
- }
- } else {
- getLogger().warning(
- "Visibility changed for a unknown column type in Grid: "
- + column.toString() + ", type "
- + column.getClass());
- }
- }
- }
- };
-
- private class CustomDetailsGenerator implements DetailsGenerator {
-
- private final Map<String, ComponentConnector> idToDetailsMap = new HashMap<String, ComponentConnector>();
- private final Map<String, Integer> idToRowIndex = new HashMap<String, Integer>();
-
- @Override
- public Widget getDetails(int rowIndex) {
- JsonObject row = getWidget().getDataSource().getRow(rowIndex);
-
- if (!row.hasKey(GridState.JSONKEY_DETAILS_VISIBLE)
- || row.getString(GridState.JSONKEY_DETAILS_VISIBLE)
- .isEmpty()) {
- return null;
- }
-
- String id = row.getString(GridState.JSONKEY_DETAILS_VISIBLE);
- ComponentConnector componentConnector = idToDetailsMap.get(id);
- idToRowIndex.put(id, rowIndex);
-
- return componentConnector.getWidget();
- }
-
- public void updateConnectorHierarchy(List<ServerConnector> children) {
- Set<String> connectorIds = new HashSet<String>();
- for (ServerConnector child : children) {
- if (child instanceof ComponentConnector) {
- connectorIds.add(child.getConnectorId());
- idToDetailsMap.put(child.getConnectorId(),
- (ComponentConnector) child);
- }
- }
-
- Set<String> removedDetails = new HashSet<String>();
- for (Entry<String, ComponentConnector> entry : idToDetailsMap
- .entrySet()) {
- ComponentConnector connector = entry.getValue();
- String id = connector.getConnectorId();
- if (!connectorIds.contains(id)) {
- removedDetails.add(entry.getKey());
- if (idToRowIndex.containsKey(id)) {
- getWidget().setDetailsVisible(idToRowIndex.get(id),
- false);
- }
- }
- }
-
- for (String id : removedDetails) {
- idToDetailsMap.remove(id);
- idToRowIndex.remove(id);
- }
- }
- }
-
- /**
- * Class for handling scrolling issues with open details.
- *
- * @since 7.5.2
- */
- private class LazyDetailsScroller implements DeferredWorker {
-
- /* Timer value tested to work in our test cluster with slow IE8s. */
- private static final int DISABLE_LAZY_SCROLL_TIMEOUT = 1500;
-
- /*
- * Cancels details opening scroll after timeout. Avoids any unexpected
- * scrolls via details opening.
- */
- private Timer disableScroller = new Timer() {
- @Override
- public void run() {
- targetRow = -1;
- }
- };
-
- private Integer targetRow = -1;
- private ScrollDestination destination = null;
-
- public void scrollToRow(Integer row, ScrollDestination dest) {
- targetRow = row;
- destination = dest;
- disableScroller.schedule(DISABLE_LAZY_SCROLL_TIMEOUT);
- }
-
- /**
- * Inform LazyDetailsScroller that a details row has opened on a row.
- *
- * @param rowIndex
- * index of row with details now open
- */
- public void detailsOpened(int rowIndex) {
- if (targetRow == rowIndex) {
- getWidget().scrollToRow(targetRow, destination);
- disableScroller.run();
- }
- }
-
- @Override
- public boolean isWorkPending() {
- return disableScroller.isRunning();
- }
- }
-
- /**
- * Maps a generated column id to a grid column instance
- */
- private Map<String, CustomGridColumn> columnIdToColumn = new HashMap<String, CustomGridColumn>();
-
- private AbstractRowHandleSelectionModel<JsonObject> selectionModel;
- private Set<String> selectedKeys = new LinkedHashSet<String>();
- private List<String> columnOrder = new ArrayList<String>();
-
- /**
- * {@link #selectionUpdatedFromState} is set to true when
- * {@link #updateSelectionFromState()} makes changes to selection. This flag
- * tells the {@code internalSelectionChangeHandler} to not send same data
- * straight back to server. Said listener sets it back to false when
- * handling that event.
- */
- private boolean selectionUpdatedFromState;
-
- /**
- * {@link #columnsUpdatedFromState} is set to true when
- * {@link #updateColumnOrderFromState(List)} is updating the column order
- * for the widget. This flag tells the {@link #columnReorderHandler} to not
- * send same data straight back to server. After updates, listener sets the
- * value back to false.
- */
- private boolean columnsUpdatedFromState;
-
- private RpcDataSource dataSource;
-
- private SelectionHandler<JsonObject> internalSelectionChangeHandler = new SelectionHandler<JsonObject>() {
- @Override
- public void onSelect(SelectionEvent<JsonObject> event) {
- if (event.isBatchedSelection()) {
- return;
- }
- if (!selectionUpdatedFromState) {
- for (JsonObject row : event.getRemoved()) {
- selectedKeys.remove(dataSource.getRowKey(row));
- }
-
- for (JsonObject row : event.getAdded()) {
- selectedKeys.add(dataSource.getRowKey(row));
- }
-
- getRpcProxy(GridServerRpc.class).select(
- new ArrayList<String>(selectedKeys));
- } else {
- selectionUpdatedFromState = false;
- }
- }
- };
-
- private ItemClickHandler itemClickHandler = new ItemClickHandler();
-
- private String lastKnownTheme = null;
-
- private final CustomDetailsGenerator customDetailsGenerator = new CustomDetailsGenerator();
-
- private final DetailsListener detailsListener = new DetailsListener() {
- @Override
- public void reapplyDetailsVisibility(final int rowIndex,
- final JsonObject row) {
-
- if (hasDetailsOpen(row)) {
- // Command for opening details row.
- ScheduledCommand openDetails = new ScheduledCommand() {
- @Override
- public void execute() {
- // Re-apply to force redraw.
- getWidget().setDetailsVisible(rowIndex, false);
- getWidget().setDetailsVisible(rowIndex, true);
- lazyDetailsScroller.detailsOpened(rowIndex);
- }
- };
-
- if (initialChange) {
- Scheduler.get().scheduleDeferred(openDetails);
- } else {
- Scheduler.get().scheduleFinally(openDetails);
- }
- } else {
- getWidget().setDetailsVisible(rowIndex, false);
- }
- }
-
- private boolean hasDetailsOpen(JsonObject row) {
- return row.hasKey(GridState.JSONKEY_DETAILS_VISIBLE)
- && row.getString(GridState.JSONKEY_DETAILS_VISIBLE) != null;
- }
- };
-
- private final LazyDetailsScroller lazyDetailsScroller = new LazyDetailsScroller();
-
- /*
- * Initially details need to behave a bit differently to allow some
- * escalator magic.
- */
- private boolean initialChange;
-
- @Override
- @SuppressWarnings("unchecked")
- public Grid<JsonObject> getWidget() {
- return (Grid<JsonObject>) super.getWidget();
- }
-
- @Override
- public GridState getState() {
- return (GridState) super.getState();
- }
-
- @Override
- protected void init() {
- super.init();
-
- // All scroll RPC calls are executed finally to avoid issues on init
- registerRpc(GridClientRpc.class, new GridClientRpc() {
- @Override
- public void scrollToStart() {
- /*
- * no need for lazyDetailsScrollAdjuster, because the start is
- * always 0, won't change a bit.
- */
- Scheduler.get().scheduleFinally(new ScheduledCommand() {
- @Override
- public void execute() {
- getWidget().scrollToStart();
- }
- });
- }
-
- @Override
- public void scrollToEnd() {
- Scheduler.get().scheduleFinally(new ScheduledCommand() {
- @Override
- public void execute() {
- getWidget().scrollToEnd();
- // Scrolls further if details opens.
- lazyDetailsScroller.scrollToRow(dataSource.size() - 1,
- ScrollDestination.END);
- }
- });
- }
-
- @Override
- public void scrollToRow(final int row,
- final ScrollDestination destination) {
- Scheduler.get().scheduleFinally(new ScheduledCommand() {
- @Override
- public void execute() {
- getWidget().scrollToRow(row, destination);
- // Scrolls a bit further if details opens.
- lazyDetailsScroller.scrollToRow(row, destination);
- }
- });
- }
-
- @Override
- public void recalculateColumnWidths() {
- getWidget().recalculateColumnWidths();
- }
- });
-
- getWidget().addSelectionHandler(internalSelectionChangeHandler);
-
- /* Item click events */
- getWidget().addBodyClickHandler(itemClickHandler);
- getWidget().addBodyDoubleClickHandler(itemClickHandler);
-
- getWidget().addSortHandler(new SortHandler<JsonObject>() {
- @Override
- public void sort(SortEvent<JsonObject> event) {
- List<SortOrder> order = event.getOrder();
- String[] columnIds = new String[order.size()];
- SortDirection[] directions = new SortDirection[order.size()];
- for (int i = 0; i < order.size(); i++) {
- SortOrder sortOrder = order.get(i);
- CustomGridColumn column = (CustomGridColumn) sortOrder
- .getColumn();
- columnIds[i] = column.id;
-
- directions[i] = sortOrder.getDirection();
- }
-
- if (!Arrays.equals(columnIds, getState().sortColumns)
- || !Arrays.equals(directions, getState().sortDirs)) {
- // Report back to server if changed
- getRpcProxy(GridServerRpc.class).sort(columnIds,
- directions, event.isUserOriginated());
- }
- }
- });
-
- getWidget().addSelectAllHandler(new SelectAllHandler<JsonObject>() {
-
- @Override
- public void onSelectAll(SelectAllEvent<JsonObject> event) {
- getRpcProxy(GridServerRpc.class).selectAll();
- }
-
- });
-
- getWidget().setEditorHandler(new CustomEditorHandler());
- getWidget().addColumnReorderHandler(columnReorderHandler);
- getWidget().addColumnVisibilityChangeHandler(
- columnVisibilityChangeHandler);
- getWidget().setDetailsGenerator(customDetailsGenerator);
- getLayoutManager().registerDependency(this, getWidget().getElement());
-
- layout();
- }
-
- @Override
- public void onStateChanged(final StateChangeEvent stateChangeEvent) {
- super.onStateChanged(stateChangeEvent);
-
- initialChange = stateChangeEvent.isInitialStateChange();
-
- // Column updates
- if (stateChangeEvent.hasPropertyChanged("columns")) {
-
- // Remove old columns
- purgeRemovedColumns();
-
- // Add new columns
- for (GridColumnState state : getState().columns) {
- if (!columnIdToColumn.containsKey(state.id)) {
- addColumnFromStateChangeEvent(state);
- }
- updateColumnFromStateChangeEvent(state);
- }
- }
-
- if (stateChangeEvent.hasPropertyChanged("columnOrder")) {
- if (orderNeedsUpdate(getState().columnOrder)) {
- updateColumnOrderFromState(getState().columnOrder);
- }
- }
-
- // Header and footer
- if (stateChangeEvent.hasPropertyChanged("header")) {
- updateHeaderFromState(getState().header);
- }
-
- if (stateChangeEvent.hasPropertyChanged("footer")) {
- updateFooterFromState(getState().footer);
- }
-
- // Selection
- if (stateChangeEvent.hasPropertyChanged("selectionMode")) {
- onSelectionModeChange();
- updateSelectDeselectAllowed();
- } else if (stateChangeEvent
- .hasPropertyChanged("singleSelectDeselectAllowed")) {
- updateSelectDeselectAllowed();
- }
-
- if (stateChangeEvent.hasPropertyChanged("selectedKeys")) {
- updateSelectionFromState();
- }
-
- // Sorting
- if (stateChangeEvent.hasPropertyChanged("sortColumns")
- || stateChangeEvent.hasPropertyChanged("sortDirs")) {
- onSortStateChange();
- }
-
- // Editor
- if (stateChangeEvent.hasPropertyChanged("editorEnabled")) {
- getWidget().setEditorEnabled(getState().editorEnabled);
- }
-
- // Frozen columns
- if (stateChangeEvent.hasPropertyChanged("frozenColumnCount")) {
- getWidget().setFrozenColumnCount(getState().frozenColumnCount);
- }
-
- // Theme features
- String activeTheme = getConnection().getUIConnector().getActiveTheme();
- if (lastKnownTheme == null) {
- lastKnownTheme = activeTheme;
- } else if (!lastKnownTheme.equals(activeTheme)) {
- getWidget().resetSizesFromDom();
- lastKnownTheme = activeTheme;
- }
- }
-
- private void updateSelectDeselectAllowed() {
- SelectionModel<JsonObject> model = getWidget().getSelectionModel();
- if (model instanceof SelectionModel.Single<?>) {
- ((SelectionModel.Single<?>) model)
- .setDeselectAllowed(getState().singleSelectDeselectAllowed);
- }
- }
-
- private void updateColumnOrderFromState(List<String> stateColumnOrder) {
- CustomGridColumn[] columns = new CustomGridColumn[stateColumnOrder
- .size()];
- int i = 0;
- for (String id : stateColumnOrder) {
- columns[i] = columnIdToColumn.get(id);
- i++;
- }
- columnsUpdatedFromState = true;
- getWidget().setColumnOrder(columns);
- columnsUpdatedFromState = false;
- columnOrder = stateColumnOrder;
- }
-
- private boolean orderNeedsUpdate(List<String> stateColumnOrder) {
- if (stateColumnOrder.size() == columnOrder.size()) {
- for (int i = 0; i < columnOrder.size(); ++i) {
- if (!stateColumnOrder.get(i).equals(columnOrder.get(i))) {
- return true;
- }
- }
- return false;
- }
- return true;
- }
-
- private void updateHeaderFromState(GridStaticSectionState state) {
- getWidget().setHeaderVisible(state.visible);
-
- while (getWidget().getHeaderRowCount() > 0) {
- getWidget().removeHeaderRow(0);
- }
-
- for (RowState rowState : state.rows) {
- HeaderRow row = getWidget().appendHeaderRow();
-
- if (rowState.defaultRow) {
- getWidget().setDefaultHeaderRow(row);
- }
-
- for (CellState cellState : rowState.cells) {
- CustomGridColumn column = columnIdToColumn
- .get(cellState.columnId);
- updateHeaderCellFromState(row.getCell(column), cellState);
- }
-
- for (Set<String> group : rowState.cellGroups.keySet()) {
- Grid.Column<?, ?>[] columns = new Grid.Column<?, ?>[group
- .size()];
- CellState cellState = rowState.cellGroups.get(group);
-
- int i = 0;
- for (String columnId : group) {
- columns[i] = columnIdToColumn.get(columnId);
- i++;
- }
-
- // Set state to be the same as first in group.
- updateHeaderCellFromState(row.join(columns), cellState);
- }
-
- row.setStyleName(rowState.styleName);
- }
- }
-
- private void updateHeaderCellFromState(HeaderCell cell, CellState cellState) {
- switch (cellState.type) {
- case TEXT:
- cell.setText(cellState.text);
- break;
- case HTML:
- cell.setHtml(cellState.html);
- break;
- case WIDGET:
- ComponentConnector connector = (ComponentConnector) cellState.connector;
- cell.setWidget(connector.getWidget());
- break;
- default:
- throw new IllegalStateException("unexpected cell type: "
- + cellState.type);
- }
- cell.setStyleName(cellState.styleName);
- }
-
- private void updateFooterFromState(GridStaticSectionState state) {
- getWidget().setFooterVisible(state.visible);
-
- while (getWidget().getFooterRowCount() > 0) {
- getWidget().removeFooterRow(0);
- }
-
- for (RowState rowState : state.rows) {
- FooterRow row = getWidget().appendFooterRow();
-
- for (CellState cellState : rowState.cells) {
- CustomGridColumn column = columnIdToColumn
- .get(cellState.columnId);
- updateFooterCellFromState(row.getCell(column), cellState);
- }
-
- for (Set<String> group : rowState.cellGroups.keySet()) {
- Grid.Column<?, ?>[] columns = new Grid.Column<?, ?>[group
- .size()];
- CellState cellState = rowState.cellGroups.get(group);
-
- int i = 0;
- for (String columnId : group) {
- columns[i] = columnIdToColumn.get(columnId);
- i++;
- }
-
- // Set state to be the same as first in group.
- updateFooterCellFromState(row.join(columns), cellState);
- }
-
- row.setStyleName(rowState.styleName);
- }
- }
-
- private void updateFooterCellFromState(FooterCell cell, CellState cellState) {
- switch (cellState.type) {
- case TEXT:
- cell.setText(cellState.text);
- break;
- case HTML:
- cell.setHtml(cellState.html);
- break;
- case WIDGET:
- ComponentConnector connector = (ComponentConnector) cellState.connector;
- cell.setWidget(connector.getWidget());
- break;
- default:
- throw new IllegalStateException("unexpected cell type: "
- + cellState.type);
- }
- cell.setStyleName(cellState.styleName);
- }
-
- /**
- * Updates a column from a state change event.
- *
- * @param columnIndex
- * The index of the column to update
- */
- private void updateColumnFromStateChangeEvent(GridColumnState columnState) {
- CustomGridColumn column = columnIdToColumn.get(columnState.id);
-
- columnsUpdatedFromState = true;
- updateColumnFromState(column, columnState);
- columnsUpdatedFromState = false;
- }
-
- /**
- * Adds a new column to the grid widget from a state change event
- *
- * @param columnIndex
- * The index of the column, according to how it
- */
- private void addColumnFromStateChangeEvent(GridColumnState state) {
- @SuppressWarnings("unchecked")
- CustomGridColumn column = new CustomGridColumn(state.id,
- ((AbstractRendererConnector<Object>) state.rendererConnector));
- columnIdToColumn.put(state.id, column);
-
- /*
- * Add column to grid. Reordering is handled as a separate problem.
- */
- getWidget().addColumn(column);
- columnOrder.add(state.id);
- }
-
- /**
- * If we have a selection column renderer, we need to offset the index by
- * one when referring to the column index in the widget.
- */
- private int getWidgetColumnIndex(final int columnIndex) {
- Renderer<Boolean> selectionColumnRenderer = getWidget()
- .getSelectionModel().getSelectionColumnRenderer();
- int widgetColumnIndex = columnIndex;
- if (selectionColumnRenderer != null) {
- widgetColumnIndex++;
- }
- return widgetColumnIndex;
- }
-
- /**
- * Updates the column values from a state
- *
- * @param column
- * The column to update
- * @param state
- * The state to get the data from
- */
- @SuppressWarnings("unchecked")
- private static void updateColumnFromState(CustomGridColumn column,
- GridColumnState state) {
- column.setWidth(state.width);
- column.setMinimumWidth(state.minWidth);
- column.setMaximumWidth(state.maxWidth);
- column.setExpandRatio(state.expandRatio);
-
- assert state.rendererConnector instanceof AbstractRendererConnector : "GridColumnState.rendererConnector is invalid (not subclass of AbstractRendererConnector)";
- column.setRenderer((AbstractRendererConnector<Object>) state.rendererConnector);
-
- column.setSortable(state.sortable);
-
- column.setHeaderCaption(state.headerCaption);
-
- column.setHidden(state.hidden);
- column.setHidable(state.hidable);
- column.setHidingToggleCaption(state.hidingToggleCaption);
-
- column.setEditable(state.editable);
- column.setEditorConnector((AbstractFieldConnector) state.editorConnector);
- }
-
- /**
- * Removes any orphan columns that has been removed from the state from the
- * grid
- */
- private void purgeRemovedColumns() {
-
- // Get columns still registered in the state
- Set<String> columnsInState = new HashSet<String>();
- for (GridColumnState columnState : getState().columns) {
- columnsInState.add(columnState.id);
- }
-
- // Remove column no longer in state
- Iterator<String> columnIdIterator = columnIdToColumn.keySet()
- .iterator();
- while (columnIdIterator.hasNext()) {
- String id = columnIdIterator.next();
- if (!columnsInState.contains(id)) {
- CustomGridColumn column = columnIdToColumn.get(id);
- columnIdIterator.remove();
- getWidget().removeColumn(column);
- columnOrder.remove(id);
- }
- }
- }
-
- public void setDataSource(RpcDataSource dataSource) {
- this.dataSource = dataSource;
- getWidget().setDataSource(this.dataSource);
- }
-
- private void onSelectionModeChange() {
- SharedSelectionMode mode = getState().selectionMode;
- if (mode == null) {
- getLogger().fine("ignored mode change");
- return;
- }
-
- AbstractRowHandleSelectionModel<JsonObject> model = createSelectionModel(mode);
- if (selectionModel == null
- || !model.getClass().equals(selectionModel.getClass())) {
- selectionModel = model;
- getWidget().setSelectionModel(model);
- selectedKeys.clear();
- }
- }
-
- @OnStateChange("hasCellStyleGenerator")
- private void onCellStyleGeneratorChange() {
- if (getState().hasCellStyleGenerator) {
- getWidget().setCellStyleGenerator(new CustomCellStyleGenerator());
- } else {
- getWidget().setCellStyleGenerator(null);
- }
- }
-
- @OnStateChange("hasRowStyleGenerator")
- private void onRowStyleGeneratorChange() {
- if (getState().hasRowStyleGenerator) {
- getWidget().setRowStyleGenerator(new CustomRowStyleGenerator());
- } else {
- getWidget().setRowStyleGenerator(null);
- }
- }
-
- private void updateSelectionFromState() {
- boolean changed = false;
-
- List<String> stateKeys = getState().selectedKeys;
-
- // find new deselections
- for (String key : selectedKeys) {
- if (!stateKeys.contains(key)) {
- changed = true;
- deselectByHandle(dataSource.getHandleByKey(key));
- }
- }
-
- // find new selections
- for (String key : stateKeys) {
- if (!selectedKeys.contains(key)) {
- changed = true;
- selectByHandle(dataSource.getHandleByKey(key));
- }
- }
-
- /*
- * A defensive copy in case the collection in the state is mutated
- * instead of re-assigned.
- */
- selectedKeys = new LinkedHashSet<String>(stateKeys);
-
- /*
- * We need to fire this event so that Grid is able to re-render the
- * selection changes (if applicable).
- */
- if (changed) {
- // At least for now there's no way to send the selected and/or
- // deselected row data. Some data is only stored as keys
- selectionUpdatedFromState = true;
- getWidget().fireEvent(
- new SelectionEvent<JsonObject>(getWidget(),
- (List<JsonObject>) null, null, false));
- }
- }
-
- private void onSortStateChange() {
- List<SortOrder> sortOrder = new ArrayList<SortOrder>();
-
- String[] sortColumns = getState().sortColumns;
- SortDirection[] sortDirs = getState().sortDirs;
-
- for (int i = 0; i < sortColumns.length; i++) {
- sortOrder.add(new SortOrder(columnIdToColumn.get(sortColumns[i]),
- sortDirs[i]));
- }
-
- getWidget().setSortOrder(sortOrder);
- }
-
- private Logger getLogger() {
- return Logger.getLogger(getClass().getName());
- }
-
- @SuppressWarnings("static-method")
- private AbstractRowHandleSelectionModel<JsonObject> createSelectionModel(
- SharedSelectionMode mode) {
- switch (mode) {
- case SINGLE:
- return new SelectionModelSingle<JsonObject>();
- case MULTI:
- return new SelectionModelMulti<JsonObject>();
- case NONE:
- return new SelectionModelNone<JsonObject>();
- default:
- throw new IllegalStateException("unexpected mode value: " + mode);
- }
- }
-
- /**
- * A workaround method for accessing the protected method
- * {@code AbstractRowHandleSelectionModel.selectByHandle}
- */
- private native void selectByHandle(RowHandle<JsonObject> handle)
- /*-{
- var model = this.@com.vaadin.client.connectors.GridConnector::selectionModel;
- model.@com.vaadin.client.widget.grid.selection.AbstractRowHandleSelectionModel::selectByHandle(*)(handle);
- }-*/;
-
- /**
- * A workaround method for accessing the protected method
- * {@code AbstractRowHandleSelectionModel.deselectByHandle}
- */
- private native void deselectByHandle(RowHandle<JsonObject> handle)
- /*-{
- var model = this.@com.vaadin.client.connectors.GridConnector::selectionModel;
- model.@com.vaadin.client.widget.grid.selection.AbstractRowHandleSelectionModel::deselectByHandle(*)(handle);
- }-*/;
-
- /**
- * Gets the row key for a row object.
- *
- * @param row
- * the row object
- * @return the key for the given row
- */
- public String getRowKey(JsonObject row) {
- final Object key = dataSource.getRowKey(row);
- assert key instanceof String : "Internal key was not a String but a "
- + key.getClass().getSimpleName() + " (" + key + ")";
- return (String) key;
- }
-
- /*
- * (non-Javadoc)
- *
- * @see
- * com.vaadin.client.HasComponentsConnector#updateCaption(com.vaadin.client
- * .ComponentConnector)
- */
- @Override
- public void updateCaption(ComponentConnector connector) {
- // TODO Auto-generated method stub
-
- }
-
- @Override
- public void onConnectorHierarchyChange(
- ConnectorHierarchyChangeEvent connectorHierarchyChangeEvent) {
- customDetailsGenerator.updateConnectorHierarchy(getChildren());
- }
-
- public String getColumnId(Grid.Column<?, ?> column) {
- if (column instanceof CustomGridColumn) {
- return ((CustomGridColumn) column).id;
- }
- return null;
- }
-
- @Override
- public void layout() {
- getWidget().onResize();
- }
-
- @Override
- public boolean isWorkPending() {
- return lazyDetailsScroller.isWorkPending();
- }
-
- /**
- * Gets the listener used by this connector for tracking when row detail
- * visibility changes.
- *
- * @since 7.5.0
- * @return the used details listener
- */
- public DetailsListener getDetailsListener() {
- return detailsListener;
- }
- }
|