org.apache.click.eclipse/src/org/apache/click/eclipse/preferences/ClickProjectPropertyPage.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.click.eclipse.preferences;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

import org.apache.click.eclipse.ClickPlugin;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.ProjectScope;
import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.jdt.core.IJavaElement;
import org.eclipse.jdt.core.IType;
import org.eclipse.jdt.core.JavaCore;
import org.eclipse.jdt.core.search.SearchEngine;
import org.eclipse.jdt.ui.IJavaElementSearchConstants;
import org.eclipse.jdt.ui.JavaUI;
import org.eclipse.jface.dialogs.Dialog;
import org.eclipse.jface.dialogs.ProgressMonitorDialog;
import org.eclipse.jface.viewers.ArrayContentProvider;
import org.eclipse.jface.viewers.ILabelProviderListener;
import org.eclipse.jface.viewers.ISelectionChangedListener;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.viewers.ITableLabelProvider;
import org.eclipse.jface.viewers.SelectionChangedEvent;
import org.eclipse.jface.viewers.TableViewer;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.Table;
import org.eclipse.swt.widgets.TableColumn;
import org.eclipse.swt.widgets.Text;
import org.eclipse.ui.dialogs.PropertyPage;
import org.eclipse.ui.dialogs.SelectionDialog;
import org.eclipse.ui.preferences.ScopedPreferenceStore;

/**
 * The project property page to define additonal Velocity variables.
 * 
 * @author Naoki Takezoe
 */
public class ClickProjectPropertyPage extends PropertyPage {
	
	private List<VariableModel> models = new ArrayList<VariableModel>();
	private TableViewer viewer;
	
	public ClickProjectPropertyPage(){
		setTitle(ClickPlugin.getString("propertyPage.variables.title"));
		setDescription(ClickPlugin.getString("propertyPage.variables.description"));
	}
	
	protected Control createContents(Composite parent) {
		Composite composite = new Composite(parent, SWT.NULL);
		composite.setLayout(new GridLayout(2, false));
		composite.setLayoutData(new GridData(GridData.FILL_BOTH));
		
		viewer = new TableViewer(composite, 
				SWT.FULL_SELECTION|SWT.V_SCROLL|SWT.H_SCROLL|SWT.BORDER);
		Table table = viewer.getTable();
		table.setLinesVisible(true);
		table.setLayoutData(new GridData(GridData.FILL_BOTH));
		table.setHeaderVisible(true);
		
		TableColumn column1 = new TableColumn(table, SWT.NULL);
		column1.setText(ClickPlugin.getString("propertyPage.variables.column.name"));
		column1.setWidth(80);
		
		TableColumn column2 = new TableColumn(table, SWT.NULL);
		column2.setText(ClickPlugin.getString("propertyPage.variables.column.type"));
		column2.setWidth(200);
		
		Composite buttons = new Composite(composite, SWT.NULL);
		GridLayout layout = new GridLayout(1, false);
		layout.marginHeight = 0;
		layout.marginBottom = 0;
		layout.marginLeft = 0;
		layout.marginRight = 0;
		buttons.setLayout(layout);
		buttons.setLayoutData(new GridData(GridData.VERTICAL_ALIGN_BEGINNING));
		
		Button addButton = new Button(buttons, SWT.PUSH);
		addButton.setText(ClickPlugin.getString("action.add"));
		addButton.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
		addButton.addSelectionListener(new SelectionAdapter(){
			public void widgetSelected(SelectionEvent e) {
				VariableModel model = new VariableModel();
				VelocityVariableDialog dialog = new VelocityVariableDialog(viewer.getTable().getShell(), model);
				if(dialog.open() == Dialog.OK){
					models.add(model);
					viewer.refresh();
				}
			}
		});
		
		final Button editButton = new Button(buttons, SWT.PUSH);
		editButton.setText(ClickPlugin.getString("action.edit"));
		editButton.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
		editButton.addSelectionListener(new SelectionAdapter(){
			public void widgetSelected(SelectionEvent e) {
				IStructuredSelection sel = (IStructuredSelection) viewer.getSelection();
				if(!sel.isEmpty()){
					VariableModel model = (VariableModel) sel.getFirstElement();
					VelocityVariableDialog dialog = new VelocityVariableDialog(viewer.getTable().getShell(), model);
					if(dialog.open() == Dialog.OK){
						viewer.refresh();
					}
				}
			}
		});
		editButton.setEnabled(false);
		
		final Button removeButton = new Button(buttons, SWT.PUSH);
		removeButton.setText(ClickPlugin.getString("action.remove"));
		removeButton.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
		removeButton.addSelectionListener(new SelectionAdapter(){
			public void widgetSelected(SelectionEvent e) {
				IStructuredSelection sel = (IStructuredSelection) viewer.getSelection();
				if(!sel.isEmpty()){
					models.removeAll(sel.toList());
					viewer.refresh();
				}
			}
		});
		removeButton.setEnabled(false);
		
		viewer.addSelectionChangedListener(new ISelectionChangedListener(){
			public void selectionChanged(SelectionChangedEvent event) {
				IStructuredSelection sel = (IStructuredSelection) viewer.getSelection();
				editButton.setEnabled(!sel.isEmpty());
				removeButton.setEnabled(!sel.isEmpty());
			}
		});
		
		viewer.setContentProvider(new ArrayContentProvider());
		viewer.setLabelProvider(new ITableLabelProvider(){
			public Image getColumnImage(Object row, int column) {
				return null;
			}
			public String getColumnText(Object row, int column) {
				if(column==0){
					return ((VariableModel) row).name;
				} else if(column==1){
					return ((VariableModel) row).type;
				}
				return null;
			}
			public void addListener(ILabelProviderListener listener) {
			}
			public void dispose() {
			}
			public boolean isLabelProperty(Object row, String property) {
				return false;
			}
			public void removeListener(ILabelProviderListener listener) {
			}
		});
		
		ScopedPreferenceStore store = new ScopedPreferenceStore(
				new ProjectScope(getProject()), ClickPlugin.PLUGIN_ID);
		String vars = store.getString(ClickPlugin.PREF_VELOCITY_VARS);
		if(vars != null && vars.length() > 0){
			models = VariableModel.deserialize(vars);
		}
		
		viewer.setInput(models);
		
		return composite;
	}
	
	private IProject getProject(){
		IAdaptable adaptable = getElement();
		if(adaptable instanceof IProject){
			return (IProject) adaptable;
		}
		return (IProject) adaptable.getAdapter(IProject.class);
	}
	
	protected void performDefaults() {
		models.clear();
		super.performDefaults();
	}

	public boolean performOk() {
		ScopedPreferenceStore store = new ScopedPreferenceStore(
				new ProjectScope(getProject()), ClickPlugin.PLUGIN_ID);
		store.setValue(ClickPlugin.PREF_VELOCITY_VARS, VariableModel.serialize(models));
		try {
			store.save();
		} catch(IOException ex){
			ClickPlugin.log(ex);
			return false;
		}
		return super.performOk();
	}



	/**
	 * The dialog to register / modify a Velocity variable.
	 */
	private class VelocityVariableDialog extends Dialog {
		
		private Text name;
		private Text type;
		private VariableModel model;
		
		public VelocityVariableDialog(Shell parent, VariableModel model){
			super(parent);
			this.model = model;
		}
		
//		protected Point getInitialSize() {
//			Point point = super.getInitialSize();
//			point.x = 350;
//			return point;
//		}

		protected Control createDialogArea(Composite parent) {
			getShell().setText(ClickPlugin.getString("propertyPage.variables.dialog.title"));
			
			Composite composite = new Composite(parent, SWT.NULL);
			composite.setLayout(new GridLayout(3, false));
			composite.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
			
			new Label(composite, SWT.NULL).setText(ClickPlugin.getString("propertyPage.variables.dialog.name"));
			name = new Text(composite, SWT.BORDER);
			name.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
			name.setText(model.name);
			new Label(composite, SWT.NULL);
			
			new Label(composite, SWT.NULL).setText(ClickPlugin.getString("propertyPage.variables.dialog.type"));
			type = new Text(composite, SWT.BORDER);
			type.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
			type.setText(model.type);
			Button browseButton = new Button(composite, SWT.PUSH);
			browseButton.setText(ClickPlugin.getString("action.browse"));
			browseButton.addSelectionListener(new SelectionAdapter(){
				public void widgetSelected(SelectionEvent evt){
					Shell shell = type.getShell();
					try {
						SelectionDialog dialog = JavaUI.createTypeDialog(
								shell,new ProgressMonitorDialog(shell),
								SearchEngine.createJavaSearchScope(new IJavaElement[]{JavaCore.create(getProject())}),
								IJavaElementSearchConstants.CONSIDER_CLASSES,false);
						
						if(dialog.open()==SelectionDialog.OK){
							Object[] result = dialog.getResult();
							type.setText(((IType)result[0]).getFullyQualifiedName());
						}
					} catch(Exception ex){
						ClickPlugin.log(ex);
					}
				}
			});
			
			
			return composite;
		}

		protected void okPressed() {
			model.name = name.getText();
			model.type = type.getText();
			super.okPressed();
		}
	}
	
	/**
	 * The model of Velocity variables.
	 */
	public static class VariableModel {
		public String name = "";
		public String type = "";
		
		public static String serialize(List<VariableModel> models){
			StringBuffer sb = new StringBuffer();
			for(int i=0;i<models.size();i++){
				VariableModel model = (VariableModel) models.get(i);
				if(sb.length() != 0){
					sb.append(",");
				}
				sb.append(model.name);
				sb.append("=");
				sb.append(model.type);
			}
			return sb.toString();
		}
		
		public static List<VariableModel> deserialize(String value){
			List<VariableModel> list = new ArrayList<VariableModel>();
			String[] dim = value.split(",");
			for(int i=0;i<dim.length;i++){
				String[] nameAndType = dim[i].split("=");
				VariableModel model = new VariableModel();
				model.name = nameAndType[0];
				model.type = nameAndType[1];
				list.add(model);
			}
			return list;
		}
	}

}