com.tensegrity.gui.swt.control.multiselect
Class PatternSelectionBox

java.lang.Object
  org.eclipse.swt.widgets.Widget
      org.eclipse.swt.widgets.Control
          org.eclipse.swt.widgets.Scrollable
              org.eclipse.swt.widgets.Composite
                  org.eclipse.swt.widgets.Canvas
                      com.tensegrity.gui.swt.control.multiselect.SelectionBox
                          com.tensegrity.gui.swt.control.multiselect.PatternSelectionBox

All Implemented Interfaces:

org.eclipse.swt.graphics.Drawable, java.util.EventListener, org.eclipse.swt.events.MouseListener, org.eclipse.swt.internal.SWTEventListener

public class PatternSelectionBox

extends SelectionBox

A selection box for displaying and choosing patterns.

Each pattern is created by the createControl(Composite, Object) method.
An example of the usage of a PatternSelectionBox can be found in PaintItemDialog

Version:

$Id: PatternSelectionBox.java,v 1.6 2005/04/22 14:15:18 ArndHouben Exp $

Author:

Arnd Houben

Field Summary

Fields inherited from class org.eclipse.swt.widgets.Control

handle

Constructor Summary

PatternSelectionBox(org.eclipse.swt.widgets.Composite parent, int style, int columns)
Constructor where you can specify the amount of used columns for displaying the available patterns.

Method Summary

protected org.eclipse.swt.widgets.Control	createControl(org.eclipse.swt.widgets.Composite parent, java.lang.Object item) Returns a suitable control widget to display the given item object.
java.lang.Object	getSelection() Returns the selected item.
protected void	setSelection(org.eclipse.swt.widgets.Control control) Sets the selected control object.
void	updateItem(int index, org.eclipse.swt.graphics.RGB backColor, org.eclipse.swt.graphics.RGB foreColor) Update the pattern at the given index with the specified colors.

Methods inherited from class com.tensegrity.gui.swt.control.multiselect.SelectionBox

addItem, addItems, addSelectionListener, mouseDoubleClick, mouseDown, mouseUp, removeSelectionListener

Methods inherited from class org.eclipse.swt.widgets.Canvas

getCaret, scroll, setCaret, setFont

Methods inherited from class org.eclipse.swt.widgets.Composite

checkSubclass, computeSize, getChildren, getLayout, getTabList, layout, layout, setFocus, setLayout, setTabList

Methods inherited from class org.eclipse.swt.widgets.Scrollable

computeTrim, getClientArea, getHorizontalBar, getVerticalBar

Methods inherited from class org.eclipse.swt.widgets.Control

addControlListener, addFocusListener, addHelpListener, addKeyListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addPaintListener, addTraverseListener, computeSize, forceFocus, getAccessible, getBackground, getBorderWidth, getBounds, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getParent, getShell, getSize, getToolTipText, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, redraw, redraw, removeControlListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removePaintListener, removeTraverseListener, setBackground, setBounds, setBounds, setCapture, setCursor, setEnabled, setForeground, setLayoutData, setLocation, setLocation, setMenu, setParent, setRedraw, setSize, setSize, setToolTipText, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, update

Methods inherited from class org.eclipse.swt.widgets.Widget

addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, setData, setData, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PatternSelectionBox

public PatternSelectionBox(org.eclipse.swt.widgets.Composite parent,
                           int style,
                           int columns)

Constructor where you can specify the amount of used columns for displaying the available patterns.

Parameters:

parent - Composite to add this PatternSelectionBox to

style - the style of this SelectionBox

columns - amount of columns to use for displaying patterns

Method Detail

createControl

protected org.eclipse.swt.widgets.Control createControl(org.eclipse.swt.widgets.Composite parent,
                                                        java.lang.Object item)

Description copied from class: SelectionBox

Returns a suitable control widget to display the given item object. This control is also the source of mouse events within this selection box.

Specified by:

createControl in class SelectionBox

Returns:

control for displaying an item

setSelection

protected void setSelection(org.eclipse.swt.widgets.Control control)

Description copied from class: SelectionBox

Sets the selected control object. Implementing classes should take care of that the corresponding item object can be received by getSelection().

Specified by:

setSelection in class SelectionBox

Parameters:

control - the selected control widget

getSelection

public java.lang.Object getSelection()

Description copied from class: SelectionBox

Returns the selected item.

Specified by:

getSelection in class SelectionBox

Returns:

selected item or null if none was selected.

updateItem

public final void updateItem(int index,
                             org.eclipse.swt.graphics.RGB backColor,
                             org.eclipse.swt.graphics.RGB foreColor)

Update the pattern at the given index with the specified colors.

Parameters:

index - the pattern index within the selection box

backColor - the pattern's background color

foreColor - the pattern's foreground color