tmf: Do not persist width of auto-expanded last event table column
[deliverable/tracecompass.git] / tmf / org.eclipse.tracecompass.tmf.ui / src / org / eclipse / tracecompass / tmf / ui / viewers / events / TmfEventsTable.java
index 62ee7b0b5c294521936904fdc44afa23aa03d046..9e454fcc4b0adb814271be07b17675f0d2ff15e0 100644 (file)
@@ -117,6 +117,7 @@ import org.eclipse.swt.widgets.Listener;
 import org.eclipse.swt.widgets.Menu;
 import org.eclipse.swt.widgets.MessageBox;
 import org.eclipse.swt.widgets.Shell;
+import org.eclipse.swt.widgets.Table;
 import org.eclipse.swt.widgets.TableColumn;
 import org.eclipse.swt.widgets.TableItem;
 import org.eclipse.swt.widgets.Text;
@@ -230,7 +231,7 @@ public class TmfEventsTable extends TmfComponent implements IGotoMarker, IColorS
     private static final int FILTER_SUMMARY_INDEX = 1;
     private static final int EVENT_COLUMNS_START_INDEX = MARGIN_COLUMN_INDEX + 1;
 
-    private final class ColumnMovedListener extends ControlAdapter {
+    private final class ColumnListener extends ControlAdapter {
         /*
          * Make sure that the margin column is always first and keep the column
          * order variable up to date.
@@ -238,18 +239,27 @@ public class TmfEventsTable extends TmfComponent implements IGotoMarker, IColorS
         @Override
         public void controlMoved(ControlEvent e) {
             int[] order = fTable.getColumnOrder();
-            if (order[0] == MARGIN_COLUMN_INDEX) {
-                fColumnOrder = order;
-                return;
-            }
-            for (int i = order.length - 1; i > 0; i--) {
-                if (order[i] == MARGIN_COLUMN_INDEX) {
-                    order[i] = order[i - 1];
-                    order[i - 1] = MARGIN_COLUMN_INDEX;
+            if (order[0] != MARGIN_COLUMN_INDEX) {
+                for (int i = order.length - 1; i > 0; i--) {
+                    if (order[i] == MARGIN_COLUMN_INDEX) {
+                        order[i] = order[i - 1];
+                        order[i - 1] = MARGIN_COLUMN_INDEX;
+                    }
                 }
+                fTable.setColumnOrder(order);
+            }
+            fColumnOrder = order;
+            fTable.layout();
+        }
+
+        @Override
+        public void controlResized(ControlEvent e) {
+            TableColumn column = (TableColumn) e.widget;
+            if (column.getResizable() && !isExpanded(column)) {
+                int i = (int) column.getData(Key.INDEX);
+                fColumnSize[i] = column.getWidth();
+                column.setData(Key.WIDTH, fColumnSize[i]);
             }
-            fTable.setColumnOrder(order);
-            fColumnOrder = fTable.getColumnOrder();
         }
     }
 
@@ -630,6 +640,13 @@ public class TmfEventsTable extends TmfComponent implements IGotoMarker, IColorS
          * @since 1.1
          */
         String WIDTH = "$width"; //$NON-NLS-1$
+
+        /**
+         * The position of the column
+         *
+         * @since 2.1
+         */
+        String INDEX = "$index"; //$NON-NLS-1$
     }
 
     /**
@@ -639,8 +656,11 @@ public class TmfEventsTable extends TmfComponent implements IGotoMarker, IColorS
      * @author Patrick Tasse
      */
     public static enum HeaderState {
-        /** No search filter is applied
-         * @since 2.0*/
+        /**
+         * No search filter is applied
+         *
+         * @since 2.0
+         */
         NO_SEARCH,
 
         /** A search filter is applied */
@@ -664,9 +684,11 @@ public class TmfEventsTable extends TmfComponent implements IGotoMarker, IColorS
 
     private Composite fComposite;
     private SashForm fSashForm;
+    private Composite fTableComposite;
     private TmfRawEventViewer fRawViewer;
     private ITmfTrace fTrace;
     private volatile boolean fPackDone = false;
+    private volatile boolean fPackMarginDone = false;
     private HeaderState fHeaderState = HeaderState.NO_SEARCH;
     private long fSelectedRank = -1;
     private long fSelectedBeginRank = -1;
@@ -729,6 +751,10 @@ public class TmfEventsTable extends TmfComponent implements IGotoMarker, IColorS
     private MenuManager fTablePopupMenuManager;
     private MenuManager fHeaderPopupMenuManager;
 
+    private boolean[] fColumnResizable;
+
+    private int[] fColumnSize;
+
     // ------------------------------------------------------------------------
     // Constructors
     // ------------------------------------------------------------------------
@@ -812,16 +838,16 @@ public class TmfEventsTable extends TmfComponent implements IGotoMarker, IColorS
         fSashForm.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));
 
         // Create a composite for the table and its header bar
-        Composite tableComposite = new Composite(fSashForm, SWT.NONE);
-        tableComposite.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));
+        fTableComposite = new Composite(fSashForm, SWT.NONE);
+        fTableComposite.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));
         gl = new GridLayout(1, false);
         gl.marginHeight = 0;
         gl.marginWidth = 0;
         gl.verticalSpacing = 0;
-        tableComposite.setLayout(gl);
+        fTableComposite.setLayout(gl);
 
         // Create an events table header bar
-        fHeaderBar = new TmfEventsTableHeader(tableComposite, SWT.NONE, new IEventsTableHeaderListener() {
+        fHeaderBar = new TmfEventsTableHeader(fTableComposite, SWT.NONE, new IEventsTableHeaderListener() {
             @Override
             public void filterSelected(ITmfFilter filter) {
                 if (filter instanceof TmfFilterMatchesNode) {
@@ -849,7 +875,7 @@ public class TmfEventsTable extends TmfComponent implements IGotoMarker, IColorS
 
         // Create a virtual table
         final int style = SWT.H_SCROLL | SWT.V_SCROLL | SWT.MULTI | SWT.FULL_SELECTION;
-        fTable = new TmfVirtualTable(tableComposite, style);
+        fTable = new TmfVirtualTable(fTableComposite, style);
 
         // Set the table layout
         final GridData layoutData = new GridData(SWT.FILL, SWT.FILL, true, true);
@@ -863,6 +889,7 @@ public class TmfEventsTable extends TmfComponent implements IGotoMarker, IColorS
         for (ITmfEventAspect<?> aspect : aspects) {
             if (aspect != null) {
                 fColumns.add(new TmfEventTableColumn(aspect));
+
             }
         }
 
@@ -870,20 +897,28 @@ public class TmfEventsTable extends TmfComponent implements IGotoMarker, IColorS
         fColumns.add(MARGIN_COLUMN_INDEX, collapseCol);
 
         fHeaderMenu = new Menu(fTable);
+
+        fColumnSize = new int[fColumns.size()];
+        fColumnResizable = new boolean[fColumns.size()];
+        int i = 0;
         // Create the UI columns in the table
         for (TmfEventTableColumn col : fColumns) {
             TableColumn column = fTable.newTableColumn(SWT.LEFT);
             column.setText(col.getHeaderName());
             column.setToolTipText(col.getHeaderTooltip());
             column.setData(Key.ASPECT, col.getEventAspect());
-            column.pack();
+            column.setData(Key.INDEX, i);
             if (col instanceof TmfMarginColumn) {
                 column.setResizable(false);
             } else {
+                column.pack();
                 column.setMoveable(true);
-                column.setData(Key.WIDTH, -1);
+                column.setData(Key.WIDTH, column.getWidth());
+                fColumnSize[i] = column.getWidth();
             }
-            column.addControlListener(new ColumnMovedListener());
+            column.addControlListener(new ColumnListener());
+            fColumnResizable[i] = column.getResizable();
+            i++;
         }
         fColumnOrder = fTable.getColumnOrder();
 
@@ -903,7 +938,7 @@ public class TmfEventsTable extends TmfComponent implements IGotoMarker, IColorS
         // Handle the table item requests
         fTable.addListener(SWT.SetData, new SetDataListener());
 
-        fTable.addMenuDetectListener( event -> {
+        fTable.addMenuDetectListener(event -> {
             fLastMenuCursorLocation = new Point(event.x, event.y);
             Point pt = fTable.getDisplay().map(null, fTable, fLastMenuCursorLocation);
             Rectangle clientArea = fTable.getClientArea();
@@ -960,18 +995,25 @@ public class TmfEventsTable extends TmfComponent implements IGotoMarker, IColorS
      * @param column
      *            the column
      */
-    private static IAction createHeaderAction(final TableColumn column) {
+    private IAction createHeaderAction(final TableColumn column) {
         final IAction columnMenuAction = new Action(column.getText(), IAction.AS_CHECK_BOX) {
             @Override
             public void run() {
-                if (isChecked()) {
-                    column.setWidth((int) column.getData(Key.WIDTH));
+                boolean isChecked = isChecked();
+                if (isChecked) {
+                    int width = (int) column.getData(Key.WIDTH);
                     column.setResizable(true);
+                    if (width == 0) {
+                        column.pack();
+                    } else {
+                        column.setWidth(width);
+                    }
                 } else {
-                    column.setData(Key.WIDTH, column.getWidth());
-                    column.setWidth(0);
                     column.setResizable(false);
+                    column.setWidth(0);
                 }
+                int pos = (int) column.getData(Key.INDEX);
+                fColumnResizable[pos] = isChecked;
             }
         };
         columnMenuAction.setChecked(column.getResizable());
@@ -983,23 +1025,16 @@ public class TmfEventsTable extends TmfComponent implements IGotoMarker, IColorS
             @Override
             public void run() {
                 for (TableColumn column : fTable.getColumns()) {
-                    final Object widthVal = column.getData(Key.WIDTH);
-                    if (widthVal instanceof Integer) {
-                        Integer width = (Integer) widthVal;
-                        if (!column.getResizable()) {
+                    int index = (int) column.getData(Key.INDEX);
+                    if (index != MARGIN_COLUMN_INDEX) {
+                        final int width = (int) column.getData(Key.WIDTH);
+                        column.setResizable(true);
+                        if (width == 0) {
+                            column.pack();
+                        } else {
                             column.setWidth(width);
-                            column.setResizable(true);
-                            /*
-                             * This is because Linux always resizes the last
-                             * column to fill in the void, this means that
-                             * hiding a column resizes others and we can have 10
-                             * columns that are 1000 pixels wide by hiding the
-                             * last one progressively.
-                             */
-                            if (IS_LINUX) {
-                                column.pack();
-                            }
                         }
+                        fColumnResizable[index] = true;
                     }
                 }
             }
@@ -1048,7 +1083,7 @@ public class TmfEventsTable extends TmfComponent implements IGotoMarker, IColorS
         final IAction showTableAction = new Action(Messages.TmfEventsTable_ShowTableActionText) {
             @Override
             public void run() {
-                fTable.setVisible(true);
+                fTableComposite.setVisible(true);
                 fSashForm.layout();
             }
         };
@@ -1056,7 +1091,7 @@ public class TmfEventsTable extends TmfComponent implements IGotoMarker, IColorS
         final IAction hideTableAction = new Action(Messages.TmfEventsTable_HideTableActionText) {
             @Override
             public void run() {
-                fTable.setVisible(false);
+                fTableComposite.setVisible(false);
                 fSashForm.layout();
             }
         };
@@ -1099,6 +1134,11 @@ public class TmfEventsTable extends TmfComponent implements IGotoMarker, IColorS
                 if (cs == null) {
                     return;
                 }
+                Long lineNo = cs.getLineNo();
+                if (lineNo == null) {
+                    /* Not enough information to provide a full callsite */
+                    return;
+                }
 
                 String fileName = cs.getFileName();
                 final String trimmedPath = fileName.replaceAll("\\.\\./", EMPTY_STRING); //$NON-NLS-1$
@@ -1120,7 +1160,7 @@ public class TmfEventsTable extends TmfComponent implements IGotoMarker, IColorS
                              * the line number, then seek there.
                              */
                             ITextEditor textEditor = (ITextEditor) editor;
-                            int lineNumber = Long.valueOf(cs.getLineNumber()).intValue();
+                            int lineNumber = lineNo.intValue();
                             IDocument document = textEditor.getDocumentProvider().getDocument(textEditor.getEditorInput());
 
                             IRegion region = document.getLineInformation(lineNumber - 1);
@@ -1169,7 +1209,7 @@ public class TmfEventsTable extends TmfComponent implements IGotoMarker, IColorS
                         }
                         if (file != null) {
                             marker = file.createMarker(IMarker.MARKER);
-                            marker.setAttribute(IMarker.LINE_NUMBER, Long.valueOf(cs.getLineNumber()).intValue());
+                            marker.setAttribute(IMarker.LINE_NUMBER, lineNo.intValue());
                             IDE.openEditor(PlatformUI.getWorkbench().getActiveWorkbenchWindow().getActivePage(), marker);
                             marker.delete();
                         } else if (files.isEmpty()) {
@@ -1682,6 +1722,10 @@ public class TmfEventsTable extends TmfComponent implements IGotoMarker, IColorS
                 item.setFont(i, fBoldFont);
             }
         }
+        if (!fPackMarginDone) {
+            packMarginColumn();
+            fPackMarginDone = true;
+        }
     }
 
     /**
@@ -2474,6 +2518,7 @@ public class TmfEventsTable extends TmfComponent implements IGotoMarker, IColorS
             final int selection = index + 1 + (eventFilter != null ? +1 : 0);
 
             display.asyncExec(new Runnable() {
+
                 @Override
                 public void run() {
                     if (monitor.isCanceled()) {
@@ -2497,6 +2542,7 @@ public class TmfEventsTable extends TmfComponent implements IGotoMarker, IColorS
                 }
             });
             return Status.OK_STATUS;
+
         }
 
         @Override
@@ -2508,6 +2554,7 @@ public class TmfEventsTable extends TmfComponent implements IGotoMarker, IColorS
                 fSearchThread = null;
             }
         }
+
     }
 
     /**
@@ -2557,9 +2604,8 @@ public class TmfEventsTable extends TmfComponent implements IGotoMarker, IColorS
     /**
      * Pack the columns.
      *
-     * @return
-     *            Whether or not a pack was done in this call. Otherwise, it was already done by a
-     *            previous call
+     * @return Whether or not a pack was done in this call. Otherwise, it was
+     *         already done by a previous call
      *
      * @since 2.0
      */
@@ -2591,19 +2637,25 @@ public class TmfEventsTable extends TmfComponent implements IGotoMarker, IColorS
     }
 
     private void packSingleColumn(int i, final TableColumn column) {
-        final int headerWidth = column.getWidth();
+        if (i != MARGIN_COLUMN_INDEX && !column.getResizable()) {
+            return;
+        }
+        Object data = column.getData(Key.WIDTH);
+        final int headerWidth = data instanceof Integer ? (int) data : -1;
         column.pack();
         /*
          * Workaround for Linux which doesn't consider the image width of
          * search/filter row in TableColumn.pack() after having executed
          * TableItem.setImage(null) for other rows than search/filter row.
          */
-        if (IS_LINUX && (i == 0) && fCollapseFilterEnabled) {
+        if (IS_LINUX && (i == MARGIN_COLUMN_INDEX) && fCollapseFilterEnabled) {
             column.setWidth(column.getWidth() + SEARCH_IMAGE.getBounds().width);
         }
 
         if (column.getWidth() < headerWidth) {
             column.setWidth(headerWidth);
+        } else if (i != MARGIN_COLUMN_INDEX) {
+            column.setData(Key.WIDTH, column.getWidth());
         }
     }
 
@@ -2625,6 +2677,32 @@ public class TmfEventsTable extends TmfComponent implements IGotoMarker, IColorS
         return true;
     }
 
+    /**
+     * Returns true if the column is expanded to take extra available space.
+     * This is the last non-zero-width visible column in the column order on
+     * Linux. This column's width should not be persisted.
+     *
+     * @param column
+     *            the column
+     * @return true if the column is expanded.
+     */
+    private static boolean isExpanded(TableColumn column) {
+        if (IS_LINUX) {
+            Table table = column.getParent();
+            int[] order = table.getColumnOrder();
+            for (int i = order.length - 1; i >= 0; i--) {
+                TableColumn col = table.getColumn(order[i]);
+                if (col == column) {
+                    return true;
+                }
+                if (col.getWidth() > 0) {
+                    return false;
+                }
+            }
+        }
+        return false;
+    }
+
     /**
      * Get the array of item strings (e.g., what to display in each cell of the
      * table row) corresponding to the columns and trace event passed in
@@ -2696,6 +2774,26 @@ public class TmfEventsTable extends TmfComponent implements IGotoMarker, IColorS
         return fColumnOrder;
     }
 
+    /**
+     * Get column widths
+     *
+     * @return the current visual widths of the receiver's columns
+     * @since 2.1
+     */
+    public int[] getColumnWidth() {
+        return fColumnSize;
+    }
+
+    /**
+     * Get whether the columns are resizable
+     *
+     * @return an array stating if each column is resizable
+     * @since 2.1
+     */
+    public boolean[] getColumnResizable() {
+        return fColumnResizable;
+    }
+
     /**
      * Sets the order that the columns in the receiver should be displayed in to
      * the given argument which is described in terms of the zero-relative
@@ -2716,6 +2814,39 @@ public class TmfEventsTable extends TmfComponent implements IGotoMarker, IColorS
         fColumnOrder = fTable.getColumnOrder();
     }
 
+    /**
+     * Sets the column width and resizability
+     *
+     * @param width
+     *            an array of widths
+     * @param resizable
+     *            an array of bools saying if a column is resizable or not
+     * @since 2.1
+     */
+    public void setColumnWidth(int[] width, boolean[] resizable) {
+        int length = fTable.getColumns().length;
+        if (width == null || resizable == null || resizable.length != length || width.length != length) {
+            return;
+        }
+        int i = 0;
+        for (TableColumn column : fTable.getColumns()) {
+            if (i != MARGIN_COLUMN_INDEX) {
+                column.setData(Key.WIDTH, width[i]);
+                column.setResizable(resizable[i]);
+                if (column.getResizable()) {
+                    column.setWidth((int) column.getData(Key.WIDTH));
+                } else {
+                    column.setWidth(0);
+                }
+            }
+            i++;
+        }
+        fColumnSize = width;
+        fColumnResizable = resizable;
+        /* Don't pack, it would override these settings */
+        fPackDone = true;
+    }
+
     /**
      * Notify this table that is got the UI focus.
      */
@@ -3352,8 +3483,7 @@ public class TmfEventsTable extends TmfComponent implements IGotoMarker, IColorS
      */
     private static final class TmfMarginColumn extends TmfEventTableColumn {
 
-        private static final @NonNull ITmfEventAspect<String> MARGIN_ASPECT =
-                new ITmfEventAspect<String>() {
+        private static final @NonNull ITmfEventAspect<String> MARGIN_ASPECT = new ITmfEventAspect<String>() {
 
             @Override
             public String getName() {
@@ -3381,5 +3511,4 @@ public class TmfEventsTable extends TmfComponent implements IGotoMarker, IColorS
             super(MARGIN_ASPECT);
         }
     }
-
-}
+}
\ No newline at end of file
This page took 0.034635 seconds and 5 git commands to generate.