Control (ELib API)

Overview

Package

Class

Tree

Deprecated

Index

Help

Legend

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.swt.widgets
Class Control

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

All Implemented Interfaces:: Drawable

Direct Known Subclasses:: Button, Label, ProgressBar, Sash, Scale, Scrollable, Slider

public abstract class Control
extends Widget
implements Drawable

Safe:

Field Summary

(package private) static short[] ACCENTS


(package private) org.eclipse.swt.accessibility.Accessible accessible


(package private) int background


(package private) int drawCount


(package private) int foreground


int handle
          Suppressed: the handle to the OS resource (Warning: This field is platform dependent)

(package private) int hCursor


(package private) Object layoutData


(package private) Menu menu


(package private) Composite parent


(package private) String toolTipText


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

(package private) Control()
          Prevents uninitialized instances from being created outside the package.

Control(Composite parent, int style)
          Enabled: Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

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 addFocusListener(FocusListener listener)
          Enabled: 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 addHelpListener(HelpListener listener)
          Enabled: 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)
          Enabled: 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 addMouseListener(MouseListener listener)
          Enabled: 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)
          Enabled: 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)
          Enabled: 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 addPaintListener(PaintListener listener)
          Enabled: 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 addTraverseListener(TraverseListener listener)
          Enabled: 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.

(package private) abstract int callWindowProc(int msg, int wParam, int lParam)


(package private) void checkOrientation(Widget parent)


Point computeSize(int wHint, int hHint)
          Enabled: Returns the preferred size of the receiver.

Point computeSize(int wHint, int hHint, boolean changed)
          Enabled: Returns the preferred size of the receiver.

(package private) Control computeTabGroup()


(package private) Control[] computeTabList()


(package private) Control computeTabRoot()


(package private) void createHandle()


(package private) void createWidget()


(package private) int defaultBackground()


(package private) int defaultFont()


(package private) int defaultForeground()


(package private) void deregister()


(package private) void destroyWidget()
          Destroys the widget in the operating system and releases the widget's handle.

(package private) void drawBackground(int hDC)


(package private) void drawBackground(int hDC, org.eclipse.swt.internal.win32.RECT rect)


(package private) int findBrush(int pixel)


(package private) int findCursor()


(package private) char findMnemonic(String string)


(package private) void fixFocus()


boolean forceFocus()
          Suppressed: Forces the receiver to have the keyboard focus, causing all keyboard events to be delivered to it.

(package private) void forceResize()


org.eclipse.swt.accessibility.Accessible getAccessible()
          Suppressed: Returns the accessible object for the receiver.

Color getBackground()
          Enabled: Returns the receiver's background color.

(package private) int getBackgroundPixel()


int getBorderWidth()
          Enabled: Returns the receiver's border width.

Rectangle getBounds()
          Enabled: Returns a rectangle describing the receiver's size and location relative to its parent (or its display if its parent is null).

(package private) int getCodePage()


Display getDisplay()
          Suppressed: Returns the display that the receiver was created on.

boolean getEnabled()
          Enabled: Returns true if the receiver is enabled, and false otherwise.

Font getFont()
          Enabled: Returns the font that the receiver will use to paint textual information.

Color getForeground()
          Enabled: Returns the foreground color that the receiver will use to draw.

(package private) int getForegroundPixel()


Object getLayoutData()
          Enabled: Returns layout data which is associated with the receiver.

Point getLocation()
          Enabled: Returns a point describing the receiver's location relative to its parent (or its display if its parent is null).

Menu getMenu()
          Enabled: Returns the receiver's pop up menu if it has one, or null if it does not.

Composite getParent()
          Suppressed: 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.

(package private) Control[] getPath()


Shell getShell()
          Suppressed: Returns the receiver's shell.

Point getSize()
          Enabled: Returns a point describing the receiver's size.

String getToolTipText()
          Enabled: Returns the receiver's tool tip text, or null if it has not been set.

boolean getVisible()
          Enabled: Returns true if the receiver is visible, and false otherwise.

(package private) boolean hasCursor()


(package private) boolean hasFocus()


void internal_dispose_GC(int hDC, GCData data)
          Suppressed: Invokes platform specific functionality to dispose a GC handle.

int internal_new_GC(GCData data)
          Suppressed: Invokes platform specific functionality to allocate a new GC handle.

(package private) boolean isActive()


boolean isDisposed()
          Enabled:

boolean isEnabled()
          Enabled: Returns true if the receiver is enabled and all of the receiver's ancestors are enabled, and false otherwise.

(package private) boolean isFocusAncestor()


boolean isFocusControl()
          Enabled: Returns true if the receiver has the user-interface focus, and false otherwise.

boolean isReparentable()
          Enabled: Returns true if the underlying operating system supports this reparenting, otherwise false

(package private) boolean isShowing()


(package private) boolean isTabGroup()


(package private) boolean isTabItem()


boolean isVisible()
          Enabled: Returns true if the receiver is visible and all of the receiver's ancestors are visible and false otherwise.

(package private) Decorations menuShell()


(package private) boolean mnemonicHit(char key)


(package private) boolean mnemonicMatch(char key)


void moveAbove(Control control)
          Suppressed: Moves the receiver above the specified control in the drawing order.

void moveBelow(Control control)
          Suppressed: Moves the receiver below the specified control in the drawing order.

(package private) org.eclipse.swt.accessibility.Accessible new_Accessible(Control control)


void pack()
          Enabled: Causes the receiver to be resized to its preferred size.

void pack(boolean changed)
          Enabled: Causes the receiver to be resized to its preferred size.

void redraw()
          Enabled: 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)
          Enabled: Causes the rectangular area of the receiver specified by the arguments to be marked as needing to be redrawn.

(package private) void register()


(package private) void releaseHandle()


(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 removeFocusListener(FocusListener listener)
          Enabled: Removes the listener from the collection of listeners who will be notified when the control gains or loses focus.

void removeHelpListener(HelpListener listener)
          Enabled: 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)
          Enabled: Removes the listener from the collection of listeners who will be notified when keys are pressed and released on the system keyboard.

void removeMouseListener(MouseListener listener)
          Enabled: Removes the listener from the collection of listeners who will be notified when mouse buttons are pressed and released.

void removeMouseMoveListener(MouseMoveListener listener)
          Enabled: Removes the listener from the collection of listeners who will be notified when the mouse moves.

void removeMouseTrackListener(MouseTrackListener listener)
          Enabled: Removes the listener from the collection of listeners who will be notified when the mouse passes or hovers over controls.

void removePaintListener(PaintListener listener)
          Enabled: Removes the listener from the collection of listeners who will be notified when the receiver needs to be painted.

void removeTraverseListener(TraverseListener listener)
          Enabled: Removes the listener from the collection of listeners who will be notified when traversal events occur.

(package private) boolean sendKeyEvent(int type, int msg, int wParam, int lParam)


(package private) boolean sendKeyEvent(int type, int msg, int wParam, int lParam, Event event)


(package private) boolean sendMouseEvent(int type, int msg, int wParam, int lParam, Event event)


(package private) boolean sendMouseEvent(int type, int button, int msg, int wParam, int lParam)


void setBackground(Color color)
          Enabled: 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.

(package private) void setBackgroundPixel(int pixel)


void setBounds(int x, int y, int width, int height)
          Enabled: Sets the receiver's size and location to the rectangular area specified by the arguments.

(package private) void setBounds(int x, int y, int width, int height, int flags)


void setBounds(Rectangle rect)
          Enabled: Sets the receiver's size and location to the rectangular area specified by the argument.

void setCapture(boolean capture)
          Suppressed: 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)
          Enabled: 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.

(package private) void setDefaultFont()


void setEnabled(boolean enabled)
          Enabled: Enables the receiver if the argument is true, and disables it otherwise.

boolean setFocus()
          Suppressed: Causes the receiver to have the keyboard focus, such that all keyboard events will be delivered to it.

void setFont(Font font)
          Enabled: 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)
          Enabled: 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.

(package private) void setForegroundPixel(int pixel)


void setLayoutData(Object layoutData)
          Enabled: Sets the layout data associated with the receiver to the argument.

void setLocation(int x, int y)
          Enabled: 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).

void setLocation(Point location)
          Enabled: Sets the receiver's location to the point specified by the argument which is relative to the receiver's parent (or its display if its parent is null).

void setMenu(Menu menu)
          Enabled: Sets the receiver's pop up menu to the argument.

boolean setParent(Composite parent)
          Suppressed: Changes the parent of the widget to be the one provided if the underlying operating system supports this feature.

(package private) boolean setRadioFocus()


(package private) boolean setRadioSelection(boolean value)


void setRedraw(boolean redraw)
          Enabled: If the argument is false, causes subsequent drawing operations in the receiver to be ignored.

(package private) boolean setSavedFocus()


void setSize(int width, int height)
          Enabled: Sets the receiver's size to the point specified by the arguments.

void setSize(Point size)
          Enabled: Sets the receiver's size to the point specified by the argument.

(package private) boolean setTabGroupFocus()


(package private) boolean setTabItemFocus()


void setToolTipText(String string)
          Enabled: Sets the receiver's tool tip text to the argument, which may be null indicating that no tool tip text should be shown.

void setVisible(boolean visible)
          Enabled: Marks the receiver as visible if the argument is true, and marks it invisible otherwise.

(package private) void sort(int[] items)


(package private) void subclass()


Point toControl(int x, int y)
          Suppressed: 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)
          Enabled: 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)
          Suppressed: 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)
          Enabled: Returns a point which is the result of converting the argument, which is specified in coordinates relative to the receiver, to display relative coordinates.

static boolean transferActive(Shell[] sources, Shell dest)
          Added: If any of the sources were the active shell, then make dest the active shell.

static boolean transferFocus(Control[] sources, Control dest)
          Added: If any of 'sources' currently has or contains the focus, then requests that 'dest' gets the focus.

(package private) boolean translateAccelerator(org.eclipse.swt.internal.win32.MSG msg)


(package private) boolean translateMnemonic(char key)


(package private) boolean translateMnemonic(org.eclipse.swt.internal.win32.MSG msg)


(package private) boolean translateTraversal(org.eclipse.swt.internal.win32.MSG msg)


(package private) boolean traverse(Event event)


boolean traverse(int traversal)
          Suppressed: Based on the argument, perform one of the expected platform traversal action.

(package private) boolean traverseEscape()


(package private) boolean traverseGroup(boolean next)


(package private) boolean traverseItem(boolean next)


(package private) boolean traverseMnemonic(char key)


(package private) boolean traversePage(boolean next)


(package private) boolean traverseReturn()


(package private) void unsubclass()


void update()
          Suppressed: Forces all outstanding paint requests for the widget to be processed before this method returns.

(package private) void update(boolean all)


(package private) void updateFont(Font oldFont, Font newFont)


(package private) int widgetExtStyle()


(package private) int widgetStyle()


(package private) abstract org.eclipse.swt.internal.win32.TCHAR windowClass()


(package private) abstract int windowProc()


(package private) int windowProc(int msg, int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_ACTIVATE(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_CHAR(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_CLEAR(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_CLOSE(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_COMMAND(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_CONTEXTMENU(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_CTLCOLOR(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_CUT(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_DESTROY(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_DRAWITEM(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_ENDSESSION(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_ERASEBKGND(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_GETDLGCODE(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_GETFONT(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_GETOBJECT(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_HELP(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_HOTKEY(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_HSCROLL(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_IME_CHAR(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_IME_COMPOSITION(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_INITMENUPOPUP(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_KEYDOWN(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_KEYUP(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_KILLFOCUS(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_LBUTTONDBLCLK(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_LBUTTONDOWN(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_LBUTTONUP(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_MBUTTONDBLCLK(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_MBUTTONDOWN(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_MBUTTONUP(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_MEASUREITEM(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_MENUCHAR(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_MENUSELECT(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_MOUSEACTIVATE(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_MOUSEHOVER(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_MOUSELEAVE(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_MOUSEMOVE(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_MOUSEWHEEL(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_MOVE(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_NCACTIVATE(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_NCCALCSIZE(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_NCHITTEST(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_NOTIFY(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_PAINT(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_PALETTECHANGED(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_PASTE(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_PRINTCLIENT(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_QUERYENDSESSION(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_QUERYNEWPALETTE(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_QUERYOPEN(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_RBUTTONDBLCLK(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_RBUTTONDOWN(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_RBUTTONUP(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_SETCURSOR(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_SETFOCUS(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_SETFONT(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_SETREDRAW(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_SETTINGCHANGE(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_SHOWWINDOW(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_SIZE(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_SYSCHAR(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_SYSCOLORCHANGE(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_SYSCOMMAND(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_SYSKEYDOWN(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_SYSKEYUP(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_TIMER(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_UNDO(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_VSCROLL(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT WM_WINDOWPOSCHANGING(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT wmColorChild(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT wmCommandChild(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT wmDrawChild(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT wmMeasureChild(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT wmNotifyChild(int wParam, int lParam)


(package private) org.eclipse.swt.internal.win32.LRESULT wmScrollChild(int wParam, int lParam)


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

addDisposeListener, addListener, checkBits, checkParent, checkSubclass, checkWidget, dispose, error, filters, getData, getData, getName, getNameText, getStyle, hooks, isListening, isValidSubclass, isValidThread, mbcsToWcs, mbcsToWcs, notifyListeners, postEvent, postEvent, releaseChild, 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

handle

public int handle

Suppressed: the handle to the OS resource (Warning: This field is platform dependent)

parent

Composite parent

drawCount

int drawCount

hCursor

int hCursor

foreground

int foreground

background

int background

toolTipText

String toolTipText

Field Summary
`(package private) static short[]`	`ACCENTS`
`(package private) org.eclipse.swt.accessibility.Accessible`	`accessible`
`(package private) int`	`background`
`(package private) int`	`drawCount`
`(package private) int`	`foreground`
`int`	`handle` *Suppressed:* the handle to the OS resource (Warning: This field is platform dependent)
`(package private) int`	`hCursor`
`(package private) Object`	`layoutData`
`(package private) Menu`	`menu`
`(package private) Composite`	`parent`
`(package private) String`	`toolTipText`

Constructor Summary
`(package private)`	`Control()` Prevents uninitialized instances from being created outside the package.
	`Control(Composite parent, int style)` *Enabled:* Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

org.eclipse.swt.widgets Class Control