com.ibm.commons.swt.controls.custom
Class CustomCanvas

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.ibm.commons.swt.controls.custom.CustomCanvas

All Implemented Interfaces:

ICustomControl, org.eclipse.swt.graphics.Drawable

public class CustomCanvas
extends org.eclipse.swt.widgets.Canvas
implements ICustomControl

An extension of the standard SWT Canvas.
For convenience this widget also allows the user to associate an ID with the widget.

Field Summary

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

handle

Constructor Summary

CustomCanvas(org.eclipse.swt.widgets.Composite parent, int style, java.lang.String id)
Constructs a new instance of the class given the parent Composite, a style value describing its behavior and appearance, and id which can be used to later identify this control.

Method Summary

java.lang.String	getId() Returns a string identifier associated with the current widget/control
UIUpdater	getUpdater()
void	setId(java.lang.String id) Sets a string identifier on the current widget/control.
void	setUpdater(UIUpdater updater)

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

drawBackground, getCaret, getIME, scroll, setCaret, setFont, setIME

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

changed, checkSubclass, computeSize, drawBackground, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList

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

computeTrim, getBorderWidth, getClientArea, getHorizontalBar, getVerticalBar

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

addControlListener, addDragDetectListener, addFocusListener, addGestureListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTouchListener, addTraverseListener, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getOrientation, getParent, getRegion, getShell, getSize, getToolTipText, getTouchEnabled, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeGestureListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTouchListener, removeTraverseListener, setBackground, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setForeground, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setParent, setRedraw, setRegion, setSize, setSize, setToolTipText, setTouchEnabled, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, traverse, traverse, update

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomCanvas

public CustomCanvas(org.eclipse.swt.widgets.Composite parent,
                    int style,
                    java.lang.String id)

Constructs a new instance of the class given the parent Composite, a style value describing its behavior and appearance, and id which can be used to later identify this control.

Parameters:

parent - - a Composite control which will be the parent of the new instance (CANNOT be null).

style - - the style of the control to construct.

id - - the programmatic ID of the control once constructed.

Method Detail

getId

public java.lang.String getId()

Description copied from interface: ICustomControl

Returns a string identifier associated with the current widget/control

Specified by:

getId in interface ICustomControl

Returns:

String

setId

public void setId(java.lang.String id)

Description copied from interface: ICustomControl

Sets a string identifier on the current widget/control.

Specified by:

setId in interface ICustomControl

getUpdater

public UIUpdater getUpdater()

setUpdater

public void setUpdater(UIUpdater updater)