com.ibm.commons.swt.controls
Class LabelEx

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
                      org.eclipse.swt.custom.CLabel
                          com.ibm.commons.swt.controls.LabelEx

All Implemented Interfaces:

ICustomControl, org.eclipse.swt.graphics.Drawable

public class LabelEx
extends org.eclipse.swt.custom.CLabel
implements ICustomControl

An extension of the SWT CLabel control. The LabelEx control is enhanced to provide the ability to provide an asterisks for required properties/values. The required property can be set by calling the setRequired(boolean) method.

Field Summary

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

handle

Constructor Summary

LabelEx(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 an 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
boolean	isRequired() Returns whether or not the field that this label describes is a required field or not.
void	setId(java.lang.String id) Sets a string identifier on the current widget/control.
void	setRequired(boolean required) Sets whether or not the field described by this label is a required field or not.

Methods inherited from class org.eclipse.swt.custom.CLabel

computeSize, getAlignment, getBottomMargin, getImage, getLeftMargin, getRightMargin, getStyle, getText, getToolTipText, getTopMargin, setAlignment, setBackground, setBackground, setBackground, setBackground, setBottomMargin, setFont, setImage, setLeftMargin, setMargins, setRightMargin, setText, setToolTipText, setTopMargin, shortenText

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

drawBackground, getCaret, getIME, scroll, setCaret, setIME

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

changed, checkSubclass, 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, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTraverseListener, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getParent, getRegion, getShell, getSize, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTraverseListener, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setForeground, setLayoutData, setLocation, setLocation, setMenu, setParent, setRedraw, setRegion, setSize, setSize, 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, 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

LabelEx

public LabelEx(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 an 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

isRequired

public boolean isRequired()

Returns whether or not the field that this label describes is a required field or not.

Returns:

boolean

setRequired

public void setRequired(boolean required)

Sets whether or not the field described by this label is a required field or not. Setting a true value causes the label control to be updated with an image of an asterisks prepended to the label.

Parameters:

required - - boolean