diff dwt/custom/TableEditor.d @ 0:380af2bdd8e5

Upload of whole dwt tree
author Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
date Sat, 09 Aug 2008 17:00:02 +0200
parents
children 1a8b3cb347e0
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/dwt/custom/TableEditor.d	Sat Aug 09 17:00:02 2008 +0200
@@ -0,0 +1,252 @@
+/*******************************************************************************
+ * Copyright (c) 2000, 2007 IBM Corporation 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:
+ *     IBM Corporation - initial API and implementation
+ *******************************************************************************/
+module dwt.custom;
+
+
+import dwt.*;
+import dwt.events.*;
+import dwt.graphics.*;
+import dwt.widgets.*;
+
+/**
+*
+* A TableEditor is a manager for a Control that appears above a cell in a Table and tracks with the
+* moving and resizing of that cell.  It can be used to display a text widget above a cell
+* in a Table so that the user can edit the contents of that cell.  It can also be used to display
+* a button that can launch a dialog for modifying the contents of the associated cell.
+*
+* <p> Here is an example of using a TableEditor:
+* <code><pre>
+*   final Table table = new Table(shell, DWT.FULL_SELECTION | DWT.HIDE_SELECTION);
+*   TableColumn column1 = new TableColumn(table, DWT.NONE);
+*   TableColumn column2 = new TableColumn(table, DWT.NONE);
+*   for (int i = 0; i &lt; 10; i++) {
+*       TableItem item = new TableItem(table, DWT.NONE);
+*       item.setText(new String[] {"item " + i, "edit this value"});
+*   }
+*   column1.pack();
+*   column2.pack();
+*   
+*   final TableEditor editor = new TableEditor(table);
+*   //The editor must have the same size as the cell and must
+*   //not be any smaller than 50 pixels.
+*   editor.horizontalAlignment = DWT.LEFT;
+*   editor.grabHorizontal = true;
+*   editor.minimumWidth = 50;
+*   // editing the second column
+*   final int EDITABLECOLUMN = 1;
+*   
+*   table.addSelectionListener(new SelectionAdapter() {
+*       public void widgetSelected(SelectionEvent e) {
+*           // Clean up any previous editor control
+*           Control oldEditor = editor.getEditor();
+*           if (oldEditor !is null) oldEditor.dispose();
+*   
+*           // Identify the selected row
+*           TableItem item = (TableItem)e.item;
+*           if (item is null) return;
+*   
+*           // The control that will be the editor must be a child of the Table
+*           Text newEditor = new Text(table, DWT.NONE);
+*           newEditor.setText(item.getText(EDITABLECOLUMN));
+*           newEditor.addModifyListener(new ModifyListener() {
+*               public void modifyText(ModifyEvent e) {
+*                   Text text = (Text)editor.getEditor();
+*                   editor.getItem().setText(EDITABLECOLUMN, text.getText());
+*               }
+*           });
+*           newEditor.selectAll();
+*           newEditor.setFocus();
+*           editor.setEditor(newEditor, item, EDITABLECOLUMN);
+*       }
+*   });
+* </pre></code>
+*/
+public class TableEditor : ControlEditor {
+    Table table;
+    TableItem item;
+    int column = -1;
+    ControlListener columnListener;
+    Runnable timer;
+    static final int TIMEOUT = 1500;
+/**
+* Creates a TableEditor for the specified Table.
+*
+* @param table the Table Control above which this editor will be displayed
+*
+*/
+public TableEditor (Table table) {
+    super(table);
+    this.table = table;
+    
+    columnListener = new ControlListener() {
+        public void controlMoved(ControlEvent e){
+            layout ();
+        }
+        public void controlResized(ControlEvent e){
+            layout ();
+        }
+    };
+    timer = new Runnable () {
+        public void run() {
+            layout ();
+        }
+    };
+    
+    // To be consistent with older versions of DWT, grabVertical defaults to true
+    grabVertical = true;
+}
+Rectangle computeBounds () {
+    if (item is null || column is -1 || item.isDisposed()) return new Rectangle(0, 0, 0, 0);
+    Rectangle cell = item.getBounds(column);
+    Rectangle rect = item.getImageBounds(column);
+    cell.x = rect.x + rect.width;
+    cell.width -= rect.width;
+    Rectangle area = table.getClientArea();
+    if (cell.x < area.x + area.width) {
+        if (cell.x + cell.width > area.x + area.width) {
+            cell.width = area.x + area.width - cell.x;
+        }
+    }
+    Rectangle editorRect = new Rectangle(cell.x, cell.y, minimumWidth, minimumHeight);
+
+    if (grabHorizontal) {
+        editorRect.width = Math.max(cell.width, minimumWidth);
+    }
+    
+    if (grabVertical) {
+        editorRect.height = Math.max(cell.height, minimumHeight);
+    }
+    
+    if (horizontalAlignment is DWT.RIGHT) {
+        editorRect.x += cell.width - editorRect.width;
+    } else if (horizontalAlignment is DWT.LEFT) {
+        // do nothing - cell.x is the right answer
+    } else { // default is CENTER
+        editorRect.x += (cell.width - editorRect.width)/2;
+    }
+    
+    if (verticalAlignment is DWT.BOTTOM) {
+        editorRect.y += cell.height - editorRect.height;
+    } else if (verticalAlignment is DWT.TOP) {
+        // do nothing - cell.y is the right answer
+    } else { // default is CENTER
+        editorRect.y += (cell.height - editorRect.height)/2;
+    }
+    return editorRect;
+}
+/**
+ * Removes all associations between the TableEditor and the cell in the table.  The
+ * Table and the editor Control are <b>not</b> disposed.
+ */
+public void dispose () {
+    if (table !is null && !table.isDisposed()) {
+        if (this.column > -1 && this.column < table.getColumnCount()){
+            TableColumn tableColumn = table.getColumn(this.column);
+            tableColumn.removeControlListener(columnListener);
+        }
+    }
+    columnListener = null;
+    table = null;
+    item = null;
+    column = -1;
+    timer = null;
+    super.dispose();
+}
+/**
+* Returns the zero based index of the column of the cell being tracked by this editor.
+*
+* @return the zero based index of the column of the cell being tracked by this editor
+*/
+public int getColumn () {
+    return column;
+}
+/**
+* Returns the TableItem for the row of the cell being tracked by this editor.
+*
+* @return the TableItem for the row of the cell being tracked by this editor
+*/
+public TableItem getItem () {
+    return item;
+}
+void resize () {
+    layout();
+    /*
+     * On some platforms, the table scrolls when an item that
+     * is partially visible at the bottom of the table is
+     * selected.  Ensure that the correct row is edited by
+     * laying out one more time in a timerExec().
+     */
+    if (table !is null) {
+        Display display = table.getDisplay();
+        display.timerExec(-1, timer);
+        display.timerExec(TIMEOUT, timer);
+    }
+}
+/**
+* Sets the zero based index of the column of the cell being tracked by this editor.
+* 
+* @param column the zero based index of the column of the cell being tracked by this editor 
+*/
+public void setColumn(int column) {
+    int columnCount = table.getColumnCount();
+    // Separately handle the case where the table has no TableColumns.
+    // In this situation, there is a single default column.
+    if (columnCount is 0) {
+        this.column = (column is 0) ? 0 : -1;
+        resize();
+        return;
+    }
+    if (this.column > -1 && this.column < columnCount){
+        TableColumn tableColumn = table.getColumn(this.column);
+        tableColumn.removeControlListener(columnListener);
+        this.column = -1;
+    }
+
+    if (column < 0  || column >= table.getColumnCount()) return;    
+        
+    this.column = column;
+    TableColumn tableColumn = table.getColumn(this.column);
+    tableColumn.addControlListener(columnListener);
+    resize();
+}
+public void setItem (TableItem item) {  
+    this.item = item;
+    resize();
+}
+public void setEditor (Control editor) {
+    super.setEditor(editor);
+    resize();
+}
+/**
+* Specify the Control that is to be displayed and the cell in the table that it is to be positioned above.
+*
+* <p>Note: The Control provided as the editor <b>must</b> be created with its parent being the Table control
+* specified in the TableEditor constructor.
+* 
+* @param editor the Control that is displayed above the cell being edited
+* @param item the TableItem for the row of the cell being tracked by this editor
+* @param column the zero based index of the column of the cell being tracked by this editor
+*/
+public void setEditor (Control editor, TableItem item, int column) {
+    setItem(item);
+    setColumn(column);
+    setEditor(editor);
+}
+public void layout () {
+    if (table is null || table.isDisposed()) return;
+    if (item is null || item.isDisposed()) return;
+    int columnCount = table.getColumnCount();
+    if (columnCount is 0 && column !is 0) return;
+    if (columnCount > 0 && (column < 0 || column >= columnCount)) return;
+    super.layout();
+}
+}