bundles/org.eclipse.rap.rwt.visualization.google/src/org/eclipse/rap/rwt/visualization/google/internal/VisualizationWidgetLCA.java

/*******************************************************************************
 * Copyright (c) 2009-2010 David Donahue and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     David Donahue - initial API, implementation and documentation
 *     Austin Riddle - improvements to widget hierarchy and data flow for 
 *                     consistency with SWT behavior.
 ******************************************************************************/
package org.eclipse.rap.rwt.visualization.google.internal;

import java.io.IOException;

import org.eclipse.rap.rwt.internal.protocol.ClientObjectFactory;
import org.eclipse.rap.rwt.internal.protocol.IClientObject;
import org.eclipse.rap.rwt.lifecycle.AbstractWidgetLCA;
import org.eclipse.rap.rwt.lifecycle.ControlLCAUtil;
import org.eclipse.rap.rwt.lifecycle.IWidgetAdapter;
import org.eclipse.rap.rwt.lifecycle.WidgetLCAUtil;
import org.eclipse.rap.rwt.lifecycle.WidgetUtil;
import org.eclipse.rap.rwt.visualization.google.VisualizationWidget;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Widget;

/**
 * <p>
 * Base type for Google Visualizations.
 * </p>
 * 
 * <p>
 * Note that changes to the data or options of a widget obtained via <code>getWidgetData()</code> 
 * and <code>getWidgetOptions()</code> will be propagated to the client side, but the changes
 * will not be rendered until <code>isDirty()</code> returns true.  At that point the client-side widget will
 * be told to redraw.   
 * </p>
 */
@SuppressWarnings("restriction")
public abstract class VisualizationWidgetLCA extends AbstractWidgetLCA {
  protected static final String REDRAW_FUNC = "redraw";
  protected static final String PROP_DATA = "widgetData";
  protected static final String PROP_OPTIONS = "widgetOptions";
  
  private static final String[] ALLOWED_STYLES = new String[] { "BORDER" };
  
  public abstract Class<?> getWidgetType();
  
  @Override
  public void renderInitialization( final Widget widget ) throws IOException {
    Control control = (Control)widget;
    IClientObject clientObject = ClientObjectFactory.getClientObject( control );
    clientObject.create( getWidgetType().getCanonicalName() );
//    clientObject.set( "id", WidgetUtil.getId( control ) );
    clientObject.set( "parent", WidgetUtil.getId( control.getParent() ) );
    clientObject.set( "style", WidgetLCAUtil.getStyles( control, ALLOWED_STYLES ) );
   }
  
  @Override
  public void preserveValues( final Widget widget ) {
    ControlLCAUtil.preserveValues( (Control)widget );
    WidgetLCAUtil.preserveCustomVariant( widget );
    ControlLCAUtil.preserveValues( ( Control )widget );
    IWidgetAdapter adapter = WidgetUtil.getAdapter( widget );
    adapter.preserve( PROP_OPTIONS, ( ( VisualizationWidget )widget ).getWidgetOptions() );
    adapter.preserve( PROP_DATA, ( ( VisualizationWidget )widget ).getWidgetData() );
  }

  @Override
  public void renderChanges( final Widget widget ) throws IOException {
    ControlLCAUtil.renderChanges( ( Control )widget );
    WidgetLCAUtil.renderCustomVariant( widget );
    
    VisualizationWidget vWidget = ( VisualizationWidget )widget;
    IClientObject clientObject = ClientObjectFactory.getClientObject( vWidget );
    IWidgetAdapter adapter = WidgetUtil.getAdapter(widget);
    boolean changed = !adapter.isInitialized() || WidgetLCAUtil.hasChanged(widget, PROP_OPTIONS, vWidget.getWidgetOptions());
    if (changed) {
      clientObject.set(PROP_OPTIONS, vWidget.getWidgetOptions());
    }
    changed = WidgetLCAUtil.hasChanged(widget, PROP_DATA, vWidget.getWidgetData());
    if (changed) {
      clientObject.set(PROP_DATA, vWidget.getWidgetData());
    }
    
    if (vWidget.isDirty()) {
      clientObject.call(REDRAW_FUNC, null);
      vWidget.setDirty(false);
    }
  }

  @Override
  public void renderDispose( final Widget widget ) throws IOException {
    ClientObjectFactory.getClientObject( widget ).destroy();
  }

  /**
   * Respond to selection events, set the value of selectedItem on the widget Java object,
   * and broadcast a SWT.Selection event to any listeners  
   */
  public void readData( final Widget widget ) {
    if (widget==null) return;
    VisualizationWidget visWidget = ( VisualizationWidget )widget;
    String selectedItem = WidgetLCAUtil.readPropertyValue( visWidget, "selectedItem" );
    String selectedRow = WidgetLCAUtil.readPropertyValue( visWidget, "selectedRow" );
    String selectedColumn = WidgetLCAUtil.readPropertyValue( visWidget, "selectedColumn" );
    String selectedValue = WidgetLCAUtil.readPropertyValue( visWidget, "selectedValue" );
    if (selectedItem!=null) {
      visWidget.setSelectedItem( selectedItem );
      visWidget.setSelectedRow( selectedRow );
      visWidget.setSelectedColumn( selectedColumn );
      visWidget.setSelectedValue( selectedValue );
      ControlLCAUtil.processSelection( visWidget, null, true );
    }
  }
}