public abstract class Control extends Widget implements Drawable
Only one of LEFT_TO_RIGHT or RIGHT_TO_LEFT may be specified.
IMPORTANT: This class is intended to be subclassed only within the SWT implementation.
Modifier and Type | Field and Description |
---|---|
long |
handle
the handle to the OS resource
(Warning: This field is platform dependent)
|
Constructor and Description |
---|
Control(Composite parent,
int style)
Constructs a new instance of this class given its parent
and a style value describing its behavior and appearance.
|
Modifier and Type | Method and Description |
---|---|
void |
addControlListener(ControlListener listener)
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 |
addDragDetectListener(DragDetectListener listener)
Adds the listener to the collection of listeners who will
be notified when a drag gesture occurs, by sending it
one of the messages defined in the
DragDetectListener
interface. |
void |
addFocusListener(FocusListener listener)
Adds the listener to the collection of listeners who will
be notified when the control gains or loses focus, by sending
it one of the messages defined in the
FocusListener
interface. |
void |
addGestureListener(GestureListener listener)
Adds the listener to the collection of listeners who will
be notified when gesture events are generated for the control,
by sending it one of the messages defined in the
GestureListener interface. |
void |
addHelpListener(HelpListener listener)
Adds the listener to the collection of listeners who will
be notified when help events are generated for the control,
by sending it one of the messages defined in the
HelpListener interface. |
void |
addKeyListener(KeyListener listener)
Adds the listener to the collection of listeners who will
be notified when keys are pressed and released on the system keyboard, by sending
it one of the messages defined in the
KeyListener
interface. |
void |
addMenuDetectListener(MenuDetectListener listener)
Adds the listener to the collection of listeners who will
be notified when the platform-specific context menu trigger
has occurred, by sending it one of the messages defined in
the
MenuDetectListener interface. |
void |
addMouseListener(MouseListener listener)
Adds the listener to the collection of listeners who will
be notified when mouse buttons are pressed and released, by sending
it one of the messages defined in the
MouseListener
interface. |
void |
addMouseMoveListener(MouseMoveListener listener)
Adds the listener to the collection of listeners who will
be notified when the mouse moves, by sending it one of the
messages defined in the
MouseMoveListener
interface. |
void |
addMouseTrackListener(MouseTrackListener listener)
Adds the listener to the collection of listeners who will
be notified when the mouse passes or hovers over controls, by sending
it one of the messages defined in the
MouseTrackListener
interface. |
void |
addMouseWheelListener(MouseWheelListener listener)
Adds the listener to the collection of listeners who will
be notified when the mouse wheel is scrolled, by sending
it one of the messages defined in the
MouseWheelListener interface. |
void |
addPaintListener(PaintListener listener)
Adds the listener to the collection of listeners who will
be notified when the receiver needs to be painted, by sending it
one of the messages defined in the
PaintListener
interface. |
void |
addTouchListener(TouchListener listener)
Adds the listener to the collection of listeners who will
be notified when touch events occur, by sending it
one of the messages defined in the
TouchListener
interface. |
void |
addTraverseListener(TraverseListener listener)
Adds the listener to the collection of listeners who will
be notified when traversal events occur, by sending it
one of the messages defined in the
TraverseListener
interface. |
Point |
computeSize(int wHint,
int hHint)
Returns the preferred size of the receiver.
|
Point |
computeSize(int wHint,
int hHint,
boolean changed)
Returns the preferred size of the receiver.
|
boolean |
dragDetect(Event event)
Detects a drag and drop gesture.
|
boolean |
dragDetect(MouseEvent event)
Detects a drag and drop gesture.
|
boolean |
forceFocus()
Forces the receiver to have the keyboard focus, causing
all keyboard events to be delivered to it.
|
Accessible |
getAccessible()
Returns the accessible object for the receiver.
|
Color |
getBackground()
Returns the receiver's background color.
|
Image |
getBackgroundImage()
Returns the receiver's background image.
|
int |
getBorderWidth()
Returns the receiver's border width.
|
Rectangle |
getBounds()
Returns a rectangle describing the receiver's size and location
relative to its parent (or its display if its parent is null),
unless the receiver is a shell.
|
Cursor |
getCursor()
Returns the receiver's cursor, or null if it has not been set.
|
boolean |
getDragDetect()
Returns
true if the receiver is detecting
drag gestures, and false otherwise. |
boolean |
getEnabled()
Returns
true if the receiver is enabled, and
false otherwise. |
Font |
getFont()
Returns the font that the receiver will use to paint textual information.
|
Color |
getForeground()
Returns the foreground color that the receiver will use to draw.
|
java.lang.Object |
getLayoutData()
Returns layout data which is associated with the receiver.
|
Point |
getLocation()
Returns a point describing the receiver's location relative
to its parent (or its display if its parent is null), unless
the receiver is a shell.
|
Menu |
getMenu()
Returns the receiver's pop up menu if it has one, or null
if it does not.
|
Monitor |
getMonitor()
Returns the receiver's monitor.
|
int |
getOrientation()
Returns the orientation of the receiver, which will be one of the
constants
SWT.LEFT_TO_RIGHT or SWT.RIGHT_TO_LEFT . |
Composite |
getParent()
Returns the receiver's parent, which must be a
Composite
or null when the receiver is a shell that was created with null or
a display for a parent. |
Region |
getRegion()
Returns the region that defines the shape of the control,
or null if the control has the default shape.
|
Shell |
getShell()
Returns the receiver's shell.
|
Point |
getSize()
Returns a point describing the receiver's size.
|
int |
getTextDirection()
Returns the text direction of the receiver, which will be one of the
constants
SWT.LEFT_TO_RIGHT or SWT.RIGHT_TO_LEFT . |
java.lang.String |
getToolTipText()
Returns the receiver's tool tip text, or null if it has
not been set.
|
boolean |
getTouchEnabled()
Returns
true if this control is set to send touch events, or
false if it is set to send gesture events instead. |
boolean |
getVisible()
Returns
true if the receiver is visible, and
false otherwise. |
void |
internal_dispose_GC(long hDC,
GCData data)
Invokes platform specific functionality to dispose a GC handle.
|
long |
internal_new_GC(GCData data)
Invokes platform specific functionality to allocate a new GC handle.
|
boolean |
isEnabled()
Returns
true if the receiver is enabled and all
ancestors up to and including the receiver's nearest ancestor
shell are enabled. |
boolean |
isFocusControl()
Returns
true if the receiver has the user-interface
focus, and false otherwise. |
boolean |
isReparentable()
Returns
true if the underlying operating
system supports this reparenting, otherwise false |
boolean |
isVisible()
Returns
true if the receiver is visible and all
ancestors up to and including the receiver's nearest ancestor
shell are visible. |
void |
moveAbove(Control control)
Moves the receiver above the specified control in the
drawing order.
|
void |
moveBelow(Control control)
Moves the receiver below the specified control in the
drawing order.
|
void |
pack()
Causes the receiver to be resized to its preferred size.
|
void |
pack(boolean changed)
Causes the receiver to be resized to its preferred size.
|
boolean |
print(GC gc)
Prints the receiver and all children.
|
void |
redraw()
Causes the entire bounds of the receiver to be marked
as needing to be redrawn.
|
void |
redraw(int x,
int y,
int width,
int height,
boolean all)
Causes the rectangular area of the receiver specified by
the arguments to be marked as needing to be redrawn.
|
void |
removeControlListener(ControlListener listener)
Removes the listener from the collection of listeners who will
be notified when the control is moved or resized.
|
void |
removeDragDetectListener(DragDetectListener listener)
Removes the listener from the collection of listeners who will
be notified when a drag gesture occurs.
|
void |
removeFocusListener(FocusListener listener)
Removes the listener from the collection of listeners who will
be notified when the control gains or loses focus.
|
void |
removeGestureListener(GestureListener listener)
Removes the listener from the collection of listeners who will
be notified when gesture events are generated for the control.
|
void |
removeHelpListener(HelpListener listener)
Removes the listener from the collection of listeners who will
be notified when the help events are generated for the control.
|
void |
removeKeyListener(KeyListener listener)
Removes the listener from the collection of listeners who will
be notified when keys are pressed and released on the system keyboard.
|
void |
removeMenuDetectListener(MenuDetectListener listener)
Removes the listener from the collection of listeners who will
be notified when the platform-specific context menu trigger has
occurred.
|
void |
removeMouseListener(MouseListener listener)
Removes the listener from the collection of listeners who will
be notified when mouse buttons are pressed and released.
|
void |
removeMouseMoveListener(MouseMoveListener listener)
Removes the listener from the collection of listeners who will
be notified when the mouse moves.
|
void |
removeMouseTrackListener(MouseTrackListener listener)
Removes the listener from the collection of listeners who will
be notified when the mouse passes or hovers over controls.
|
void |
removeMouseWheelListener(MouseWheelListener listener)
Removes the listener from the collection of listeners who will
be notified when the mouse wheel is scrolled.
|
void |
removePaintListener(PaintListener listener)
Removes the listener from the collection of listeners who will
be notified when the receiver needs to be painted.
|
void |
removeTouchListener(TouchListener listener)
Removes the listener from the collection of listeners who will
be notified when touch events occur.
|
void |
removeTraverseListener(TraverseListener listener)
Removes the listener from the collection of listeners who will
be notified when traversal events occur.
|
void |
setBackground(Color color)
Sets the receiver's background color to the color specified
by the argument, or to the default system color for the control
if the argument is null.
|
void |
setBackgroundImage(Image image)
Sets the receiver's background image to the image specified
by the argument, or to the default system color for the control
if the argument is null.
|
void |
setBounds(int x,
int y,
int width,
int height)
Sets the receiver's size and location to the rectangular
area specified by the arguments.
|
void |
setBounds(Rectangle rect)
Sets the receiver's size and location to the rectangular
area specified by the argument.
|
void |
setCapture(boolean capture)
If the argument is
true , causes the receiver to have
all mouse events delivered to it until the method is called with
false as the argument. |
void |
setCursor(Cursor cursor)
Sets the receiver's cursor to the cursor specified by the
argument, or to the default cursor for that kind of control
if the argument is null.
|
void |
setDragDetect(boolean dragDetect)
Sets the receiver's drag detect state.
|
void |
setEnabled(boolean enabled)
Enables the receiver if the argument is
true ,
and disables it otherwise. |
boolean |
setFocus()
Causes the receiver to have the keyboard focus,
such that all keyboard events will be delivered to it.
|
void |
setFont(Font font)
Sets the font that the receiver will use to paint textual information
to the font specified by the argument, or to the default font for that
kind of control if the argument is null.
|
void |
setForeground(Color color)
Sets the receiver's foreground color to the color specified
by the argument, or to the default system color for the control
if the argument is null.
|
void |
setLayoutData(java.lang.Object layoutData)
Sets the layout data associated with the receiver to the argument.
|
void |
setLocation(int x,
int y)
Sets the receiver's location to the point specified by
the arguments which are relative to the receiver's
parent (or its display if its parent is null), unless
the receiver is a shell.
|
void |
setLocation(Point location)
Sets the receiver's location to the point specified by
the arguments which are relative to the receiver's
parent (or its display if its parent is null), unless
the receiver is a shell.
|
void |
setMenu(Menu menu)
Sets the receiver's pop up menu to the argument.
|
void |
setOrientation(int orientation)
Sets the orientation of the receiver, which must be one
of the constants
SWT.LEFT_TO_RIGHT or SWT.RIGHT_TO_LEFT . |
boolean |
setParent(Composite parent)
Changes the parent of the widget to be the one provided if
the underlying operating system supports this feature.
|
void |
setRedraw(boolean redraw)
If the argument is
false , causes subsequent drawing
operations in the receiver to be ignored. |
void |
setRegion(Region region)
Sets the shape of the control to the region specified
by the argument.
|
void |
setSize(int width,
int height)
Sets the receiver's size to the point specified by the arguments.
|
void |
setSize(Point size)
Sets the receiver's size to the point specified by the argument.
|
void |
setTextDirection(int textDirection)
Sets the base text direction (a.k.a.
|
void |
setToolTipText(java.lang.String string)
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.
|
void |
setTouchEnabled(boolean enabled)
Sets whether this control should send touch events (by default controls do not).
|
void |
setVisible(boolean visible)
Marks the receiver as visible if the argument is
true ,
and marks it invisible otherwise. |
Point |
toControl(int x,
int y)
Returns a point which is the result of converting the
argument, which is specified in display relative coordinates,
to coordinates relative to the receiver.
|
Point |
toControl(Point point)
Returns a point which is the result of converting the
argument, which is specified in display relative coordinates,
to coordinates relative to the receiver.
|
Point |
toDisplay(int x,
int y)
Returns a point which is the result of converting the
argument, which is specified in coordinates relative to
the receiver, to display relative coordinates.
|
Point |
toDisplay(Point point)
Returns a point which is the result of converting the
argument, which is specified in coordinates relative to
the receiver, to display relative coordinates.
|
boolean |
traverse(int traversal)
Based on the argument, perform one of the expected platform
traversal action.
|
boolean |
traverse(int traversal,
Event event)
Performs a platform traversal action corresponding to a
KeyDown event. |
boolean |
traverse(int traversal,
KeyEvent event)
Performs a platform traversal action corresponding to a
KeyDown event. |
void |
update()
Forces all outstanding paint requests for the widget
to be processed before this method returns.
|
addDisposeListener, addListener, checkSubclass, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, reskin, setData, setData, toString
public long handle
IMPORTANT: This field is not part of the SWT public API. It is marked public only so that it can be shared within the packages provided by SWT. It is not available on all platforms and should never be accessed from application code.
public Control(Composite parent, int style)
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.
parent
- a composite control which will be the parent of the new instance (cannot be null)style
- the style of control to constructjava.lang.IllegalArgumentException
- SWTException
- SWT.BORDER
,
SWT.LEFT_TO_RIGHT
,
SWT.RIGHT_TO_LEFT
,
Widget.checkSubclass()
,
Widget.getStyle()
public void addControlListener(ControlListener listener)
ControlListener
interface.listener
- the listener which should be notifiedjava.lang.IllegalArgumentException
- SWTException
- ControlListener
,
removeControlListener(org.eclipse.swt.events.ControlListener)
public void addDragDetectListener(DragDetectListener listener)
DragDetectListener
interface.listener
- the listener which should be notifiedjava.lang.IllegalArgumentException
- SWTException
- DragDetectListener
,
removeDragDetectListener(org.eclipse.swt.events.DragDetectListener)
public void addFocusListener(FocusListener listener)
FocusListener
interface.listener
- the listener which should be notifiedjava.lang.IllegalArgumentException
- SWTException
- FocusListener
,
removeFocusListener(org.eclipse.swt.events.FocusListener)
public void addGestureListener(GestureListener listener)
GestureListener
interface.
NOTE: If setTouchEnabled(true)
has previously been
invoked on the receiver then setTouchEnabled(false)
must be invoked on it to specify that gesture events should be
sent instead of touch events.
listener
- the listener which should be notifiedjava.lang.IllegalArgumentException
- SWTException
- GestureListener
,
removeGestureListener(org.eclipse.swt.events.GestureListener)
,
setTouchEnabled(boolean)
public void addHelpListener(HelpListener listener)
HelpListener
interface.listener
- the listener which should be notifiedjava.lang.IllegalArgumentException
- SWTException
- HelpListener
,
removeHelpListener(org.eclipse.swt.events.HelpListener)
public void addKeyListener(KeyListener listener)
KeyListener
interface.
When a key listener is added to a control, the control will take part in widget traversal. By default, all traversal keys (such as the tab key and so on) are delivered to the control. In order for a control to take part in traversal, it should listen for traversal events. Otherwise, the user can traverse into a control but not out. Note that native controls such as table and tree implement key traversal in the operating system. It is not necessary to add traversal listeners for these controls, unless you want to override the default traversal.
listener
- the listener which should be notifiedjava.lang.IllegalArgumentException
- SWTException
- KeyListener
,
removeKeyListener(org.eclipse.swt.events.KeyListener)
public void addMenuDetectListener(MenuDetectListener listener)
MenuDetectListener
interface.listener
- the listener which should be notifiedjava.lang.IllegalArgumentException
- SWTException
- MenuDetectListener
,
removeMenuDetectListener(org.eclipse.swt.events.MenuDetectListener)
public void addMouseListener(MouseListener listener)
MouseListener
interface.listener
- the listener which should be notifiedjava.lang.IllegalArgumentException
- SWTException
- MouseListener
,
removeMouseListener(org.eclipse.swt.events.MouseListener)
public void addMouseTrackListener(MouseTrackListener listener)
MouseTrackListener
interface.listener
- the listener which should be notifiedjava.lang.IllegalArgumentException
- SWTException
- MouseTrackListener
,
removeMouseTrackListener(org.eclipse.swt.events.MouseTrackListener)
public void addMouseMoveListener(MouseMoveListener listener)
MouseMoveListener
interface.listener
- the listener which should be notifiedjava.lang.IllegalArgumentException
- SWTException
- MouseMoveListener
,
removeMouseMoveListener(org.eclipse.swt.events.MouseMoveListener)
public void addMouseWheelListener(MouseWheelListener listener)
MouseWheelListener
interface.listener
- the listener which should be notifiedjava.lang.IllegalArgumentException
- SWTException
- MouseWheelListener
,
removeMouseWheelListener(org.eclipse.swt.events.MouseWheelListener)
public void addPaintListener(PaintListener listener)
PaintListener
interface.listener
- the listener which should be notifiedjava.lang.IllegalArgumentException
- SWTException
- PaintListener
,
removePaintListener(org.eclipse.swt.events.PaintListener)
public void addTouchListener(TouchListener listener)
TouchListener
interface.
NOTE: You must also call setTouchEnabled(true)
to
specify that touch events should be sent, which will cause gesture
events to not be sent.
listener
- the listener which should be notifiedjava.lang.IllegalArgumentException
- SWTException
- TouchListener
,
removeTouchListener(org.eclipse.swt.events.TouchListener)
,
setTouchEnabled(boolean)
public void addTraverseListener(TraverseListener listener)
TraverseListener
interface.listener
- the listener which should be notifiedjava.lang.IllegalArgumentException
- SWTException
- TraverseListener
,
removeTraverseListener(org.eclipse.swt.events.TraverseListener)
public Point computeSize(int wHint, int hHint)
The preferred size of a control is the size that it would
best be displayed at. The width hint and height hint arguments
allow the caller to ask a control questions such as "Given a particular
width, how high does the control need to be to show all of the contents?"
To indicate that the caller does not wish to constrain a particular
dimension, the constant SWT.DEFAULT
is passed for the hint.
wHint
- the width hint (can be SWT.DEFAULT
)hHint
- the height hint (can be SWT.DEFAULT
)SWTException
- Layout
,
getBorderWidth()
,
getBounds()
,
getSize()
,
pack(boolean)
,
"computeTrim, getClientArea for controls that implement them"public Point computeSize(int wHint, int hHint, boolean changed)
The preferred size of a control is the size that it would
best be displayed at. The width hint and height hint arguments
allow the caller to ask a control questions such as "Given a particular
width, how high does the control need to be to show all of the contents?"
To indicate that the caller does not wish to constrain a particular
dimension, the constant SWT.DEFAULT
is passed for the hint.
If the changed flag is true
, it indicates that the receiver's
contents have changed, therefore any caches that a layout manager
containing the control may have been keeping need to be flushed. When the
control is resized, the changed flag will be false
, so layout
manager caches can be retained.
wHint
- the width hint (can be SWT.DEFAULT
)hHint
- the height hint (can be SWT.DEFAULT
)changed
- true
if the control's contents have changed, and false
otherwiseSWTException
- Layout
,
getBorderWidth()
,
getBounds()
,
getSize()
,
pack(boolean)
,
"computeTrim, getClientArea for controls that implement them"public boolean dragDetect(Event event)
By default, a drag is detected when the gesture
occurs anywhere within the client area of a control.
Some controls, such as tables and trees, override this
behavior. In addition to the operating system specific
drag gesture, they require the mouse to be inside an
item. Custom widget writers can use setDragDetect
to disable the default detection, listen for mouse down,
and then call dragDetect()
from within the
listener to conditionally detect a drag.
event
- the mouse down eventtrue
if the gesture occurred, and false
otherwise.java.lang.IllegalArgumentException
- SWTException
- DragDetectListener
,
addDragDetectListener(org.eclipse.swt.events.DragDetectListener)
,
getDragDetect()
,
setDragDetect(boolean)
public boolean dragDetect(MouseEvent event)
By default, a drag is detected when the gesture
occurs anywhere within the client area of a control.
Some controls, such as tables and trees, override this
behavior. In addition to the operating system specific
drag gesture, they require the mouse to be inside an
item. Custom widget writers can use setDragDetect
to disable the default detection, listen for mouse down,
and then call dragDetect()
from within the
listener to conditionally detect a drag.
event
- the mouse down eventtrue
if the gesture occurred, and false
otherwise.java.lang.IllegalArgumentException
- SWTException
- DragDetectListener
,
addDragDetectListener(org.eclipse.swt.events.DragDetectListener)
,
getDragDetect()
,
setDragDetect(boolean)
public boolean forceFocus()
true
if the control got focus, and false
if it was unable to.SWTException
- setFocus()
public Accessible getAccessible()
If this is the first time this object is requested, then the object is created and returned. The object returned by getAccessible() does not need to be disposed.
SWTException
- Accessible.addAccessibleListener(org.eclipse.swt.accessibility.AccessibleListener)
,
Accessible.addAccessibleControlListener(org.eclipse.swt.accessibility.AccessibleControlListener)
public Color getBackground()
Note: This operation is a hint and may be overridden by the platform. For example, on some versions of Windows the background of a TabFolder, is a gradient rather than a solid color.
SWTException
- public Image getBackgroundImage()
SWTException
- public int getBorderWidth()
SWTException
- public Rectangle getBounds()
SWTException
- public Cursor getCursor()
When the mouse pointer passes over a control its appearance is changed to match the control's cursor.
null
SWTException
- public boolean getDragDetect()
true
if the receiver is detecting
drag gestures, and false
otherwise.SWTException
- public boolean getEnabled()
true
if the receiver is enabled, and
false
otherwise. A disabled control is typically
not selectable from the user interface and draws with an
inactive or "grayed" look.SWTException
- isEnabled()
public Font getFont()
SWTException
- public Color getForeground()
SWTException
- public java.lang.Object getLayoutData()
SWTException
- public Point getLocation()
SWTException
- public Menu getMenu()
SWTException
- public Monitor getMonitor()
SWTException
- public int getOrientation()
SWT.LEFT_TO_RIGHT
or SWT.RIGHT_TO_LEFT
.SWTException
- public Composite getParent()
Composite
or null when the receiver is a shell that was created with null or
a display for a parent.SWTException
- public Region getRegion()
SWTException
- public Shell getShell()
SWTException
- getParent()
public Point getSize()
SWTException
- public int getTextDirection()
SWT.LEFT_TO_RIGHT
or SWT.RIGHT_TO_LEFT
.SWTException
- public java.lang.String getToolTipText()
SWTException
- public boolean getTouchEnabled()
true
if this control is set to send touch events, or
false
if it is set to send gesture events instead. This method
also returns false
if a touch-based input device is not detected
(this can be determined with Display#getTouchEnabled()
). Use
setTouchEnabled(boolean)
to switch the events that a control sends
between touch events and gesture events.true
if the control is set to send touch events, or false
otherwiseSWTException
- setTouchEnabled(boolean)
,
Display.getTouchEnabled()
public boolean getVisible()
true
if the receiver is visible, and
false
otherwise.
If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, this method may still indicate that it is considered visible even though it may not actually be showing.
SWTException
- public long internal_new_GC(GCData data)
IMPORTANT: This method is not part of the public
API for Control
. It is marked public only so that it
can be shared within the packages provided by SWT. It is not
available on all platforms, and should never be called from
application code.
internal_new_GC
in interface Drawable
data
- the platform specific GC datapublic void internal_dispose_GC(long hDC, GCData data)
IMPORTANT: This method is not part of the public
API for Control
. It is marked public only so that it
can be shared within the packages provided by SWT. It is not
available on all platforms, and should never be called from
application code.
internal_dispose_GC
in interface Drawable
hDC
- the platform specific GC handledata
- the platform specific GC datapublic boolean isEnabled()
true
if the receiver is enabled and all
ancestors up to and including the receiver's nearest ancestor
shell are enabled. Otherwise, false
is returned.
A disabled control is typically not selectable from the user
interface and draws with an inactive or "grayed" look.SWTException
- getEnabled()
public boolean isFocusControl()
true
if the receiver has the user-interface
focus, and false
otherwise.SWTException
- public boolean isReparentable()
true
if the underlying operating
system supports this reparenting, otherwise false
true
if the widget can be reparented, otherwise false
SWTException
- public boolean isVisible()
true
if the receiver is visible and all
ancestors up to and including the receiver's nearest ancestor
shell are visible. Otherwise, false
is returned.SWTException
- getVisible()
public void moveAbove(Control control)
control
- the sibling control (or null)java.lang.IllegalArgumentException
- SWTException
- moveBelow(org.eclipse.swt.widgets.Control)
,
Composite.getChildren()
public void moveBelow(Control control)
control
- the sibling control (or null)java.lang.IllegalArgumentException
- SWTException
- moveAbove(org.eclipse.swt.widgets.Control)
,
Composite.getChildren()
public void pack()
SWTException
- computeSize(int, int, boolean)
public void pack(boolean changed)
If the changed flag is true
, it indicates that the receiver's
contents have changed, therefore any caches that a layout manager
containing the control may have been keeping need to be flushed. When the
control is resized, the changed flag will be false
, so layout
manager caches can be retained.
changed
- whether or not the receiver's contents have changedSWTException
- computeSize(int, int, boolean)
public boolean print(GC gc)
gc
- the gc where the drawing occurstrue
if the operation was successful and false
otherwisejava.lang.IllegalArgumentException
- SWTException
- public void redraw()
SWTException
- update()
,
PaintListener
,
SWT.Paint
,
SWT.NO_BACKGROUND
,
SWT.NO_REDRAW_RESIZE
,
SWT.NO_MERGE_PAINTS
,
SWT.DOUBLE_BUFFERED
public void redraw(int x, int y, int width, int height, boolean all)
all
flag is true
, any
children of the receiver which intersect with the specified
area will also paint their intersecting areas. If the
all
flag is false
, the children
will not be painted.x
- the x coordinate of the area to drawy
- the y coordinate of the area to drawwidth
- the width of the area to drawheight
- the height of the area to drawall
- true
if children should redraw, and false
otherwiseSWTException
- update()
,
PaintListener
,
SWT.Paint
,
SWT.NO_BACKGROUND
,
SWT.NO_REDRAW_RESIZE
,
SWT.NO_MERGE_PAINTS
,
SWT.DOUBLE_BUFFERED
public void removeControlListener(ControlListener listener)
listener
- the listener which should no longer be notifiedjava.lang.IllegalArgumentException
- SWTException
- ControlListener
,
addControlListener(org.eclipse.swt.events.ControlListener)
public void removeDragDetectListener(DragDetectListener listener)
listener
- the listener which should no longer be notifiedjava.lang.IllegalArgumentException
- SWTException
- DragDetectListener
,
addDragDetectListener(org.eclipse.swt.events.DragDetectListener)
public void removeFocusListener(FocusListener listener)
listener
- the listener which should no longer be notifiedjava.lang.IllegalArgumentException
- SWTException
- FocusListener
,
addFocusListener(org.eclipse.swt.events.FocusListener)
public void removeGestureListener(GestureListener listener)
listener
- the listener which should no longer be notifiedjava.lang.IllegalArgumentException
- SWTException
- GestureListener
,
addGestureListener(org.eclipse.swt.events.GestureListener)
public void removeHelpListener(HelpListener listener)
listener
- the listener which should no longer be notifiedjava.lang.IllegalArgumentException
- SWTException
- HelpListener
,
addHelpListener(org.eclipse.swt.events.HelpListener)
public void removeKeyListener(KeyListener listener)
listener
- the listener which should no longer be notifiedjava.lang.IllegalArgumentException
- SWTException
- KeyListener
,
addKeyListener(org.eclipse.swt.events.KeyListener)
public void removeMenuDetectListener(MenuDetectListener listener)
listener
- the listener which should no longer be notifiedjava.lang.IllegalArgumentException
- SWTException
- MenuDetectListener
,
addMenuDetectListener(org.eclipse.swt.events.MenuDetectListener)
public void removeMouseTrackListener(MouseTrackListener listener)
listener
- the listener which should no longer be notifiedjava.lang.IllegalArgumentException
- SWTException
- MouseTrackListener
,
addMouseTrackListener(org.eclipse.swt.events.MouseTrackListener)
public void removeMouseListener(MouseListener listener)
listener
- the listener which should no longer be notifiedjava.lang.IllegalArgumentException
- SWTException
- MouseListener
,
addMouseListener(org.eclipse.swt.events.MouseListener)
public void removeMouseMoveListener(MouseMoveListener listener)
listener
- the listener which should no longer be notifiedjava.lang.IllegalArgumentException
- SWTException
- MouseMoveListener
,
addMouseMoveListener(org.eclipse.swt.events.MouseMoveListener)
public void removeMouseWheelListener(MouseWheelListener listener)
listener
- the listener which should no longer be notifiedjava.lang.IllegalArgumentException
- SWTException
- MouseWheelListener
,
addMouseWheelListener(org.eclipse.swt.events.MouseWheelListener)
public void removePaintListener(PaintListener listener)
listener
- the listener which should no longer be notifiedjava.lang.IllegalArgumentException
- SWTException
- PaintListener
,
addPaintListener(org.eclipse.swt.events.PaintListener)
public void removeTouchListener(TouchListener listener)
listener
- the listener which should no longer be notifiedjava.lang.IllegalArgumentException
- SWTException
- TouchListener
,
addTouchListener(org.eclipse.swt.events.TouchListener)
public void removeTraverseListener(TraverseListener listener)
listener
- the listener which should no longer be notifiedjava.lang.IllegalArgumentException
- SWTException
- TraverseListener
,
addTraverseListener(org.eclipse.swt.events.TraverseListener)
public void setBackground(Color color)
Note: This operation is a hint and may be overridden by the platform. For example, on Windows the background of a Button cannot be changed.
color
- the new color (or null)java.lang.IllegalArgumentException
- SWTException
- public void setBackgroundImage(Image image)
Note: This operation is a hint and may be overridden by the platform. For example, on Windows the background of a Button cannot be changed.
image
- the new image (or null)java.lang.IllegalArgumentException
- SWTException
- public void setBounds(int x, int y, int width, int height)
x
and
y
arguments are relative to the receiver's
parent (or its display if its parent is null), unless
the receiver is a shell. In this case, the x
and y
arguments are relative to the display.
Note: Attempting to set the width or height of the receiver to a negative number will cause that value to be set to zero instead.
x
- the new x coordinate for the receivery
- the new y coordinate for the receiverwidth
- the new width for the receiverheight
- the new height for the receiverSWTException
- public void setBounds(Rectangle rect)
x
and
y
fields of the rectangle are relative to
the receiver's parent (or its display if its parent is null).
Note: Attempting to set the width or height of the receiver to a negative number will cause that value to be set to zero instead.
rect
- the new bounds for the receiverSWTException
- public void setCapture(boolean capture)
true
, causes the receiver to have
all mouse events delivered to it until the method is called with
false
as the argument. Note that on some platforms,
a mouse button must currently be down for capture to be assigned.capture
- true
to capture the mouse, and false
to release itSWTException
- public void setCursor(Cursor cursor)
When the mouse pointer passes over a control its appearance is changed to match the control's cursor.
cursor
- the new cursor (or null)java.lang.IllegalArgumentException
- SWTException
- public void setDragDetect(boolean dragDetect)
true
, the receiver will detect drag gestures,
otherwise these gestures will be ignored.dragDetect
- the new drag detect stateSWTException
- public void setEnabled(boolean enabled)
true
,
and disables it otherwise. A disabled control is typically
not selectable from the user interface and draws with an
inactive or "grayed" look.enabled
- the new enabled stateSWTException
- public boolean setFocus()
true
if the control got focus, and false
if it was unable to.SWTException
- forceFocus()
public void setFont(Font font)
font
- the new font (or null)java.lang.IllegalArgumentException
- SWTException
- public void setForeground(Color color)
Note: This operation is a hint and may be overridden by the platform.
color
- the new color (or null)java.lang.IllegalArgumentException
- SWTException
- public void setLayoutData(java.lang.Object layoutData)
layoutData
- the new layout data for the receiver.SWTException
- public void setLocation(int x, int y)
x
- the new x coordinate for the receivery
- the new y coordinate for the receiverSWTException
- public void setLocation(Point location)
location
- the new location for the receiverSWTException
- public void setMenu(Menu menu)
Note: Disposing of a control that has a pop up menu will dispose of the menu. To avoid this behavior, set the menu to null before the control is disposed.
menu
- the new pop up menujava.lang.IllegalArgumentException
- SWTException
- public void setOrientation(int orientation)
SWT.LEFT_TO_RIGHT
or SWT.RIGHT_TO_LEFT
.
orientation
- new orientation styleSWTException
- public void setRedraw(boolean redraw)
false
, causes subsequent drawing
operations in the receiver to be ignored. No drawing of any kind
can occur in the receiver until the flag is set to true.
Graphics operations that occurred while the flag was
false
are lost. When the flag is set to true
,
the entire widget is marked as needing to be redrawn. Nested calls
to this method are stacked.
Note: This operation is a hint and may not be supported on some platforms or for some widgets.
redraw
- the new redraw stateSWTException
- redraw(int, int, int, int, boolean)
,
update()
public void setRegion(Region region)
region
- the region that defines the shape of the control (or null)java.lang.IllegalArgumentException
- SWTException
- public void setSize(int width, int height)
Note: Attempting to set the width or height of the receiver to a negative number will cause that value to be set to zero instead.
width
- the new width for the receiverheight
- the new height for the receiverSWTException
- public void setSize(Point size)
Note: Attempting to set the width or height of the receiver to a negative number will cause them to be set to zero instead.
size
- the new size for the receiverjava.lang.IllegalArgumentException
- SWTException
- public void setTextDirection(int textDirection)
SWT.LEFT_TO_RIGHT
or
SWT.RIGHT_TO_LEFT
.
setOrientation
would override this value with the text direction
that is consistent with the new orientation.
Warning: This API is currently only implemented on Windows. It doesn't set the base text direction on GTK and Cocoa.
textDirection
- the base text direction styleSWTException
- SWT.FLIP_TEXT_DIRECTION
public void setToolTipText(java.lang.String string)
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.
string
- the new tool tip text (or null)SWTException
- public void setTouchEnabled(boolean enabled)
false
causes the receiver to send gesture events
instead. No exception is thrown if a touch-based input device is not
detected (this can be determined with Display#getTouchEnabled()
).enabled
- the new touch-enabled stateSWTException
- Display.getTouchEnabled()
public void setVisible(boolean visible)
true
,
and marks it invisible otherwise.
If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, marking it visible may not actually cause it to be displayed.
visible
- the new visibility stateSWTException
- public Point toControl(int x, int y)
x
- the x coordinate to be translatedy
- the y coordinate to be translatedSWTException
- public Point toControl(Point point)
point
- the point to be translated (must not be null)java.lang.IllegalArgumentException
- SWTException
- public Point toDisplay(int x, int y)
x
- the x coordinate to be translatedy
- the y coordinate to be translatedSWTException
- public Point toDisplay(Point point)
point
- the point to be translated (must not be null)java.lang.IllegalArgumentException
- SWTException
- public boolean traverse(int traversal)
SWT.TRAVERSE_ESCAPE
, SWT.TRAVERSE_RETURN
,
SWT.TRAVERSE_TAB_NEXT
, SWT.TRAVERSE_TAB_PREVIOUS
,
SWT.TRAVERSE_ARROW_NEXT
, SWT.TRAVERSE_ARROW_PREVIOUS
,
SWT.TRAVERSE_PAGE_NEXT
and SWT.TRAVERSE_PAGE_PREVIOUS
.traversal
- the type of traversalSWTException
- public boolean traverse(int traversal, Event event)
KeyDown
event.
Valid traversal values are
SWT.TRAVERSE_NONE
, SWT.TRAVERSE_MNEMONIC
,
SWT.TRAVERSE_ESCAPE
, SWT.TRAVERSE_RETURN
,
SWT.TRAVERSE_TAB_NEXT
, SWT.TRAVERSE_TAB_PREVIOUS
,
SWT.TRAVERSE_ARROW_NEXT
, SWT.TRAVERSE_ARROW_PREVIOUS
,
SWT.TRAVERSE_PAGE_NEXT
and SWT.TRAVERSE_PAGE_PREVIOUS
.
If traversal
is SWT.TRAVERSE_NONE
then the Traverse
event is created with standard values based on the KeyDown event. If
traversal
is one of the other traversal constants then the Traverse
event is created with this detail, and its doit
is taken from the
KeyDown event.
traversal
- the type of traversal, or SWT.TRAVERSE_NONE
to compute
this from event
event
- the KeyDown eventtrue
if the traversal succeededjava.lang.IllegalArgumentException
- SWTException
- public boolean traverse(int traversal, KeyEvent event)
KeyDown
event.
Valid traversal values are
SWT.TRAVERSE_NONE
, SWT.TRAVERSE_MNEMONIC
,
SWT.TRAVERSE_ESCAPE
, SWT.TRAVERSE_RETURN
,
SWT.TRAVERSE_TAB_NEXT
, SWT.TRAVERSE_TAB_PREVIOUS
,
SWT.TRAVERSE_ARROW_NEXT
, SWT.TRAVERSE_ARROW_PREVIOUS
,
SWT.TRAVERSE_PAGE_NEXT
and SWT.TRAVERSE_PAGE_PREVIOUS
.
If traversal
is SWT.TRAVERSE_NONE
then the Traverse
event is created with standard values based on the KeyDown event. If
traversal
is one of the other traversal constants then the Traverse
event is created with this detail, and its doit
is taken from the
KeyDown event.
traversal
- the type of traversal, or SWT.TRAVERSE_NONE
to compute
this from event
event
- the KeyDown eventtrue
if the traversal succeededjava.lang.IllegalArgumentException
- SWTException
- public void update()
Note: This method does not cause a redraw.
SWTException
- redraw()
,
redraw(int, int, int, int, boolean)
,
PaintListener
,
SWT.Paint
public boolean setParent(Composite parent)
true
if the parent is successfully changed.parent
- the new parent for the control.true
if the parent is changed and false
otherwise.java.lang.IllegalArgumentException
- null
SWTException
-