|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.swt.widgets.Widget
org.eclipse.swt.widgets.Control
org.eclipse.swt.widgets.Scrollable
org.eclipse.swt.widgets.Composite
hibergui.swt.CCombo
public final class CCombo
The CCombo class represents a selectable user interface object that combines a text field and a list and issues notification when an item is selected from the list.
Note that although this class is a subclass of Composite,
it does not make sense to add children to it, or set a layout on it.
| Field Summary | |
|---|---|
org.eclipse.swt.widgets.Button |
arrow
|
(package private) org.eclipse.swt.graphics.Color |
background
|
(package private) org.eclipse.swt.widgets.Listener |
filter
|
(package private) org.eclipse.swt.graphics.Font |
font
|
(package private) org.eclipse.swt.graphics.Color |
foreground
|
(package private) boolean |
hasFocus
|
org.eclipse.swt.widgets.List |
list
|
(package private) org.eclipse.swt.widgets.Listener |
listener
|
(package private) org.eclipse.swt.widgets.Shell |
popup
|
org.eclipse.swt.widgets.Text |
text
|
(package private) int |
visibleItemCount
|
| Fields inherited from class org.eclipse.swt.widgets.Composite |
|---|
embeddedHandle |
| Fields inherited from class org.eclipse.swt.widgets.Widget |
|---|
handle |
| Constructor Summary | |
|---|---|
CCombo(org.eclipse.swt.widgets.Composite parent,
int style)
Constructs a new instance of this class given its parent and a style value describing its behavior and appearance. |
|
| Method Summary | |
|---|---|
(package private) char |
_findMnemonic(java.lang.String string)
|
void |
add(java.lang.String string)
Adds the argument to the end of the receiver's list. |
void |
add(java.lang.String string,
int index)
Adds the argument to the receiver's list at the given zero-relative index. |
void |
addModifyListener(org.eclipse.swt.events.ModifyListener listener)
Adds the listener to the collection of listeners who will be notified when the receiver's text is modified, by sending it one of the messages defined in the ModifyListener
interface. |
void |
addSelectionListener(org.eclipse.swt.events.SelectionListener listener)
Adds the listener to the collection of listeners who will be notified when the receiver's selection changes, by sending it one of the messages defined in the SelectionListener
interface. |
(package private) void |
arrowEvent(org.eclipse.swt.widgets.Event event)
|
(package private) static int |
checkStyle(int style)
|
void |
clearSelection()
Sets the selection in the receiver's text field to an empty selection starting just before the first character. |
(package private) void |
comboEvent(org.eclipse.swt.widgets.Event event)
|
org.eclipse.swt.graphics.Point |
computeSize(int wHint,
int hHint,
boolean changed)
|
(package private) void |
createPopup(java.lang.String[] items,
int selectionIndex)
|
void |
deselect(int index)
Deselects the item at the given zero-relative index in the receiver's list. |
void |
deselectAll()
Deselects all selected items in the receiver's list. |
void |
dropDown(boolean drop)
|
(package private) org.eclipse.swt.widgets.Label |
getAssociatedLabel()
|
org.eclipse.swt.widgets.Control[] |
getChildren()
|
boolean |
getEditable()
Gets the editable state. |
java.lang.String |
getItem(int index)
Returns the item at the given, zero-relative index in the receiver's list. |
int |
getItemCount()
Returns the number of items contained in the receiver's list. |
int |
getItemHeight()
Returns the height of the area which would be used to display one of the items in the receiver's list. |
java.lang.String[] |
getItems()
Returns an array of Strings which are the items
in the receiver's list. |
org.eclipse.swt.widgets.Menu |
getMenu()
|
org.eclipse.swt.graphics.Point |
getSelection()
Returns a Point whose x coordinate is the start
of the selection in the receiver's text field, and whose y
coordinate is the end of the selection. |
int |
getSelectionIndex()
Returns the zero-relative index of the item which is currently selected in the receiver's list, or -1 if no item is selected. |
int |
getStyle()
|
java.lang.String |
getText()
Returns a string containing a copy of the contents of the receiver's text field. |
int |
getTextHeight()
Returns the height of the receivers's text field. |
int |
getTextLimit()
Returns the maximum number of characters that the receiver's text field is capable of holding. |
int |
getVisibleItemCount()
Gets the number of items that are visible in the drop down portion of the receiver's list. |
(package private) void |
handleFocus(int type)
|
int |
indexOf(java.lang.String string)
Searches the receiver's list starting at the first item (index 0) until an item is found that is equal to the argument, and returns the index of that item. |
int |
indexOf(java.lang.String string,
int start)
Searches the receiver's list starting at the given, zero-relative index until an item is found that is equal to the argument, and returns the index of that item. |
(package private) void |
initAccessible()
|
(package private) void |
internalLayout(boolean changed)
|
boolean |
isDropped()
|
boolean |
isFocusControl()
|
(package private) void |
listEvent(org.eclipse.swt.widgets.Event event)
|
(package private) void |
popupEvent(org.eclipse.swt.widgets.Event event)
|
void |
redraw()
|
void |
redraw(int x,
int y,
int width,
int height,
boolean all)
|
void |
remove(int index)
Removes the item from the receiver's list at the given zero-relative index. |
void |
remove(int start,
int end)
Removes the items from the receiver's list which are between the given zero-relative start and end indices (inclusive). |
void |
remove(java.lang.String string)
Searches the receiver's list starting at the first item until an item is found that is equal to the argument, and removes that item from the list. |
void |
removeAll()
Removes all of the items from the receiver's list and clear the contents of receiver's text field. |
void |
removeModifyListener(org.eclipse.swt.events.ModifyListener listener)
Removes the listener from the collection of listeners who will be notified when the receiver's text is modified. |
void |
removeSelectionListener(org.eclipse.swt.events.SelectionListener listener)
Removes the listener from the collection of listeners who will be notified when the receiver's selection changes. |
void |
select(int index)
Selects the item at the given zero-relative index in the receiver's list. |
void |
setBackground(org.eclipse.swt.graphics.Color color)
|
void |
setEditable(boolean editable)
Sets the editable state. |
void |
setEnabled(boolean enabled)
|
boolean |
setFocus()
|
void |
setFont(org.eclipse.swt.graphics.Font font)
|
void |
setForeground(org.eclipse.swt.graphics.Color color)
|
void |
setItem(int index,
java.lang.String string)
Sets the text of the item in the receiver's list at the given zero-relative index to the string argument. |
void |
setItems(java.lang.String[] items)
Sets the receiver's list to be the given array of items. |
void |
setLayout(org.eclipse.swt.widgets.Layout layout)
Sets the layout which is associated with the receiver to be the argument which may be null. |
void |
setMenu(org.eclipse.swt.widgets.Menu menu)
|
void |
setSelection(org.eclipse.swt.graphics.Point selection)
Sets the selection in the receiver's text field to the range specified by the argument whose x coordinate is the start of the selection and whose y coordinate is the end of the selection. |
void |
setText(java.lang.String string)
Sets the contents of the receiver's text field to the given string. |
void |
setTextLimit(int limit)
Sets the maximum number of characters that the receiver's text field is capable of holding to be the argument. |
void |
setToolTipText(java.lang.String string)
|
void |
setVisible(boolean visible)
|
void |
setVisibleItemCount(int count)
Sets the number of items that are visible in the drop down portion of the receiver's list. |
(package private) java.lang.String |
stripMnemonic(java.lang.String string)
|
(package private) void |
textEvent(org.eclipse.swt.widgets.Event event)
|
| Methods inherited from class org.eclipse.swt.widgets.Composite |
|---|
changed, checkSubclass, getBackgroundMode, getClientArea, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, setBackgroundMode, setLayoutDeferred, setTabList |
| Methods inherited from class org.eclipse.swt.widgets.Scrollable |
|---|
computeTrim, getBorderWidth, 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, getMonitor, getParent, getShell, getSize, getToolTipText, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, removeControlListener, removeDragDetectListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTraverseListener, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setLayoutData, setLocation, setLocation, setParent, setRedraw, setSize, setSize, toControl, toControl, toDisplay, toDisplay, traverse, update |
| Methods inherited from class org.eclipse.swt.widgets.Widget |
|---|
addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, setData, setData, toString |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public org.eclipse.swt.widgets.Text text
public org.eclipse.swt.widgets.List list
int visibleItemCount
org.eclipse.swt.widgets.Shell popup
public org.eclipse.swt.widgets.Button arrow
boolean hasFocus
org.eclipse.swt.widgets.Listener listener
org.eclipse.swt.widgets.Listener filter
org.eclipse.swt.graphics.Color foreground
org.eclipse.swt.graphics.Color background
org.eclipse.swt.graphics.Font font
| Constructor Detail |
|---|
public CCombo(org.eclipse.swt.widgets.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 widget which will be the parent of the new instance (cannot be null)style - the style of widget to construct
java.lang.IllegalArgumentException - org.eclipse.swt.SWTException - SWT.BORDER,
SWT.READ_ONLY,
SWT.FLAT,
Widget.getStyle()| Method Detail |
|---|
static int checkStyle(int style)
public void add(java.lang.String string)
string - the new item
java.lang.IllegalArgumentException - org.eclipse.swt.SWTException - add(String,int)
public void add(java.lang.String string,
int index)
Note: To add an item at the end of the list, use the
result of calling getItemCount() as the
index or use add(String).
string - the new itemindex - the index for the item
java.lang.IllegalArgumentException - org.eclipse.swt.SWTException - add(String)public void addModifyListener(org.eclipse.swt.events.ModifyListener listener)
ModifyListener
interface.
listener - the listener which should be notified
java.lang.IllegalArgumentException - org.eclipse.swt.SWTException - ModifyListener,
removeModifyListener(org.eclipse.swt.events.ModifyListener)public void addSelectionListener(org.eclipse.swt.events.SelectionListener listener)
SelectionListener
interface.
widgetSelected is called when the combo's list selection changes.
widgetDefaultSelected is typically called when ENTER is pressed the combo's text area.
listener - the listener which should be notified
java.lang.IllegalArgumentException - org.eclipse.swt.SWTException - SelectionListener,
removeSelectionListener(org.eclipse.swt.events.SelectionListener),
SelectionEventvoid arrowEvent(org.eclipse.swt.widgets.Event event)
public void clearSelection()
Note: To clear the selected items in the receiver's list,
use deselectAll().
org.eclipse.swt.SWTException - deselectAll()void comboEvent(org.eclipse.swt.widgets.Event event)
public org.eclipse.swt.graphics.Point computeSize(int wHint,
int hHint,
boolean changed)
computeSize in class org.eclipse.swt.widgets.Composite
void createPopup(java.lang.String[] items,
int selectionIndex)
public void deselect(int index)
index - the index of the item to deselect
org.eclipse.swt.SWTException - public void deselectAll()
Note: To clear the selection in the receiver's text field,
use clearSelection().
org.eclipse.swt.SWTException - clearSelection()public void dropDown(boolean drop)
char _findMnemonic(java.lang.String string)
org.eclipse.swt.widgets.Label getAssociatedLabel()
public org.eclipse.swt.widgets.Control[] getChildren()
getChildren in class org.eclipse.swt.widgets.Compositepublic boolean getEditable()
org.eclipse.swt.SWTException - public java.lang.String getItem(int index)
index - the index of the item to return
java.lang.IllegalArgumentException - org.eclipse.swt.SWTException - public int getItemCount()
org.eclipse.swt.SWTException - public int getItemHeight()
org.eclipse.swt.SWTException - public java.lang.String[] getItems()
Strings which are the items
in the receiver's list.
Note: This is not the actual structure used by the receiver to maintain its list of items, so modifying the array will not affect the receiver.
org.eclipse.swt.SWTException - public org.eclipse.swt.widgets.Menu getMenu()
getMenu in class org.eclipse.swt.widgets.Controlpublic org.eclipse.swt.graphics.Point getSelection()
Point whose x coordinate is the start
of the selection in the receiver's text field, and whose y
coordinate is the end of the selection. The returned values
are zero-relative. An "empty" selection as indicated by
the the x and y coordinates having the same value.
org.eclipse.swt.SWTException - public int getSelectionIndex()
org.eclipse.swt.SWTException - public int getStyle()
getStyle in class org.eclipse.swt.widgets.Widgetpublic java.lang.String getText()
org.eclipse.swt.SWTException - public int getTextHeight()
org.eclipse.swt.SWTException - public int getTextLimit()
setTextLimit(), it will be the constant
Combo.LIMIT.
org.eclipse.swt.SWTException - public int getVisibleItemCount()
org.eclipse.swt.SWTException - void handleFocus(int type)
public int indexOf(java.lang.String string)
string - the search item
java.lang.IllegalArgumentException - org.eclipse.swt.SWTException -
public int indexOf(java.lang.String string,
int start)
string - the search itemstart - the zero-relative index at which to begin the search
java.lang.IllegalArgumentException - org.eclipse.swt.SWTException - void initAccessible()
public boolean isDropped()
public boolean isFocusControl()
isFocusControl in class org.eclipse.swt.widgets.Controlvoid internalLayout(boolean changed)
void listEvent(org.eclipse.swt.widgets.Event event)
void popupEvent(org.eclipse.swt.widgets.Event event)
public void redraw()
redraw in class org.eclipse.swt.widgets.Control
public void redraw(int x,
int y,
int width,
int height,
boolean all)
redraw in class org.eclipse.swt.widgets.Controlpublic void remove(int index)
index - the index for the item
java.lang.IllegalArgumentException - org.eclipse.swt.SWTException -
public void remove(int start,
int end)
start - the start of the rangeend - the end of the range
java.lang.IllegalArgumentException - org.eclipse.swt.SWTException - public void remove(java.lang.String string)
string - the item to remove
java.lang.IllegalArgumentException - org.eclipse.swt.SWTException - public void removeAll()
org.eclipse.swt.SWTException - public void removeModifyListener(org.eclipse.swt.events.ModifyListener listener)
listener - the listener which should no longer be notified
java.lang.IllegalArgumentException - org.eclipse.swt.SWTException - ModifyListener,
addModifyListener(org.eclipse.swt.events.ModifyListener)public void removeSelectionListener(org.eclipse.swt.events.SelectionListener listener)
listener - the listener which should no longer be notified
java.lang.IllegalArgumentException - org.eclipse.swt.SWTException - SelectionListener,
addSelectionListener(org.eclipse.swt.events.SelectionListener)public void select(int index)
index - the index of the item to select
org.eclipse.swt.SWTException - public void setBackground(org.eclipse.swt.graphics.Color color)
setBackground in class org.eclipse.swt.widgets.Controlpublic void setEditable(boolean editable)
editable - the new editable state
org.eclipse.swt.SWTException - public void setEnabled(boolean enabled)
setEnabled in class org.eclipse.swt.widgets.Controlpublic boolean setFocus()
setFocus in class org.eclipse.swt.widgets.Compositepublic void setFont(org.eclipse.swt.graphics.Font font)
setFont in class org.eclipse.swt.widgets.Controlpublic void setForeground(org.eclipse.swt.graphics.Color color)
setForeground in class org.eclipse.swt.widgets.Control
public void setItem(int index,
java.lang.String string)
remove'ing the old item at the index, and then
add'ing the new item at that index.
index - the index for the itemstring - the new text for the item
java.lang.IllegalArgumentException - org.eclipse.swt.SWTException - public void setItems(java.lang.String[] items)
items - the array of items
java.lang.IllegalArgumentException - org.eclipse.swt.SWTException - public void setLayout(org.eclipse.swt.widgets.Layout layout)
Note: No Layout can be set on this Control because it already manages the size and position of its children.
setLayout in class org.eclipse.swt.widgets.Compositelayout - the receiver's new layout or null
org.eclipse.swt.SWTException - public void setMenu(org.eclipse.swt.widgets.Menu menu)
setMenu in class org.eclipse.swt.widgets.Controlpublic void setSelection(org.eclipse.swt.graphics.Point selection)
selection - a point representing the new selection start and end
java.lang.IllegalArgumentException - org.eclipse.swt.SWTException - public void setText(java.lang.String string)
Note: The text field in a Combo is typically
only capable of displaying a single line of text. Thus,
setting the text to a string containing line breaks or
other special characters will probably cause it to
display incorrectly.
string - the new text
java.lang.IllegalArgumentException - org.eclipse.swt.SWTException - public void setTextLimit(int limit)
limit - new text limit
java.lang.IllegalArgumentException - org.eclipse.swt.SWTException - public void setToolTipText(java.lang.String string)
setToolTipText in class org.eclipse.swt.widgets.Controlpublic void setVisible(boolean visible)
setVisible in class org.eclipse.swt.widgets.Controlpublic void setVisibleItemCount(int count)
count - the new number of items to be visible
org.eclipse.swt.SWTException - java.lang.String stripMnemonic(java.lang.String string)
void textEvent(org.eclipse.swt.widgets.Event event)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||