org.eclipse.swt.widgets
Class TableColumn

java.lang.Object
  |
  +--org.eclipse.swt.widgets.Widget
        |
        +--org.eclipse.swt.widgets.Item
              |
              +--org.eclipse.swt.widgets.TableColumn

public class TableColumn
extends Item

Safe:


Field Summary
(package private)  Table parent
           
(package private)  boolean resizable
           
 
Fields inherited from class org.eclipse.swt.widgets.Item
image, text
 
Fields inherited from class org.eclipse.swt.widgets.Widget
CANVAS, COMCTL32_MAJOR, COMCTL32_MINOR, data, DEFAULT_HEIGHT, DEFAULT_WIDTH, DISABLED, DISPOSED, eventTable, HIDDEN, keys, MAJOR, MINOR, Mnemonic, state, style, values
 
Constructor Summary
TableColumn(Table parent, int style)
          Enabled: Constructs a new instance of this class given its parent (which must be a Table) and a style value describing its behavior and appearance.
TableColumn(Table parent, int style, int index)
          Enabled: Constructs a new instance of this class given its parent (which must be a Table), a style value describing its behavior and appearance, and the index at which to place it in the items maintained by its parent.
 
Method Summary
 void addControlListener(ControlListener listener)
          Enabled: 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 ControlListener interface.
 void addSelectionListener(SelectionListener listener)
          Enabled: Adds the listener to the collection of listeners who will be notified when the control is selected, by sending it one of the messages defined in the SelectionListener interface.
(package private) static int checkStyle(int style)
           
protected  void checkSubclass()
          Checks that this class can be subclassed.
 int getAlignment()
          Enabled: Returns a value which describes the position of the text or image in the receiver.
 Display getDisplay()
          Suppressed:
(package private)  String getNameText()
           
 Table getParent()
          Suppressed: Returns the receiver's parent, which must be a Table.
 boolean getResizable()
          Enabled: Gets the resizable attribute.
 int getWidth()
          Enabled: Gets the width of the receiver.
 void pack()
          Enabled: Causes the receiver to be resized to its preferred size.
(package private)  void releaseChild()
           
(package private)  void releaseWidget()
           
 void removeControlListener(ControlListener listener)
          Enabled: Removes the listener from the collection of listeners who will be notified when the control is moved or resized.
 void removeSelectionListener(SelectionListener listener)
          Enabled: Removes the listener from the collection of listeners who will be notified when the control is selected.
 void setAlignment(int alignment)
          Enabled: Controls how text and images will be displayed in the receiver.
 void setImage(Image image)
          Enabled:
 void setResizable(boolean resizable)
          Enabled: Sets the resizable attribute.
 void setText(String string)
          Enabled:
 void setWidth(int width)
          Enabled: Sets the width of the receiver.
 
Methods inherited from class org.eclipse.swt.widgets.Item
getImage, getText
 
Methods inherited from class org.eclipse.swt.widgets.Widget
addDisposeListener, addListener, checkBits, checkOrientation, checkParent, checkWidget, destroyWidget, dispose, error, filters, getData, getData, getName, getStyle, hooks, isDisposed, isListening, isValidSubclass, isValidThread, mbcsToWcs, mbcsToWcs, notifyListeners, postEvent, postEvent, releaseHandle, releaseResources, removeDisposeListener, removeListener, removeListener, sendEvent, sendEvent, sendEvent, sendEvent, setData, setData, setInputState, setKeyState, toString, wcsToMbcs, wcsToMbcs
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

parent

Table parent

resizable

boolean resizable
Constructor Detail

TableColumn

public TableColumn(Table parent,
                   int style)
Enabled: Constructs a new instance of this class given its parent (which must be a Table) and a style value describing its behavior and appearance. The item is added to the end of the items maintained by its parent.

The style value is either one of the style constants defined in class SWT which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the int "|" operator) two or more of those SWT style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

Parameters:
parent - a composite control which will be the parent of the new instance (cannot be null)
style - the style of control to construct
See Also:
SWT.LEFT, SWT.RIGHT, SWT.CENTER, Widget.checkSubclass(), Widget.getStyle()

TableColumn

public TableColumn(Table parent,
                   int style,
                   int index)
Enabled: Constructs a new instance of this class given its parent (which must be a Table), a style value describing its behavior and appearance, and the index at which to place it in the items maintained by its parent.

The style value is either one of the style constants defined in class SWT which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the int "|" operator) two or more of those SWT style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

Parameters:
parent - a composite control which will be the parent of the new instance (cannot be null)
style - the style of control to construct
index - the index to store the receiver in its parent
See Also:
SWT.LEFT, SWT.RIGHT, SWT.CENTER, Widget.checkSubclass(), Widget.getStyle()
Method Detail

addControlListener

public void addControlListener(ControlListener listener)
Enabled: 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 ControlListener interface.

Parameters:
listener - the listener which should be notified
See Also:
ControlListener, removeControlListener(org.eclipse.swt.events.ControlListener)

addSelectionListener

public void addSelectionListener(SelectionListener listener)
Enabled: Adds the listener to the collection of listeners who will be notified when the control is selected, by sending it one of the messages defined in the SelectionListener interface.

widgetSelected is called when the column header is selected. widgetDefaultSelected is not called.

Parameters:
listener - the listener which should be notified
See Also:
SelectionListener, removeSelectionListener(org.eclipse.swt.events.SelectionListener), SelectionEvent

checkStyle

static int checkStyle(int style)

checkSubclass

protected void checkSubclass()
Description copied from class: Widget
Checks that this class can be subclassed.

The SWT class library is intended to be subclassed only at specific, controlled points (most notably, Composite and Canvas when implementing new widgets). This method enforces this rule unless it is overridden.

IMPORTANT: By providing an implementation of this method that allows a subclass of a class which does not normally allow subclassing to be created, the implementer agrees to be fully responsible for the fact that any such subclass will likely fail between SWT releases and will be strongly platform specific. No support is provided for user-written classes which are implemented in this fashion.

The ability to subclass outside of the allowed SWT classes is intended purely to enable those not on the SWT development team to implement patches in order to get around specific limitations in advance of when those limitations can be addressed by the team. Subclassing should not be attempted without an intimate and detailed understanding of the hierarchy.

Overrides:
checkSubclass in class Item

getAlignment

public int getAlignment()
Enabled: Returns a value which describes the position of the text or image in the receiver. The value will be one of LEFT, RIGHT or CENTER.

Returns:
the alignment

getDisplay

public Display getDisplay()
Suppressed:

Specified by:
getDisplay in class Widget
Returns:
the receiver's display

getNameText

String getNameText()
Overrides:
getNameText in class Item

getParent

public Table getParent()
Suppressed: Returns the receiver's parent, which must be a Table.

Returns:
the receiver's parent

getResizable

public boolean getResizable()
Enabled: Gets the resizable attribute. A column that is not resizable cannot be dragged by the user but may be resized by the programmer.

Returns:
the resizable attribute

getWidth

public int getWidth()
Enabled: Gets the width of the receiver.

Returns:
the width

pack

public void pack()
Enabled: 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.


releaseChild

void releaseChild()
Overrides:
releaseChild in class Widget

releaseWidget

void releaseWidget()
Overrides:
releaseWidget in class Item

removeControlListener

public void removeControlListener(ControlListener listener)
Enabled: Removes the listener from the collection of listeners who will be notified when the control is moved or resized.

Parameters:
listener - the listener which should be notified
See Also:
ControlListener, addControlListener(org.eclipse.swt.events.ControlListener)

removeSelectionListener

public void removeSelectionListener(SelectionListener listener)
Enabled: Removes the listener from the collection of listeners who will be notified when the control is selected.

Parameters:
listener - the listener which should be notified
See Also:
SelectionListener, addSelectionListener(org.eclipse.swt.events.SelectionListener)

setAlignment

public void setAlignment(int alignment)
Enabled: Controls how text and images will be displayed in the receiver. The argument should be one of LEFT, RIGHT or CENTER.

Parameters:
alignment - the new alignment

setImage

public void setImage(Image image)
Enabled:

Overrides:
setImage in class Item
Parameters:
image - the image to display on the receiver (may be null)

setResizable

public void setResizable(boolean resizable)
Enabled: Sets the resizable attribute. A column that is not resizable cannot be dragged by the user but may be resized by the programmer.

Parameters:
resizable - the resize attribute

setText

public void setText(String string)
Enabled:

Overrides:
setText in class Item
Parameters:
string - the new text

setWidth

public void setWidth(int width)
Enabled: Sets the width of the receiver.

Parameters:
width - the new width


comments?