|
Elexis API documentationVersion 2.1.6 as of December 11 2011 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectComposite
ch.marlovits.plz.MCCombo2
public final class MCCombo2
Constructor Summary | |
---|---|
MCCombo2(Composite parent,
int style)
new methods for this new Composite END |
Method Summary | |
---|---|
void |
add(java.lang.String[] strings)
Adds the argument to the end of the receiver's list. |
void |
add(java.lang.String[] strings,
int index)
Adds the argument to the receiver's list at the given zero-relative index. |
void |
addModifyListener(ModifyListener listener)
Adds the 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(SelectionListener listener)
Adds the listener to the collection of listeners who will be notified when the user changes the receiver's selection, by sending it one of the messages defined in the SelectionListener
interface. |
void |
addVerifyListener(VerifyListener listener)
Adds the listener to the collection of listeners who will be notified when the receiver's text is verified, by sending it one of the messages defined in the VerifyListener
interface. |
void |
clearSelection()
Sets the selection in the receiver's text field to an empty selection starting just before the first character. |
Point |
computeSize(int wHint,
int hHint,
boolean changed)
|
Point |
computeSize(int listIx,
int wHint,
int hHint,
boolean changed)
calc comboBox field size: loop through items, find widest string (in pixels) |
void |
copy()
Copies the selected text. |
void |
cut()
Cuts the selected text. |
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. |
Control[] |
getChildren()
|
int |
getColumnLeftMargin()
|
int |
getColumnRightMargin()
|
int |
getColumnSpacing()
|
Color |
getDividerLineColor()
|
boolean |
getDrawDividerLines()
|
boolean |
getEditable()
Gets the editable state. |
java.lang.String[] |
getItem(int rowIx)
|
java.lang.String |
getItem(int columnIx,
int rowIx)
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. |
java.lang.String[] |
getItems(int columnIx)
|
boolean |
getListVisible()
Returns true if the receiver's list is visible,
and |
Menu |
getMenu()
|
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. |
int |
indexOf(int columnIx,
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(int columnIx,
java.lang.String string,
int start)
|
int |
indexOf(java.lang.String string)
|
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. |
boolean |
isFocusControl()
|
void |
paste()
Pastes text from clipboard. |
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(int columnIx,
java.lang.String string)
|
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(ModifyListener listener)
Removes the listener from the collection of listeners who will be notified when the receiver's text is modified. |
void |
removeSelectionListener(SelectionListener listener)
Removes the listener from the collection of listeners who will be notified when the user changes the receiver's selection. |
void |
removeVerifyListener(VerifyListener listener)
Removes the listener from the collection of listeners who will be notified when the control is verified. |
void |
select(int index)
Selects the item at the given zero-relative index in the receiver's list. |
void |
setBackground(Color color)
|
void |
setColumnLeftMargin(int newLeftMargin)
|
void |
setColumnRightMargin(int newRightMargin)
|
void |
setColumnSpacing(int colSpacing)
|
void |
setDividerLineColor(Color newColor)
|
void |
setDividerLineColor(int newColor)
|
void |
setDrawDividerLines(boolean doDrawDividerLines)
new methods for this new Composite START |
void |
setEditable(boolean editable)
Sets the editable state. |
void |
setEnabled(boolean enabled)
|
boolean |
setFocus()
|
void |
setFont(Font font)
|
void |
setForeground(Color color)
|
void |
setItem(int columnIx,
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 |
setItem(int index,
java.lang.String[] items)
|
void |
setItems(int columnIx,
java.lang.String[] items)
Sets the receiver's list to be the given array of items. |
void |
setItems(java.lang.String[][] items)
|
void |
setLayout(Layout layout)
Sets the layout which is associated with the receiver to be the argument which may be null. |
void |
setListVisible(boolean visible)
Marks the receiver's list as visible if the argument is true,
and marks it invisible otherwise. |
void |
setMenu(Menu menu)
|
void |
setSelection(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. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MCCombo2(Composite parent, int style)
Method Detail |
---|
public void setDrawDividerLines(boolean doDrawDividerLines)
public boolean getDrawDividerLines()
public void setDividerLineColor(int newColor)
public void setDividerLineColor(Color newColor)
public Color getDividerLineColor()
public void setColumnSpacing(int colSpacing)
public int getColumnSpacing()
public void setColumnLeftMargin(int newLeftMargin)
public int getColumnLeftMargin()
public void setColumnRightMargin(int newRightMargin)
public int getColumnRightMargin()
public void add(java.lang.String[] strings)
string
- the new item
java.lang.IllegalArgumentException
- SWTException
- #add(String,int)
public void add(java.lang.String[] strings, 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
- SWTException
- #add(String)
public void addModifyListener(ModifyListener listener)
ModifyListener
interface.
- Parameters:
listener
- the listener which should be notified
- Throws:
java.lang.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
- See Also:
ModifyListener
,
removeModifyListener(ModifyListener)
public void addSelectionListener(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.
- Parameters:
listener
- the listener which should be notified when the user changes the receiver's
selection
- Throws:
java.lang.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
- See Also:
SelectionListener
,
removeSelectionListener(SelectionListener)
,
SelectionEvent
public void addVerifyListener(VerifyListener listener)
VerifyListener
interface.
- Parameters:
listener
- the listener which should be notified
- Throws:
java.lang.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:
- 3.3
- See Also:
VerifyListener
,
removeVerifyListener(VerifyListener)
public void clearSelection()
Note: To clear the selected items in the receiver's list, use deselectAll().
SWTException
- deselectAll()
public Point computeSize(int listIx, int wHint, int hHint, boolean changed)
public Point computeSize(int wHint, int hHint, boolean changed)
public void copy()
The current selection is copied to the clipboard.
SWTException
- public void cut()
The current selection is first copied to the clipboard and then deleted from the widget.
SWTException
- public void deselect(int index)
index
- the index of the item to deselect
SWTException
- public void deselectAll()
Note: To clear the selection in the receiver's text field, use clearSelection().
SWTException
- clearSelection()
public Control[] getChildren()
public boolean getEditable()
SWTException
- public java.lang.String getItem(int columnIx, int rowIx)
index
- the index of the item to return
java.lang.IllegalArgumentException
- SWTException
- public java.lang.String[] getItem(int rowIx)
public int getItemCount()
SWTException
- public int getItemHeight()
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.
- Returns:
- the items in the receiver's list
- 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
public java.lang.String[] getItems(int columnIx)
public boolean getListVisible()
true if the receiver's list 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.
- Returns:
- the receiver's list's visibility state
- 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:
- 3.4
public Menu getMenu()
public 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.
- Returns:
- a point representing the selection start and end
- 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
public int getSelectionIndex()
SWTException
- public int getStyle()
public java.lang.String getText()
SWTException
- public int getTextHeight()
SWTException
- public int getTextLimit()
setTextLimit(), it will be the constant
Combo.LIMIT.
- Returns:
- the text limit
- 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
public int getVisibleItemCount()
SWTException
- public int indexOf(int columnIx, java.lang.String string)
string
- the search item
java.lang.IllegalArgumentException
- SWTException
- public int indexOf(java.lang.String string)
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
- SWTException
- public int indexOf(int columnIx, java.lang.String string, int start)
public boolean isFocusControl()
public void paste()
The selected text is deleted from the widget and new text inserted from the clipboard.
SWTException
- public void redraw()
public void redraw(int x, int y, int width, int height, boolean all)
public void remove(int index)
index
- the index for the item
java.lang.IllegalArgumentException
- SWTException
- public void remove(int start, int end)
start
- the start of the rangeend
- the end of the range
java.lang.IllegalArgumentException
- SWTException
- public void remove(java.lang.String string)
string
- the item to remove
java.lang.IllegalArgumentException
- SWTException
- public void remove(int columnIx, java.lang.String string)
public void removeAll()
SWTException
- public void removeModifyListener(ModifyListener listener)
listener
- the listener which should no longer be notified
java.lang.IllegalArgumentException
- SWTException
- ModifyListener
,
addModifyListener(ModifyListener)
public void removeSelectionListener(SelectionListener listener)
listener
- the listener which should no longer be notified
java.lang.IllegalArgumentException
- SWTException
- SelectionListener
,
addSelectionListener(SelectionListener)
public void removeVerifyListener(VerifyListener listener)
listener
- the listener which should no longer be notified
java.lang.IllegalArgumentException
- SWTException
- VerifyListener
,
addVerifyListener(VerifyListener)
public void select(int index)
index
- the index of the item to select
SWTException
- public void setBackground(Color color)
public void setEditable(boolean editable)
editable
- the new editable state
SWTException
- public void setEnabled(boolean enabled)
public boolean setFocus()
public void setFont(Font font)
public void setForeground(Color color)
public void setItem(int columnIx, int index, java.lang.String string)
remove'ing the old item at the index, and then
add'ing the new item at that index.
- Parameters:
index
- the index for the itemstring
- the new text for the item
- Throws:
java.lang.IllegalArgumentException
- - ERROR_INVALID_RANGE - if the index is not between 0 and the number of
elements in the list minus 1 (inclusive)
- ERROR_NULL_ARGUMENT - if the
string 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
public void setItem(int index, java.lang.String[] items)
public void setItems(int columnIx, java.lang.String[] items)
items
- the array of items
java.lang.IllegalArgumentException
- SWTException
- public void setItems(java.lang.String[][] items)
public void setLayout(Layout layout)
Note: No Layout can be set on this Control because it already manages the size and position of its children.
layout
- the receiver's new layout or null
SWTException
- public void setListVisible(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.
- Parameters:
visible
- the new visibility state
- 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:
- 3.4
public void setMenu(Menu menu)
public void setSelection(Point selection)
selection
- a point representing the new selection start and end
java.lang.IllegalArgumentException
- 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
- SWTException
- public void setTextLimit(int limit)
limit
- new text limit
java.lang.IllegalArgumentException
- SWTException
- public void setToolTipText(java.lang.String string)
public void setVisible(boolean visible)
public void setVisibleItemCount(int count)
count
- the new number of items to be visible
SWTException
-
|
Elexis API documentationVersion 2.1.6 as of December 11 2011 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |