|
|
|
|
org.eclipse.swt.widgets
Class CoolItem
java.lang.Object
org.eclipse.swt.widgets.Widget
org.eclipse.swt.widgets.Item
org.eclipse.swt.widgets.CoolItem
-
All Implemented Interfaces:
-
Adaptable
- public class CoolItem
- extends
Item
Instances of this class are selectable user interface objects that represent
the dynamically positionable areas of a CoolBar .
-
Styles:
- DROP_DOWN
-
Events:
- Selection
IMPORTANT: This class is not intended to be subclassed.
Constructor Summary
|
CoolItem
(
CoolBar parent,
int style)
Constructs a new instance of this class given its parent (which must be a
CoolBar ) and a style value describing its behavior and
appearance. |
CoolItem
(
CoolBar parent,
int style,
int index)
Constructs a new instance of this class given its parent (which must be a
CoolBar ), a style value describing its behavior and
appearance, and the index at which to place it in the items maintained by
its parent. |
Method Summary
|
void
|
addSelectionListener
(
SelectionListener listener)
Adds the listener to the collection of listeners that will be notified when
the control is selected by the user, by sending it one of the messages
defined in the SelectionListener interface. |
protected void
|
checkSubclass
()
|
Point
|
computeSize
(int wHint,
int hHint)
Returns the preferred size of the receiver. |
void
|
dispose
()
Disposes of the operating system resources associated with
the receiver and all its descendents. |
Rectangle
|
getBounds
()
Returns a rectangle describing the receiver's size and location relative to
its parent. |
Control
|
getControl
()
Returns the control that is associated with the receiver. |
Point
|
getMinimumSize
()
Returns the minimum size that the cool item can be resized to using the
cool item's gripper. |
CoolBar
|
getParent
()
Returns the receiver's parent, which must be a CoolBar . |
Point
|
getPreferredSize
()
Returns a point describing the receiver's ideal size. |
Point
|
getSize
()
Returns a point describing the receiver's size. |
void
|
removeSelectionListener
(
SelectionListener listener)
Removes the listener from the collection of listeners that will be notified
when the control is selected by the user. |
void
|
setControl
(
Control control)
Sets the control that is associated with the receiver to the argument. |
void
|
setMinimumSize
(int width,
int height)
Sets the minimum size that the cool item can be resized to using the cool
item's gripper, to the point specified by the arguments. |
void
|
setMinimumSize
(
Point size)
Sets the minimum size that the cool item can be resized to using the cool
item's gripper, to the point specified by the argument. |
void
|
setPreferredSize
(int width,
int height)
Sets the receiver's ideal size to the point specified by the arguments. |
void
|
setPreferredSize
(
Point size)
Sets the receiver's ideal size to the point 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. |
Methods inherited from class org.eclipse.swt.widgets.
Widget
|
addDisposeListener,
addListener,
checkWidget,
getAdapter,
getData,
getData,
getDisplay,
getStyle,
isDisposed,
notifyListeners,
removeDisposeListener,
removeListener,
setData,
setData,
toString
|
CoolItem
public CoolItem(
CoolBar parent,
int style)
- Constructs a new instance of this class given its parent (which must be a
CoolBar ) and a style value describing its behavior and
appearance. The item is added to the end of the items maintained by its
parent.
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.
-
Parameters:
-
parent - a composite control which will be the parent of the new instance
(cannot be null) -
style - the style of control to construct
-
Throws:
-
IllegalArgumentException
-
- ERROR_NULL_ARGUMENT - if the parent is null
-
SWTException -
- ERROR_THREAD_INVALID_ACCESS - if not called from the
thread that created the parent
- ERROR_INVALID_SUBCLASS - if this class is not an allowed
subclass
-
See Also:
-
SWT.DROP_DOWN ,
Widget.checkSubclass() ,
Widget.getStyle()
CoolItem
public CoolItem(
CoolBar parent,
int style,
int index)
- Constructs a new instance of this class given its parent (which must be a
CoolBar ), a style value describing its behavior and
appearance, and the index at which to place it in the items maintained by
its parent.
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.
-
Parameters:
-
parent - a composite control which will be the parent of the new instance
(cannot be null) -
style - the style of control to construct -
index - the zero-relative index at which to store the receiver in its
parent
-
Throws:
-
IllegalArgumentException
-
- ERROR_NULL_ARGUMENT - if the parent is null
- ERROR_INVALID_RANGE - if the index is not between 0 and
the number of elements in the parent (inclusive)
-
SWTException -
- ERROR_THREAD_INVALID_ACCESS - if not called from the
thread that created the parent
- ERROR_INVALID_SUBCLASS - if this class is not an allowed
subclass
-
See Also:
-
SWT.DROP_DOWN ,
Widget.checkSubclass() ,
Widget.getStyle()
addSelectionListener
public void addSelectionListener(
SelectionListener listener)
- Adds the listener to the collection of listeners that will be notified when
the control is selected by the user, by sending it one of the messages
defined in the
SelectionListener interface.
If widgetSelected is called when the mouse is over the
drop-down arrow (or 'chevron') portion of the cool item, the event object
detail field contains the value SWT.ARROW , and the x and y
fields in the event object represent the point at the bottom left of the
chevron, where the menu should be popped up.
widgetDefaultSelected is not called.
-
-
Parameters:
-
listener - the listener which should be notified when the control is selected
by the user
-
Throws:
-
IllegalArgumentException
-
- ERROR_NULL_ARGUMENT - if the listener is null
-
SWTException -
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed
- ERROR_THREAD_INVALID_ACCESS - if not called from the
thread that created the receiver
-
Since:
- 1.0
-
See Also:
-
SelectionListener ,
removeSelectionListener(org.eclipse.swt.events.SelectionListener) ,
SelectionEvent
checkSubclass
protected void checkSubclass()
-
-
Overrides:
-
checkSubclass
in class
Widget
-
computeSize
public
Point computeSize(int wHint,
int hHint)
- Returns the preferred size of the receiver.
The preferred size of a CoolItem is the size that
it would best be displayed at. The width hint and height hint arguments
allow the caller to ask the instance questions such as "Given a particular
width, how high does it 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.
-
-
Parameters:
-
wHint - the width hint (can be SWT.DEFAULT ) -
hHint - the height hint (can be SWT.DEFAULT )
-
Returns:
- the preferred size
-
Throws:
-
SWTException -
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed
- ERROR_THREAD_INVALID_ACCESS - if not called from the
thread that created the receiver
-
See Also:
-
Layout ,
getBounds() ,
getSize() ,
Control.getBorderWidth() ,
Scrollable.computeTrim(int, int, int, int) ,
Scrollable.getClientArea()
dispose
public void dispose()
-
Description copied from class:
Widget
- Disposes of the operating system resources associated with
the receiver and all its descendents. After this method has
been invoked, the receiver and all descendents will answer
true when sent the message isDisposed() .
Any internal connections between the widgets in the tree will
have been removed to facilitate garbage collection.
NOTE: This method is not called recursively on the descendents
of the receiver. This means that, widget implementers can not
detect when a widget is being disposed of by re-implementing
this method, but should instead listen for the Dispose
event.
-
-
Overrides:
-
dispose
in class
Widget
-
-
See Also:
-
Widget.addDisposeListener(org.eclipse.swt.events.DisposeListener) ,
Widget.removeDisposeListener(org.eclipse.swt.events.DisposeListener) ,
Widget.checkWidget()
getBounds
public
Rectangle getBounds()
- Returns a rectangle describing the receiver's size and location relative to
its parent.
-
-
Returns:
- the receiver's bounding rectangle
-
Throws:
-
SWTException -
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed
- ERROR_THREAD_INVALID_ACCESS - if not called from the
thread that created the receiver
getControl
public
Control getControl()
- Returns the control that is associated with the receiver.
-
-
Returns:
- the control that is contained by the receiver
-
Throws:
-
SWTException -
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed
- ERROR_THREAD_INVALID_ACCESS - if not called from the
thread that created the receiver
getMinimumSize
public
Point getMinimumSize()
- Returns the minimum size that the cool item can be resized to using the
cool item's gripper.
-
-
Returns:
- a point containing the minimum width and height of the cool item,
in pixels
-
Throws:
-
SWTException -
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed
- ERROR_THREAD_INVALID_ACCESS - if not called from the
thread that created the receiver
-
Since:
- 1.0
getParent
public
CoolBar getParent()
- Returns the receiver's parent, which must be a
CoolBar .
-
-
Returns:
- the receiver's parent
-
Throws:
-
SWTException -
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed
- ERROR_THREAD_INVALID_ACCESS - if not called from the
thread that created the receiver
getPreferredSize
public
Point getPreferredSize()
- Returns a point describing the receiver's ideal size. The x coordinate of
the result is the ideal width of the receiver. The y coordinate of the
result is the ideal height of the receiver.
-
-
Returns:
- the receiver's ideal size
-
Throws:
-
SWTException -
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed
- ERROR_THREAD_INVALID_ACCESS - if not called from the
thread that created the receiver
getSize
public
Point getSize()
- Returns a point describing the receiver's size. The x coordinate of the
result is the width of the receiver. The y coordinate of the result is the
height of the receiver.
-
-
Returns:
- the receiver's size
-
Throws:
-
SWTException -
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed
- ERROR_THREAD_INVALID_ACCESS - if not called from the
thread that created the receiver
removeSelectionListener
public void removeSelectionListener(
SelectionListener listener)
- Removes the listener from the collection of listeners that will be notified
when the control is selected by the user.
-
-
Parameters:
-
listener - the listener which should no longer be notified
-
Throws:
-
IllegalArgumentException
-
- ERROR_NULL_ARGUMENT - if the listener is null
-
SWTException -
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed
- ERROR_THREAD_INVALID_ACCESS - if not called from the
thread that created the receiver
-
Since:
- 1.0
-
See Also:
-
SelectionListener ,
addSelectionListener(org.eclipse.swt.events.SelectionListener)
setControl
public void setControl(
Control control)
- Sets the control that is associated with the receiver to the argument.
-
-
Parameters:
-
control - the new control that will be contained by the receiver
-
Throws:
-
IllegalArgumentException
-
- ERROR_INVALID_ARGUMENT - if the control has been disposed
- ERROR_INVALID_PARENT - if the control is not in the same
widget tree
-
SWTException -
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed
- ERROR_THREAD_INVALID_ACCESS - if not called from the
thread that created the receiver
setMinimumSize
public void setMinimumSize(int width,
int height)
- Sets the minimum size that the cool item can be resized to using the cool
item's gripper, to the point specified by the arguments.
-
-
Parameters:
-
width - the minimum width of the cool item, in pixels -
height - the minimum height of the cool item, in pixels
-
Throws:
-
SWTException -
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed
- ERROR_THREAD_INVALID_ACCESS - if not called from the
thread that created the receiver
-
Since:
- 1.0
setMinimumSize
public void setMinimumSize(
Point size)
- Sets the minimum size that the cool item can be resized to using the cool
item's gripper, to the point specified by the argument.
-
-
Parameters:
-
size - a point representing the minimum width and height of the cool
item, in pixels
-
Throws:
-
IllegalArgumentException
-
- ERROR_NULL_ARGUMENT - if the point is null
-
SWTException -
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed
- ERROR_THREAD_INVALID_ACCESS - if not called from the
thread that created the receiver
-
Since:
- 1.0
setPreferredSize
public void setPreferredSize(int width,
int height)
- Sets the receiver's ideal size to the point specified by the arguments.
-
-
Parameters:
-
width - the new ideal width for the receiver -
height - the new ideal height for the receiver
-
Throws:
-
SWTException -
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed
- ERROR_THREAD_INVALID_ACCESS - if not called from the
thread that created the receiver
setPreferredSize
public void setPreferredSize(
Point size)
- Sets the receiver's ideal size to the point specified by the argument.
-
-
Parameters:
-
size - the new ideal size for the receiver
-
Throws:
-
IllegalArgumentException
-
- ERROR_NULL_ARGUMENT - if the point is null
-
SWTException -
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed
- ERROR_THREAD_INVALID_ACCESS - if not called from the
thread that created the receiver
setSize
public void setSize(int width,
int height)
- Sets the receiver's size to the point specified by the arguments.
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.
-
-
Parameters:
-
width - the new width for the receiver -
height - the new height for the receiver
-
Throws:
-
SWTException -
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed
- ERROR_THREAD_INVALID_ACCESS - if not called from the
thread that created the receiver
setSize
public void setSize(
Point size)
- Sets the receiver's size to the point specified by the argument.
Note: Attempting to set the width or height of the receiver to a negative
number will cause them to be set to zero instead.
-
-
Parameters:
-
size - the new size for the receiver
-
Throws:
-
IllegalArgumentException
-
- ERROR_NULL_ARGUMENT - if the point is null
-
SWTException -
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed
- ERROR_THREAD_INVALID_ACCESS - if not called from the
thread that created the receiver
Copyright (c) Innoopract Informationssysteme GmbH and others 2002, 2008. All rights reserved.
|
|
|