| /******************************************************************************* |
| * Copyright (c) 2000, 2009 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 |
| *******************************************************************************/ |
| package org.eclipse.swt.widgets; |
| |
| |
| import org.eclipse.swt.internal.wpf.*; |
| import org.eclipse.swt.*; |
| import org.eclipse.swt.graphics.*; |
| import org.eclipse.swt.events.*; |
| |
| /** |
| * Instances of this class represent a column in a table widget. |
| * <p><dl> |
| * <dt><b>Styles:</b></dt> |
| * <dd>LEFT, RIGHT, CENTER</dd> |
| * <dt><b>Events:</b></dt> |
| * <dd> Move, Resize, Selection</dd> |
| * </dl> |
| * </p><p> |
| * Note: Only one of the styles LEFT, RIGHT and CENTER may be specified. |
| * </p><p> |
| * IMPORTANT: This class is <em>not</em> intended to be subclassed. |
| * </p> |
| * |
| * @see <a href="http://www.eclipse.org/swt/snippets/#table">Table, TableItem, TableColumn snippets</a> |
| * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> |
| * @noextend This class is not intended to be subclassed by clients. |
| */ |
| public class TableColumn extends Item { |
| static final int IMAGE_PART = 0; |
| static final int TEXT_PART = 1; |
| int headerHandle, stringHandle; |
| boolean moveable, resizable; |
| Table parent; |
| |
| |
| /** |
| * Constructs a new instance of this class given its parent |
| * (which must be a <code>Table</code>) and a style value |
| * describing its behavior and appearance. The item is added |
| * to the end of the items maintained by its parent. |
| * <p> |
| * The style value is either one of the style constants defined in |
| * class <code>SWT</code> which is applicable to instances of this |
| * class, or must be built by <em>bitwise OR</em>'ing together |
| * (that is, using the <code>int</code> "|" operator) two or more |
| * of those <code>SWT</code> style constants. The class description |
| * lists the style constants that are applicable to the class. |
| * Style bits are also inherited from superclasses. |
| * </p> |
| * |
| * @param parent a composite control which will be the parent of the new instance (cannot be null) |
| * @param style the style of control to construct |
| * |
| * @exception IllegalArgumentException <ul> |
| * <li>ERROR_NULL_ARGUMENT - if the parent is null</li> |
| * </ul> |
| * @exception SWTException <ul> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent</li> |
| * <li>ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass</li> |
| * </ul> |
| * |
| * @see SWT#LEFT |
| * @see SWT#RIGHT |
| * @see SWT#CENTER |
| * @see Widget#checkSubclass |
| * @see Widget#getStyle |
| */ |
| public TableColumn (Table parent, int style) { |
| super (parent, checkStyle (style)); |
| resizable = true; |
| this.parent = parent; |
| parent.createItem (this, parent.getColumnCount ()); |
| } |
| |
| /** |
| * Constructs a new instance of this class given its parent |
| * (which must be a <code>Table</code>), a style value |
| * describing its behavior and appearance, and the index |
| * at which to place it in the items maintained by its parent. |
| * <p> |
| * The style value is either one of the style constants defined in |
| * class <code>SWT</code> which is applicable to instances of this |
| * class, or must be built by <em>bitwise OR</em>'ing together |
| * (that is, using the <code>int</code> "|" operator) two or more |
| * of those <code>SWT</code> style constants. The class description |
| * lists the style constants that are applicable to the class. |
| * Style bits are also inherited from superclasses. |
| * </p> |
| * <p> |
| * Note that due to a restriction on some platforms, the first column |
| * is always left aligned. |
| * </p> |
| * @param parent a composite control which will be the parent of the new instance (cannot be null) |
| * @param style the style of control to construct |
| * @param index the zero-relative index to store the receiver in its parent |
| * |
| * @exception IllegalArgumentException <ul> |
| * <li>ERROR_NULL_ARGUMENT - if the parent is null</li> |
| * <li>ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the parent (inclusive)</li> |
| * </ul> |
| * @exception SWTException <ul> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent</li> |
| * <li>ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass</li> |
| * </ul> |
| * |
| * @see SWT#LEFT |
| * @see SWT#RIGHT |
| * @see SWT#CENTER |
| * @see Widget#checkSubclass |
| * @see Widget#getStyle |
| */ |
| public TableColumn (Table parent, int style, int index) { |
| super (parent, checkStyle (style)); |
| resizable = true; |
| this.parent = parent; |
| parent.createItem (this, index); |
| } |
| |
| /** |
| * Adds the listener to the collection of listeners who will |
| * be notified when the control is moved or resized, by sending |
| * it one of the messages defined in the <code>ControlListener</code> |
| * interface. |
| * |
| * @param listener the listener which should be notified |
| * |
| * @exception IllegalArgumentException <ul> |
| * <li>ERROR_NULL_ARGUMENT - if the listener is null</li> |
| * </ul> |
| * @exception SWTException <ul> |
| * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> |
| * </ul> |
| * |
| * @see ControlListener |
| * @see #removeControlListener |
| */ |
| public void addControlListener(ControlListener listener) { |
| checkWidget (); |
| if (listener == null) error (SWT.ERROR_NULL_ARGUMENT); |
| TypedListener typedListener = new TypedListener (listener); |
| addListener (SWT.Resize,typedListener); |
| addListener (SWT.Move,typedListener); |
| } |
| |
| /** |
| * Adds the listener to the collection of listeners who will |
| * be notified when the control is selected by the user, by sending |
| * it one of the messages defined in the <code>SelectionListener</code> |
| * interface. |
| * <p> |
| * <code>widgetSelected</code> is called when the column header is selected. |
| * <code>widgetDefaultSelected</code> is not called. |
| * </p> |
| * |
| * @param listener the listener which should be notified when the control is selected by the user |
| * |
| * @exception IllegalArgumentException <ul> |
| * <li>ERROR_NULL_ARGUMENT - if the listener is null</li> |
| * </ul> |
| * @exception SWTException <ul> |
| * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> |
| * </ul> |
| * |
| * @see SelectionListener |
| * @see #removeSelectionListener |
| * @see SelectionEvent |
| */ |
| public void addSelectionListener (SelectionListener listener) { |
| checkWidget (); |
| if (listener == null) error (SWT.ERROR_NULL_ARGUMENT); |
| TypedListener typedListener = new TypedListener (listener); |
| addListener (SWT.Selection,typedListener); |
| addListener (SWT.DefaultSelection,typedListener); |
| } |
| |
| static int checkStyle (int style) { |
| return checkBits (style, SWT.LEFT, SWT.CENTER, SWT.RIGHT, 0, 0, 0); |
| } |
| |
| protected void checkSubclass () { |
| if (!isValidSubclass ()) error (SWT.ERROR_INVALID_SUBCLASS); |
| } |
| |
| void createHandle () { |
| handle = OS.gcnew_GridViewColumn (); |
| if (handle == 0) SWT.error (SWT.ERROR_NO_HANDLES); |
| headerHandle = OS.gcnew_GridViewColumnHeader (); |
| OS.GridViewColumn_Header (handle, headerHandle); |
| } |
| |
| void deregister () { |
| display.removeWidget (headerHandle); |
| } |
| |
| void destroyWidget () { |
| parent.destroyItem (this); |
| releaseHandle (); |
| } |
| |
| int findPart (String part) { |
| updateLayout (headerHandle); |
| int headerTemplate = OS.Control_Template (headerHandle); |
| int name = createDotNetString ("HeaderContent", false); |
| int contentPresenter = OS.FrameworkTemplate_FindName (headerTemplate, name, headerHandle); |
| OS.GCHandle_Free (name); |
| OS.GCHandle_Free (headerTemplate); |
| if (contentPresenter == 0) return 0; |
| int dataTemplate = OS.GridViewColumn_HeaderTemplate (handle); |
| name = createDotNetString (part, false); |
| int result = OS.FrameworkTemplate_FindName (dataTemplate, name, contentPresenter); |
| OS.GCHandle_Free (contentPresenter); |
| OS.GCHandle_Free (dataTemplate); |
| OS.GCHandle_Free (name); |
| return result; |
| } |
| |
| /** |
| * Returns a value which describes the position of the |
| * text or image in the receiver. The value will be one of |
| * <code>LEFT</code>, <code>RIGHT</code> or <code>CENTER</code>. |
| * |
| * @return the alignment |
| * |
| * @exception SWTException <ul> |
| * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> |
| * </ul> |
| */ |
| public int getAlignment () { |
| checkWidget (); |
| if ((style & SWT.LEFT) != 0) return SWT.LEFT; |
| if ((style & SWT.CENTER) != 0) return SWT.CENTER; |
| if ((style & SWT.RIGHT) != 0) return SWT.RIGHT; |
| return SWT.LEFT; |
| } |
| |
| String getNameText () { |
| return getText (); |
| } |
| |
| /** |
| * Returns the receiver's parent, which must be a <code>Table</code>. |
| * |
| * @return the receiver's parent |
| * |
| * @exception SWTException <ul> |
| * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> |
| * </ul> |
| */ |
| public Table getParent () { |
| checkWidget (); |
| return parent; |
| } |
| |
| /** |
| * Gets the moveable attribute. A column that is |
| * not moveable cannot be reordered by the user |
| * by dragging the header but may be reordered |
| * by the programmer. |
| * |
| * @return the moveable attribute |
| * |
| * @exception SWTException <ul> |
| * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> |
| * </ul> |
| * |
| * @see Table#getColumnOrder() |
| * @see Table#setColumnOrder(int[]) |
| * @see TableColumn#setMoveable(boolean) |
| * @see SWT#Move |
| * |
| * @since 3.1 |
| */ |
| public boolean getMoveable () { |
| checkWidget (); |
| return moveable; |
| } |
| |
| /** |
| * Gets the resizable attribute. A column that is |
| * not resizable cannot be dragged by the user but |
| * may be resized by the programmer. |
| * |
| * @return the resizable attribute |
| * |
| * @exception SWTException <ul> |
| * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> |
| * </ul> |
| */ |
| public boolean getResizable () { |
| checkWidget (); |
| return resizable; |
| } |
| |
| /** |
| * Returns the receiver's tool tip text, or null if it has |
| * not been set. |
| * |
| * @return the receiver's tool tip text |
| * |
| * @exception SWTException <ul> |
| * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> |
| * </ul> |
| * |
| * @since 3.2 |
| */ |
| public String getToolTipText () { |
| checkWidget (); |
| int strPtr = OS.FrameworkElement_ToolTip (headerHandle); |
| String string = createJavaString (strPtr); |
| OS.GCHandle_Free (strPtr); |
| return string; |
| } |
| |
| /** |
| * Gets the width of the receiver. |
| * |
| * @return the width |
| * |
| * @exception SWTException <ul> |
| * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> |
| * </ul> |
| */ |
| public int getWidth () { |
| checkWidget (); |
| return (int) OS.GridViewColumn_ActualWidth (handle); |
| } |
| |
| void HandleClick (int sender, int e) { |
| if (!checkEvent (e)) return; |
| postEvent (SWT.Selection); |
| } |
| |
| void HandleLoaded (int sender, int e) { |
| if (isDisposed ()) return; |
| updateImage (); |
| updateText (); |
| } |
| |
| void HandleMouseDoubleClick (int sender, int e) { |
| if (!checkEvent (e)) return; |
| postEvent (SWT.DefaultSelection); |
| } |
| |
| void HandleSizeChanged (int sender, int e) { |
| if (!checkEvent(e)) return; |
| sendEvent (SWT.Resize); |
| } |
| |
| void hookEvents() { |
| super.hookEvents (); |
| int handler = OS.gcnew_RoutedEventHandler (jniRef, "HandleLoaded"); |
| if (handler == 0) error (SWT.ERROR_NO_HANDLES); |
| OS.FrameworkElement_Loaded (headerHandle, handler); |
| OS.GCHandle_Free (handler); |
| handler = OS.gcnew_RoutedEventHandler (jniRef, "HandleClick"); |
| if (handler == 0) error (SWT.ERROR_NO_HANDLES); |
| int event = OS.ButtonBase_ClickEvent (); |
| OS.UIElement_AddHandler (headerHandle, event, handler, false); |
| OS.GCHandle_Free (event); |
| OS.GCHandle_Free (handler); |
| handler = OS.gcnew_RoutedEventHandler (jniRef, "HandleMouseDoubleClick"); |
| if (handler == 0) error (SWT.ERROR_NO_HANDLES); |
| event = OS.Control_MouseDoubleClickEvent (); |
| OS.UIElement_AddHandler (headerHandle, event, handler, false); |
| OS.GCHandle_Free (event); |
| OS.GCHandle_Free (handler); |
| handler = OS.gcnew_RoutedEventHandler (jniRef, "HandleSizeChanged"); |
| if (handler == 0) error (SWT.ERROR_NO_HANDLES); |
| event = OS.FrameworkElement_SizeChangedEvent (); |
| OS.UIElement_AddHandler (headerHandle, event, handler, false); |
| OS.GCHandle_Free (event); |
| OS.GCHandle_Free (handler); |
| } |
| |
| /** |
| * Causes the receiver to be resized to its preferred size. |
| * For a composite, this involves computing the preferred size |
| * from its layout, if there is one. |
| * |
| * @exception SWTException <ul> |
| * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> |
| * </ul> |
| * |
| */ |
| public void pack () { |
| checkWidget (); |
| updateLayout (parent.handle); |
| double width = 0; |
| if (headerHandle != 0) { |
| int size = OS.UIElement_DesiredSize (headerHandle); |
| width = OS.Size_Width (size); |
| OS.GCHandle_Free (size); |
| } |
| int columnIndex = parent.indexOf (this); |
| int items = OS.ItemsControl_Items (parent.handle); |
| for (int i=0; i<parent.itemCount; i++) { |
| TableItem item = parent.getItem (items, i, false); |
| if (item != null) { |
| width = Math.max (width, item.computeWidth (columnIndex)); |
| } |
| } |
| OS.GCHandle_Free (items); |
| OS.GridViewColumn_Width (handle, width); |
| } |
| |
| void releaseHandle () { |
| super.releaseHandle (); |
| if (handle != 0) OS.GCHandle_Free (handle); |
| handle = 0; |
| OS.GCHandle_Free (headerHandle); |
| parent = null; |
| } |
| |
| void releaseWidget () { |
| super.releaseWidget (); |
| if (stringHandle != 0) OS.GCHandle_Free (stringHandle); |
| stringHandle = 0; |
| } |
| |
| void register() { |
| display.addWidget (headerHandle, this); |
| } |
| |
| /** |
| * Removes the listener from the collection of listeners who will |
| * be notified when the control is moved or resized. |
| * |
| * @param listener the listener which should no longer be notified |
| * |
| * @exception IllegalArgumentException <ul> |
| * <li>ERROR_NULL_ARGUMENT - if the listener is null</li> |
| * </ul> |
| * @exception SWTException <ul> |
| * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> |
| * </ul> |
| * |
| * @see ControlListener |
| * @see #addControlListener |
| */ |
| public void removeControlListener (ControlListener listener) { |
| checkWidget (); |
| if (listener == null) error (SWT.ERROR_NULL_ARGUMENT); |
| if (eventTable == null) return; |
| eventTable.unhook (SWT.Move, listener); |
| eventTable.unhook (SWT.Resize, listener); |
| } |
| |
| /** |
| * Removes the listener from the collection of listeners who will |
| * be notified when the control is selected by the user. |
| * |
| * @param listener the listener which should no longer be notified |
| * |
| * @exception IllegalArgumentException <ul> |
| * <li>ERROR_NULL_ARGUMENT - if the listener is null</li> |
| * </ul> |
| * @exception SWTException <ul> |
| * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> |
| * </ul> |
| * |
| * @see SelectionListener |
| * @see #addSelectionListener |
| */ |
| public void removeSelectionListener(SelectionListener listener) { |
| checkWidget (); |
| if (listener == null) error (SWT.ERROR_NULL_ARGUMENT); |
| if (eventTable == null) return; |
| eventTable.unhook (SWT.Selection, listener); |
| eventTable.unhook (SWT.DefaultSelection,listener); |
| } |
| |
| /** |
| * Controls how text and images will be displayed in the receiver. |
| * The argument should be one of <code>LEFT</code>, <code>RIGHT</code> |
| * or <code>CENTER</code>. |
| * <p> |
| * Note that due to a restriction on some platforms, the first column |
| * is always left aligned. |
| * </p> |
| * @param alignment the new alignment |
| * |
| * @exception SWTException <ul> |
| * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> |
| * </ul> |
| */ |
| public void setAlignment (int alignment) { |
| checkWidget (); |
| if ((alignment & (SWT.LEFT | SWT.RIGHT | SWT.CENTER)) == 0) return; |
| int index = parent.indexOf (this); |
| if (index == -1 || index == 0) return; |
| style &= ~(SWT.LEFT | SWT.RIGHT | SWT.CENTER); |
| style |= alignment & (SWT.LEFT | SWT.RIGHT | SWT.CENTER); |
| //TODO |
| } |
| |
| public void setImage (Image image) { |
| checkWidget (); |
| super.setImage (image); |
| updateImage (); |
| } |
| |
| /** |
| * Sets the moveable attribute. A column that is |
| * moveable can be reordered by the user by dragging |
| * the header. A column that is not moveable cannot be |
| * dragged by the user but may be reordered |
| * by the programmer. |
| * |
| * @param moveable the moveable attribute |
| * |
| * @exception SWTException <ul> |
| * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> |
| * </ul> |
| * |
| * @see Table#setColumnOrder(int[]) |
| * @see Table#getColumnOrder() |
| * @see TableColumn#getMoveable() |
| * @see SWT#Move |
| * |
| * @since 3.1 |
| */ |
| public void setMoveable (boolean moveable) { |
| checkWidget (); |
| this.moveable = moveable; |
| parent.updateMoveable (); |
| } |
| |
| /** |
| * Sets the resizable attribute. A column that is |
| * resizable can be resized by the user dragging the |
| * edge of the header. A column that is not resizable |
| * cannot be dragged by the user but may be resized |
| * by the programmer. |
| * |
| * @param resizable the resize attribute |
| * |
| * @exception SWTException <ul> |
| * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> |
| * </ul> |
| */ |
| public void setResizable (boolean resizable) { |
| checkWidget (); |
| this.resizable = resizable; |
| } |
| |
| void setSortDirection (int direction) { |
| //TODO |
| } |
| |
| public void setText (String string) { |
| checkWidget (); |
| if (string == null) error (SWT.ERROR_NULL_ARGUMENT); |
| if (string.equals (text)) return; |
| text = string; |
| updateText (); |
| } |
| |
| /** |
| * Sets the receiver's tool tip text to the argument, which |
| * may be null indicating that the default tool tip for the |
| * control will be shown. For a control that has a default |
| * tool tip, such as the Tree control on Windows, setting |
| * the tool tip text to an empty string replaces the default, |
| * causing no tool tip text to be shown. |
| * <p> |
| * The mnemonic indicator (character '&') is not displayed in a tool tip. |
| * To display a single '&' in the tool tip, the character '&' can be |
| * escaped by doubling it in the string. |
| * </p> |
| * |
| * @param string the new tool tip text (or null) |
| * |
| * @exception SWTException <ul> |
| * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> |
| * </ul> |
| * |
| * @since 3.2 |
| */ |
| public void setToolTipText (String string) { |
| checkWidget (); |
| if (string != null && string.length() == 0) string = null; |
| int strPtr = createDotNetString (string, false); |
| OS.FrameworkElement_ToolTip (headerHandle, strPtr); |
| OS.GCHandle_Free (strPtr); |
| } |
| |
| /** |
| * Sets the width of the receiver. |
| * |
| * @param width the new width |
| * |
| * @exception SWTException <ul> |
| * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> |
| * </ul> |
| */ |
| public void setWidth (int width) { |
| checkWidget (); |
| if (width < 0) return; |
| updateLayout (parent.handle); |
| OS.GridViewColumn_Width (handle, width); |
| } |
| |
| void updateImage() { |
| int part = findPart (Table.IMAGE_PART_NAME); |
| if (part == 0) return; |
| OS.Image_Source (part, image == null ? 0 : image.handle); |
| OS.GCHandle_Free (part); |
| } |
| |
| void updateText () { |
| int part = findPart (Table.TEXT_PART_NAME); |
| if (part == 0) return; |
| int str = createDotNetString (text, false); |
| OS.TextBlock_Text (part, str); |
| OS.GCHandle_Free (str); |
| OS.GCHandle_Free (part); |
| } |
| |
| } |