/*******************************************************************************
* Copyright (c) 2006 Sybase, Inc. and others.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Sybase, Inc. - initial API and implementation
*******************************************************************************/
package org.eclipse.jst.jsf.common.ui.internal.utils;
import java.util.Arrays;
import org.eclipse.jface.resource.JFaceResources;
import org.eclipse.swt.SWT;
import org.eclipse.swt.accessibility.ACC;
import org.eclipse.swt.accessibility.AccessibleAdapter;
import org.eclipse.swt.accessibility.AccessibleControlAdapter;
import org.eclipse.swt.accessibility.AccessibleControlEvent;
import org.eclipse.swt.accessibility.AccessibleEvent;
import org.eclipse.swt.accessibility.AccessibleTextAdapter;
import org.eclipse.swt.accessibility.AccessibleTextEvent;
import org.eclipse.swt.events.ModifyListener;
import org.eclipse.swt.events.SelectionListener;
import org.eclipse.swt.graphics.Color;
import org.eclipse.swt.graphics.Font;
import org.eclipse.swt.graphics.GC;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.graphics.Rectangle;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Layout;
import org.eclipse.swt.widgets.Listener;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.Table;
import org.eclipse.swt.widgets.TableColumn;
import org.eclipse.swt.widgets.TableItem;
import org.eclipse.swt.widgets.Text;
import org.eclipse.swt.widgets.TypedListener;
/**
* 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.
* <p>
* Note that although this class is a subclass of <code>Composite</code>, it
* does not make sense to add children to it, or set a layout on it.
* </p>
* <dl>
* <dt><b>Styles:</b>
* <dd>BORDER, READ_ONLY, FLAT</dd>
* <dt><b>Events:</b>
* <dd>Selection</dd>
* </dl>
*/
public final class StyleCombo extends Composite {
Text text;
Table table;
int visibleItemCount = 4;
Shell popup;
Button arrow;
boolean hasFocus;
Listener listener, filter;
Color foreground, background;
Font font;
String defaultValue;
/**
* Constructs a new instance of this class given its parent and a style
* value describing its behavior and appearance.
* <p>
* The style value is either one of the style constants defined in class
* <code>SWT</code> which is applicable to instances of this class, or
* must be built by <em>bitwise OR</em>'ing together (that is, using the
* <code>int</code> "|" operator) two or more of those <code>SWT</code>
* style constants. The class description lists the style constants that are
* applicable to the class. Style bits are also inherited from superclasses.
* </p>
*
* @param parent
* a widget which will be the parent of the new instance (cannot
* be null)
* @param style
* the style of widget to construct
*
* @exception IllegalArgumentException
* <ul>
* <li>ERROR_NULL_ARGUMENT - if the parent is null</li>
* </ul>
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the parent</li>
* </ul>
*
* @see SWT#BORDER
* @see SWT#READ_ONLY
* @see SWT#FLAT
*/
public StyleCombo(Composite parent, int style) {
super(parent, style = checkStyle(style));
listener = new Listener() {
public void handleEvent(Event event) {
if (popup == event.widget) {
popupEvent(event);
return;
}
if (text == event.widget) {
textEvent(event);
return;
}
if (table == event.widget) {
tableEvent(event);
return;
}
if (arrow == event.widget) {
arrowEvent(event);
return;
}
if (StyleCombo.this == event.widget) {
comboEvent(event);
return;
}
if (getShell() == event.widget) {
handleFocus(SWT.FocusOut);
}
}
};
filter = new Listener() {
public void handleEvent(Event event) {
Shell shell = ((Control) event.widget).getShell();
if (shell == StyleCombo.this.getShell()) {
handleFocus(SWT.FocusOut);
}
}
};
int[] comboEvents = { SWT.Dispose, SWT.Move, SWT.Resize };
for (int i = 0; i < comboEvents.length; i++)
this.addListener(comboEvents[i], listener);
createText(style);
createArrow(style);
createPopup(null, -1);
initAccessible();
}
/**
* @param style
*/
private void createArrow(int style) {
int arrowStyle = SWT.ARROW | SWT.DOWN;
if ((style & SWT.FLAT) != 0) {
arrowStyle |= SWT.FLAT;
}
arrow = new Button(this, arrowStyle);
int[] arrowEvents = { SWT.Selection, SWT.FocusIn };
for (int i = 0; i < arrowEvents.length; i++) {
arrow.addListener(arrowEvents[i], listener);
}
}
/**
* @param style
*/
private void createText(int style) {
int textStyle = SWT.SINGLE;
if ((style & SWT.READ_ONLY) != 0) {
textStyle |= SWT.READ_ONLY;
}
if ((style & SWT.FLAT) != 0) {
textStyle |= SWT.FLAT;
}
text = new Text(this, textStyle);
int[] textEvents = { SWT.KeyDown, SWT.KeyUp, SWT.Modify, SWT.MouseDown,
SWT.MouseUp, SWT.Traverse, SWT.FocusIn };
for (int i = 0; i < textEvents.length; i++) {
text.addListener(textEvents[i], listener);
}
}
static int checkStyle(int style) {
int mask = SWT.BORDER | SWT.READ_ONLY | SWT.FLAT | SWT.LEFT_TO_RIGHT
| SWT.RIGHT_TO_LEFT;
return style & mask;
}
/**
* Adds the argument to the end of the receiver's list.
*
* @param string
* the new item
*
* @exception IllegalArgumentException
* <ul>
* <li>ERROR_NULL_ARGUMENT - if the string is null</li>
* </ul>
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*
* @see #add(String,int)
*/
public void add(String string) {
checkWidget();
if (string == null) {
SWT.error(SWT.ERROR_NULL_ARGUMENT);
}
TableItem item = new TableItem(table, SWT.NONE);
item.setText(0, string);
}
/**
* Adds the argument to the receiver's list at the given zero-relative
* index.
* <p>
* Note: To add an item at the end of the list, use the result of calling
* <code>getItemCount()</code> as the index or use
* <code>add(String)</code>.
* </p>
*
* @param string
* the new item
* @param index
* the index for the item
*
* @exception IllegalArgumentException
* <ul>
* <li>ERROR_NULL_ARGUMENT - if the string is null</li>
* <li>ERROR_INVALID_RANGE - if the index is not between 0
* and the number of elements in the list (inclusive)</li>
* </ul>
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*
* @see #add(String)
*/
public void add(String string, int index) {
checkWidget();
if (string == null) {
SWT.error(SWT.ERROR_NULL_ARGUMENT);
}
TableItem item = new TableItem(table, SWT.NONE, index);
item.setText(0, string);
}
/**
* 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 <code>ModifyListener</code> interface.
*
* @param listener1
* the listener which should be notified
*
* @exception IllegalArgumentException
* <ul>
* <li>ERROR_NULL_ARGUMENT - if the listener is null</li>
* </ul>
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*
* @see ModifyListener
* @see #removeModifyListener
*/
public void addModifyListener(ModifyListener listener1) {
checkWidget();
if (listener1 == null) {
SWT.error(SWT.ERROR_NULL_ARGUMENT);
}
TypedListener typedListener = new TypedListener(listener1);
addListener(SWT.Modify, typedListener);
}
/**
* 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 <code>SelectionListener</code> interface.
* <p>
* <code>widgetSelected</code> is called when the combo's list selection
* changes. <code>widgetDefaultSelected</code> is typically called when
* ENTER is pressed the combo's text area.
* </p>
*
* @param listener1
* the listener which should be notified
*
* @exception IllegalArgumentException
* <ul>
* <li>ERROR_NULL_ARGUMENT - if the listener is null</li>
* </ul>
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*
* @see SelectionListener
* @see #removeSelectionListener
*/
public void addSelectionListener(SelectionListener listener1) {
checkWidget();
if (listener1 == null) {
SWT.error(SWT.ERROR_NULL_ARGUMENT);
}
TypedListener typedListener = new TypedListener(listener1);
addListener(SWT.Selection, typedListener);
addListener(SWT.DefaultSelection, typedListener);
}
void arrowEvent(Event event) {
switch (event.type) {
case SWT.FocusIn: {
handleFocus(SWT.FocusIn);
break;
}
case SWT.Selection: {
dropDown(!isDropped());
break;
}
}
}
/**
* Sets the selection in the receiver's text field to an empty selection
* starting just before the first character. If the text field is editable,
* this has the effect of placing the i-beam at the start of the text.
* <p>
* Note: To clear the selected items in the receiver's list, use
* <code>deselectAll()</code>.
* </p>
*
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*
* @see #deselectAll
*/
public void clearSelection() {
checkWidget();
text.clearSelection();
table.deselectAll();
}
void comboEvent(Event event) {
switch (event.type) {
case SWT.Dispose:
if (popup != null && !popup.isDisposed()) {
table.removeListener(SWT.Dispose, listener);
popup.dispose();
}
Shell shell = getShell();
shell.removeListener(SWT.Deactivate, listener);
Display display = getDisplay();
display.removeFilter(SWT.FocusIn, filter);
popup = null;
text = null;
table = null;
arrow = null;
break;
case SWT.Move:
dropDown(false);
break;
case SWT.Resize:
internalLayout(false);
break;
}
}
private String[] getTableItems() {
TableItem[] items = table.getItems();
String[] values = new String[items.length];
for (int i = 0; i < items.length; i++) {
values[i] = items[i].getText(0);
}
return values;
}
public Point computeSize(int wHint, int hHint, boolean changed) {
checkWidget();
int width = 0, height = 0;
String[] items = getTableItems();
int textWidth = 0;
GC gc = new GC(text);
int spacer = gc.stringExtent(" ").x; //$NON-NLS-1$
for (int i = 0; i < items.length; i++) {
textWidth = Math.max(gc.stringExtent(items[i]).x, textWidth);
}
gc.dispose();
Point textSize = text.computeSize(SWT.DEFAULT, SWT.DEFAULT, changed);
Point arrowSize = arrow.computeSize(SWT.DEFAULT, SWT.DEFAULT, changed);
Point listSize = table.computeSize(wHint, SWT.DEFAULT, changed);
int borderWidth = getBorderWidth();
height = Math.max(hHint, Math.max(textSize.y, arrowSize.y) + 2
* borderWidth);
width = Math.max(wHint, Math.max(textWidth + 2 * spacer + arrowSize.x
+ 2 * borderWidth, listSize.x));
return new Point(width, height);
}
void createPopup(String[] items, int selectionIndex) {
// create shell and list
popup = new Shell(getShell(), SWT.NO_TRIM | SWT.ON_TOP);
table = new Table(popup, SWT.SINGLE | SWT.V_SCROLL | SWT.FULL_SELECTION);
new TableColumn(table, SWT.LEFT);
if (font != null) {
table.setFont(font);
}
if (foreground != null) {
table.setForeground(foreground);
}
if (background != null) {
table.setBackground(background);
}
int[] popupEvents = { SWT.Close, SWT.Paint, SWT.Deactivate };
for (int i = 0; i < popupEvents.length; i++) {
popup.addListener(popupEvents[i], listener);
}
int[] listEvents = { SWT.MouseUp, SWT.Selection, SWT.Traverse,
SWT.KeyDown, SWT.KeyUp, SWT.FocusIn, SWT.FocusOut, SWT.Dispose };
for (int i = 0; i < listEvents.length; i++) {
table.addListener(listEvents[i], listener);
}
if (items != null) {
setItems(items);
}
if (selectionIndex != -1) {
select(selectionIndex);
}
}
/**
* Deselects the item at the given zero-relative index in the receiver's
* list. If the item at the index was already deselected, it remains
* deselected. Indices that are out of range are ignored.
*
* @param index
* the index of the item to deselect
*
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*/
public void deselect(int index) {
checkWidget();
table.deselect(index);
}
/**
* Deselects all selected items in the receiver's list.
* <p>
* Note: To clear the selection in the receiver's text field, use
* <code>clearSelection()</code>.
* </p>
*
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*
* @see #clearSelection
*/
public void deselectAll() {
checkWidget();
table.deselectAll();
}
void dropDown(boolean drop) {
if (drop == isDropped()) {
return;
}
if (!drop) {
popup.setVisible(false);
table.getColumns()[0].setWidth(0);
if (!isDisposed() && arrow.isFocusControl()) {
text.setFocus();
}
return;
}
if (getShell() != popup.getParent()) {
String[] items = getTableItems();
int selectionIndex = table.getSelectionIndex();
table.removeListener(SWT.Dispose, listener);
popup.dispose();
popup = null;
table = null;
createPopup(items, selectionIndex);
}
Point size = getSize();
int itemCount = table.getItemCount();
itemCount = (itemCount == 0) ? visibleItemCount : Math.min(
visibleItemCount, itemCount);
int itemHeight = table.getItemHeight() * itemCount;
Point tableSize = table.computeSize(SWT.DEFAULT, itemHeight, false);
// int tableWidth = this.getClientArea()
table.setBounds(1, 1, Math.max(size.x - 2, tableSize.x), tableSize.y
- table.getHorizontalBar().getSize().y + 2);
int index = table.getSelectionIndex();
if (index != -1) {
table.setTopIndex(index);
}
Display display = getDisplay();
Rectangle tableRect = table.getBounds();
Rectangle parentRect = display.map(getParent(), null, getBounds());
Point comboSize = getSize();
Rectangle displayRect = getMonitor().getClientArea();
int width = Math.max(comboSize.x, tableRect.width + 2);
int height = tableRect.height + 2;
int x = parentRect.x;
int y = parentRect.y + comboSize.y;
if (y + height > displayRect.y + displayRect.height) {
y = parentRect.y - height;
}
popup.setBounds(x, y, width, height);
popup.setVisible(true);
if (table.getItemCount() > visibleItemCount) {
table.getColumns()[0].setWidth(text.getSize().x - 2);
} else {
table.getColumns()[0].setWidth(table.getClientArea().width);
}
table.setFocus();
}
/*
* Return the Label immediately preceding the receiver in the z-order, or
* null if none.
*/
Label getAssociatedLabel() {
Control[] siblings = getParent().getChildren();
for (int i = 0; i < siblings.length; i++) {
if (siblings[i] == StyleCombo.this) {
if (i > 0 && siblings[i - 1] instanceof Label) {
return (Label) siblings[i - 1];
}
}
}
return null;
}
public Control[] getChildren() {
checkWidget();
return new Control[0];
}
/**
* Gets the editable state.
*
* @return whether or not the reciever is editable
*
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*
* @since 3.0
*/
public boolean getEditable() {
checkWidget();
return text.getEditable();
}
/**
* Returns the item at the given, zero-relative index in the receiver's
* list. Throws an exception if the index is out of range.
*
* @param index
* the index of the item to return
* @return the item at the given index
*
* @exception IllegalArgumentException
* <ul>
* <li>ERROR_INVALID_RANGE - if the index is not between 0
* and the number of elements in the list minus 1 (inclusive)</li>
* </ul>
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*/
public String getItem(int index) {
checkWidget();
return table.getItem(index).getText(0);
}
/**
* Returns the number of items contained in the receiver's list.
*
* @return the number of items
*
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*/
public int getItemCount() {
checkWidget();
return table.getItemCount();
}
/**
* Returns the height of the area which would be used to display
* <em>one</em> of the items in the receiver's list.
*
* @return the height of one item
*
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*/
public int getItemHeight() {
checkWidget();
return table.getItemHeight();
}
/**
* Returns an array of <code>String</code>s which are the items in the
* receiver's list.
* <p>
* 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.
* </p>
*
* @return the items in the receiver's list
*
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*/
public String[] getItems() {
checkWidget();
return getTableItems();
}
char getMnemonic(String string) {
int index = 0;
int length = string.length();
do {
while ((index < length) && (string.charAt(index) != '&')) {
index++;
}
if (++index >= length) {
return '\0';
}
if (string.charAt(index) != '&') {
return string.charAt(index);
}
index++;
} while (index < length);
return '\0';
}
/**
* Returns a <code>Point</code> 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.
*
* @return a point representing the selection start and end
*
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*/
public Point getSelection() {
checkWidget();
return text.getSelection();
}
/**
* Returns the zero-relative index of the item which is currently selected
* in the receiver's list, or -1 if no item is selected.
*
* @return the index of the selected item
*
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*/
public int getSelectionIndex() {
checkWidget();
return table.getSelectionIndex();
}
public int getStyle() {
int style = super.getStyle();
style &= ~SWT.READ_ONLY;
if (!text.getEditable()) {
style |= SWT.READ_ONLY;
}
return style;
}
/**
* Returns a string containing a copy of the contents of the receiver's text
* field.
*
* @return the receiver's text
*
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*/
public String getText() {
checkWidget();
return text.getText();
}
/**
* Returns the height of the receivers's text field.
*
* @return the text height
*
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*/
public int getTextHeight() {
checkWidget();
return text.getLineHeight();
}
/**
* Returns the maximum number of characters that the receiver's text field
* is capable of holding. If this has not been changed by
* <code>setTextLimit()</code>, it will be the constant
* <code>Combo.LIMIT</code>.
*
* @return the text limit
*
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*/
public int getTextLimit() {
checkWidget();
return text.getTextLimit();
}
/**
* Gets the number of items that are visible in the drop down portion of the
* receiver's list.
*
* @return the number of items that are visible
*
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*
* @since 3.0
*/
public int getVisibleItemCount() {
checkWidget();
return visibleItemCount;
}
void handleFocus(int type) {
if (isDisposed()) {
return;
}
switch (type) {
case SWT.FocusIn: {
if (hasFocus) {
return;
}
if (getEditable()) {
text.selectAll();
}
hasFocus = true;
Shell shell = getShell();
shell.removeListener(SWT.Deactivate, listener);
shell.addListener(SWT.Deactivate, listener);
Display display = getDisplay();
display.removeFilter(SWT.FocusIn, filter);
display.addFilter(SWT.FocusIn, filter);
Event e = new Event();
notifyListeners(SWT.FocusIn, e);
break;
}
case SWT.FocusOut: {
if (!hasFocus) {
return;
}
Control focusControl = getDisplay().getFocusControl();
if (focusControl == arrow || focusControl == table
|| focusControl == text) {
return;
}
hasFocus = false;
Shell shell = getShell();
shell.removeListener(SWT.Deactivate, listener);
Display display = getDisplay();
display.removeFilter(SWT.FocusIn, filter);
Event e = new Event();
notifyListeners(SWT.FocusOut, e);
break;
}
}
}
/**
* 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. If no item is found, returns -1.
*
* @param string
* the search item
* @return the index of the item
*
* @exception IllegalArgumentException
* <ul>
* <li>ERROR_NULL_ARGUMENT - if the string is null</li>
* </ul>
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*/
public int indexOf(String string) {
checkWidget();
if (string == null) {
SWT.error(SWT.ERROR_NULL_ARGUMENT);
}
return Arrays.asList(getTableItems()).indexOf(string);
}
/**
* 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. If no item is found or the starting index is out of
* range, returns -1.
*
* @param string
* the search item
* @param start
* the zero-relative index at which to begin the search
* @return the index of the item
*
* @exception IllegalArgumentException
* <ul>
* <li>ERROR_NULL_ARGUMENT - if the string is null</li>
* </ul>
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*/
public int indexOf(String string, int start) {
checkWidget();
if (string == null) {
SWT.error(SWT.ERROR_NULL_ARGUMENT);
}
String[] items = getTableItems();
for (int i = start; i < items.length; i++) {
if (items[i].equals(string)) {
return i;
}
}
return -1;
}
void initAccessible() {
AccessibleAdapter accessibleAdapter = new AccessibleAdapter() {
public void getName(AccessibleEvent e) {
String name = null;
Label label = getAssociatedLabel();
if (label != null) {
name = stripMnemonic(label.getText());
}
e.result = name;
}
public void getKeyboardShortcut(AccessibleEvent e) {
String shortcut = null;
Label label = getAssociatedLabel();
if (label != null) {
String text1 = label.getText();
if (text1 != null) {
char mnemonic = getMnemonic(text1);
if (mnemonic != '\0') {
shortcut = "Alt+" + mnemonic; //$NON-NLS-1$
}
}
}
e.result = shortcut;
}
public void getHelp(AccessibleEvent e) {
e.result = getToolTipText();
}
};
getAccessible().addAccessibleListener(accessibleAdapter);
text.getAccessible().addAccessibleListener(accessibleAdapter);
table.getAccessible().addAccessibleListener(accessibleAdapter);
arrow.getAccessible().addAccessibleListener(new AccessibleAdapter() {
public void getName(AccessibleEvent e) {
e.result = isDropped() ? SWT.getMessage("SWT_Close") : SWT.getMessage("SWT_Open"); //$NON-NLS-1$ //$NON-NLS-2$
}
public void getKeyboardShortcut(AccessibleEvent e) {
e.result = "Alt+Down Arrow"; //$NON-NLS-1$
}
public void getHelp(AccessibleEvent e) {
e.result = getToolTipText();
}
});
getAccessible().addAccessibleTextListener(new AccessibleTextAdapter() {
public void getCaretOffset(AccessibleTextEvent e) {
e.offset = text.getCaretPosition();
}
});
getAccessible().addAccessibleControlListener(
new AccessibleControlAdapter() {
public void getChildAtPoint(AccessibleControlEvent e) {
Point testPoint = toControl(e.x, e.y);
if (getBounds().contains(testPoint)) {
e.childID = ACC.CHILDID_SELF;
}
}
public void getLocation(AccessibleControlEvent e) {
Rectangle location = getBounds();
Point pt = toDisplay(location.x, location.y);
e.x = pt.x;
e.y = pt.y;
e.width = location.width;
e.height = location.height;
}
public void getChildCount(AccessibleControlEvent e) {
e.detail = 0;
}
public void getRole(AccessibleControlEvent e) {
e.detail = ACC.ROLE_COMBOBOX;
}
public void getState(AccessibleControlEvent e) {
e.detail = ACC.STATE_NORMAL;
}
public void getValue(AccessibleControlEvent e) {
e.result = getText();
}
});
text.getAccessible().addAccessibleControlListener(
new AccessibleControlAdapter() {
public void getRole(AccessibleControlEvent e) {
e.detail = text.getEditable() ? ACC.ROLE_TEXT
: ACC.ROLE_LABEL;
}
});
arrow.getAccessible().addAccessibleControlListener(
new AccessibleControlAdapter() {
public void getDefaultAction(AccessibleControlEvent e) {
e.result = isDropped() ? SWT.getMessage("SWT_Close") : SWT.getMessage("SWT_Open"); //$NON-NLS-1$ //$NON-NLS-2$
}
});
}
boolean isDropped() {
return popup.getVisible();
}
public boolean isFocusControl() {
checkWidget();
if (text.isFocusControl() || arrow.isFocusControl()
|| table.isFocusControl() || popup.isFocusControl()) {
return true;
}
return super.isFocusControl();
}
void internalLayout(boolean changed) {
if (isDropped()) {
dropDown(false);
}
Rectangle rect = getClientArea();
int width = rect.width;
int height = rect.height;
Point arrowSize = arrow.computeSize(SWT.DEFAULT, height, changed);
text.setBounds(0, 0, width - arrowSize.x, height);
arrow.setBounds(width - arrowSize.x, 0, arrowSize.x, arrowSize.y);
}
void tableEvent(Event event) {
switch (event.type) {
case SWT.Dispose:
if (getShell() != popup.getParent()) {
String[] items = getTableItems();
int selectionIndex = table.getSelectionIndex();
popup = null;
table = null;
createPopup(items, selectionIndex);
}
break;
case SWT.FocusIn: {
handleFocus(SWT.FocusIn);
break;
}
case SWT.MouseUp: {
if (event.button != 1) {
return;
}
dropDown(false);
break;
}
case SWT.Selection: {
int index = table.getSelectionIndex();
if (index == -1)
return;
text.setText(table.getItem(index).getText());
text.selectAll();
table.setSelection(index);
Event e = new Event();
e.time = event.time;
e.stateMask = event.stateMask;
e.doit = event.doit;
notifyListeners(SWT.Selection, e);
event.doit = e.doit;
break;
}
case SWT.Traverse: {
switch (event.detail) {
case SWT.TRAVERSE_RETURN:
case SWT.TRAVERSE_ESCAPE:
case SWT.TRAVERSE_ARROW_PREVIOUS:
case SWT.TRAVERSE_ARROW_NEXT:
event.doit = false;
break;
}
Event e = new Event();
e.time = event.time;
e.detail = event.detail;
e.doit = event.doit;
e.character = event.character;
e.keyCode = event.keyCode;
notifyListeners(SWT.Traverse, e);
event.doit = e.doit;
event.detail = e.detail;
break;
}
case SWT.KeyUp: {
Event e = new Event();
e.time = event.time;
e.character = event.character;
e.keyCode = event.keyCode;
e.stateMask = event.stateMask;
notifyListeners(SWT.KeyUp, e);
break;
}
case SWT.KeyDown: {
if (event.character == SWT.ESC) {
// Escape key cancels popup list
dropDown(false);
}
if ((event.stateMask & SWT.ALT) != 0
&& (event.keyCode == SWT.ARROW_UP || event.keyCode == SWT.ARROW_DOWN)) {
dropDown(false);
}
if (event.character == SWT.CR) {
// Enter causes default selection
dropDown(false);
Event e = new Event();
e.time = event.time;
e.stateMask = event.stateMask;
notifyListeners(SWT.DefaultSelection, e);
}
// At this point the widget may have been disposed.
// If so, do not continue.
if (isDisposed()) {
break;
}
Event e = new Event();
e.time = event.time;
e.character = event.character;
e.keyCode = event.keyCode;
e.stateMask = event.stateMask;
notifyListeners(SWT.KeyDown, e);
break;
}
}
}
void popupEvent(Event event) {
switch (event.type) {
case SWT.Paint:
// draw black rectangle around list
Rectangle listRect = table.getBounds();
Color black = getDisplay().getSystemColor(SWT.COLOR_BLACK);
event.gc.setForeground(black);
event.gc.drawRectangle(0, 0, listRect.width + 1,
listRect.height + 1);
break;
case SWT.Close:
event.doit = false;
dropDown(false);
break;
case SWT.Deactivate:
dropDown(false);
break;
}
}
public void redraw() {
super.redraw();
text.redraw();
arrow.redraw();
if (popup.isVisible()) {
table.redraw();
}
}
public void redraw(int x, int y, int width, int height, boolean all) {
super.redraw(x, y, width, height, true);
}
/**
* Removes the item from the receiver's list at the given zero-relative
* index.
*
* @param index
* the index for the item
*
* @exception IllegalArgumentException
* <ul>
* <li>ERROR_INVALID_RANGE - if the index is not between 0
* and the number of elements in the list minus 1 (inclusive)</li>
* </ul>
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*/
public void remove(int index) {
checkWidget();
table.remove(index);
}
/**
* Removes the items from the receiver's list which are between the given
* zero-relative start and end indices (inclusive).
*
* @param start
* the start of the range
* @param end
* the end of the range
*
* @exception IllegalArgumentException
* <ul>
* <li>ERROR_INVALID_RANGE - if either the start or end are
* not between 0 and the number of elements in the list minus
* 1 (inclusive)</li>
* </ul>
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*/
public void remove(int start, int end) {
checkWidget();
table.remove(start, end);
}
/**
* 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.
*
* @param string
* the item to remove
*
* @exception IllegalArgumentException
* <ul>
* <li>ERROR_NULL_ARGUMENT - if the string is null</li>
* <li>ERROR_INVALID_ARGUMENT - if the string is not found
* in the list</li>
* </ul>
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*/
public void remove(String string) {
checkWidget();
if (string == null) {
SWT.error(SWT.ERROR_NULL_ARGUMENT);
}
int index = Arrays.asList(getTableItems()).indexOf(string);
table.remove(index);
}
/**
* Removes all of the items from the receiver's list and clear the contents
* of receiver's text field.
* <p>
*
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*/
public void removeAll() {
checkWidget();
text.setText(""); //$NON-NLS-1$
table.removeAll();
}
/**
* Removes the listener from the collection of listeners who will be
* notified when the receiver's text is modified.
*
* @param listener1
* the listener which should no longer be notified
*
* @exception IllegalArgumentException
* <ul>
* <li>ERROR_NULL_ARGUMENT - if the listener is null</li>
* </ul>
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*
* @see ModifyListener
* @see #addModifyListener
*/
public void removeModifyListener(ModifyListener listener1) {
checkWidget();
if (listener1 == null) {
SWT.error(SWT.ERROR_NULL_ARGUMENT);
}
removeListener(SWT.Modify, listener1);
}
/**
* Removes the listener from the collection of listeners who will be
* notified when the receiver's selection changes.
*
* @param listener1
* the listener which should no longer be notified
*
* @exception IllegalArgumentException
* <ul>
* <li>ERROR_NULL_ARGUMENT - if the listener is null</li>
* </ul>
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*
* @see SelectionListener
* @see #addSelectionListener
*/
public void removeSelectionListener(SelectionListener listener1) {
checkWidget();
if (listener1 == null) {
SWT.error(SWT.ERROR_NULL_ARGUMENT);
}
removeListener(SWT.Selection, listener1);
removeListener(SWT.DefaultSelection, listener1);
}
/**
* Selects the item at the given zero-relative index in the receiver's list.
* If the item at the index was already selected, it remains selected.
* Indices that are out of range are ignored.
*
* @param index
* the index of the item to select
*
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*/
public void select(int index) {
checkWidget();
if (index == -1) {
table.deselectAll();
text.setText(""); //$NON-NLS-1$
return;
}
if (0 <= index && index < table.getItemCount()) {
if (index != getSelectionIndex()) {
text.setText(table.getItem(index).getText());
text.selectAll();
table.select(index);
table.showSelection();
}
}
}
public void setBackground(Color color) {
super.setBackground(color);
background = color;
if (text != null) {
text.setBackground(color);
}
if (table != null) {
table.setBackground(color);
}
if (arrow != null) {
arrow.setBackground(color);
}
}
/**
* Sets the editable state.
*
* @param editable
* the new editable state
*
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*
* @since 3.0
*/
public void setEditable(boolean editable) {
checkWidget();
text.setEditable(editable);
}
public void setEnabled(boolean enabled) {
super.setEnabled(enabled);
if (popup != null) {
popup.setVisible(false);
}
if (text != null) {
text.setEnabled(enabled);
}
if (arrow != null) {
arrow.setEnabled(enabled);
}
}
public boolean setFocus() {
checkWidget();
return text.setFocus();
}
public void setFont(Font font) {
super.setFont(font);
this.font = font;
text.setFont(font);
table.setFont(font);
internalLayout(true);
}
public void setForeground(Color color) {
super.setForeground(color);
foreground = color;
if (text != null) {
text.setForeground(color);
}
if (table != null) {
table.setForeground(color);
}
if (arrow != null) {
arrow.setForeground(color);
}
}
/**
* Sets the text of the item in the receiver's list at the given
* zero-relative index to the string argument. This is equivalent to
* <code>remove</code>'ing the old item at the index, and then
* <code>add</code>'ing the new item at that index.
*
* @param index
* the index for the item
* @param string
* the new text for the item
*
* @exception IllegalArgumentException
* <ul>
* <li>ERROR_INVALID_RANGE - if the index is not between 0
* and the number of elements in the list minus 1 (inclusive)</li>
* <li>ERROR_NULL_ARGUMENT - if the string is null</li>
* </ul>
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*/
public void setItem(int index, String string) {
checkWidget();
table.getItem(index).setText(0, string);
}
/**
* Sets the receiver's list to be the given array of items.
*
* @param items
* the array of items
*
* @exception IllegalArgumentException
* <ul>
* <li>ERROR_NULL_ARGUMENT - if the items array is null</li>
* <li>ERROR_INVALID_ARGUMENT - if an item in the items
* array is null</li>
* </ul>
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*/
public void setItems(String[] items) {
checkWidget();
if (items == null) {
SWT.error(SWT.ERROR_NULL_ARGUMENT);
}
for (int i = 0; i < items.length; i++) {
TableItem item = new TableItem(table, SWT.NONE);
if (items[i].equals(defaultValue)) {
item.setFont(JFaceResources.getFontRegistry().getBold(
JFaceResources.DEFAULT_FONT));
}
item.setText(0, items[i]);
}
}
/**
* Sets the layout which is associated with the receiver to be the argument
* which may be null.
* <p>
* Note : No Layout can be set on this Control because it already manages
* the size and position of its children.
* </p>
*
* @param layout
* the receiver's new layout or null
*
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*/
public void setLayout(Layout layout) {
checkWidget();
return;
}
/**
* 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.
*
* @param selection
* a point representing the new selection start and end
*
* @exception IllegalArgumentException
* <ul>
* <li>ERROR_NULL_ARGUMENT - if the point is null</li>
* </ul>
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*/
public void setSelection(Point selection) {
checkWidget();
if (selection == null) {
SWT.error(SWT.ERROR_NULL_ARGUMENT);
}
text.setSelection(selection.x, selection.y);
}
/**
* Sets the contents of the receiver's text field to the given string.
* <p>
* Note: The text field in a <code>Combo</code> 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.
* </p>
*
* @param string
* the new text
*
* @exception IllegalArgumentException
* <ul>
* <li>ERROR_NULL_ARGUMENT - if the string is null</li>
* </ul>
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*/
public void setText(String string) {
checkWidget();
if (string == null) {
SWT.error(SWT.ERROR_NULL_ARGUMENT);
}
int index = Arrays.asList(getTableItems()).indexOf(string);
if (index == -1) {
table.deselectAll();
text.setText(string);
return;
}
text.setText(string);
text.selectAll();
table.setSelection(index);
table.showSelection();
}
/**
* Sets the maximum number of characters that the receiver's text field is
* capable of holding to be the argument.
*
* @param limit
* new text limit
*
* @exception IllegalArgumentException
* <ul>
* <li>ERROR_CANNOT_BE_ZERO - if the limit is zero</li>
* </ul>
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*/
public void setTextLimit(int limit) {
checkWidget();
text.setTextLimit(limit);
}
public void setToolTipText(String string) {
checkWidget();
super.setToolTipText(string);
arrow.setToolTipText(string);
text.setToolTipText(string);
}
public void setVisible(boolean visible) {
super.setVisible(visible);
if (!visible) {
popup.setVisible(false);
}
}
/**
* Sets the number of items that are visible in the drop down portion of the
* receiver's list.
*
* @param count
* the new number of items to be visible
*
* @exception org.eclipse.swt.SWTException
* <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver</li>
* </ul>
*
* @since 3.0
*/
public void setVisibleItemCount(int count) {
checkWidget();
if (count < 0) {
return;
}
visibleItemCount = count;
}
String stripMnemonic(String string) {
int index = 0;
int length = string.length();
do {
while ((index < length) && (string.charAt(index) != '&')) {
index++;
}
if (++index >= length) {
return string;
}
if (string.charAt(index) != '&') {
return string.substring(0, index - 1)
+ string.substring(index, length);
}
index++;
} while (index < length);
return string;
}
void textEvent(Event event) {
switch (event.type) {
case SWT.FocusIn: {
handleFocus(SWT.FocusIn);
break;
}
case SWT.KeyDown: {
if (event.character == SWT.CR) {
dropDown(false);
Event e = new Event();
e.time = event.time;
e.stateMask = event.stateMask;
notifyListeners(SWT.DefaultSelection, e);
}
// At this point the widget may have been disposed.
// If so, do not continue.
if (isDisposed()) {
break;
}
if (event.keyCode == SWT.ARROW_UP
|| event.keyCode == SWT.ARROW_DOWN) {
event.doit = false;
if ((event.stateMask & SWT.ALT) != 0) {
boolean dropped = isDropped();
text.selectAll();
if (!dropped) {
setFocus();
}
dropDown(!dropped);
break;
}
int oldIndex = getSelectionIndex();
if (event.keyCode == SWT.ARROW_UP) {
select(Math.max(oldIndex - 1, 0));
} else {
select(Math.min(oldIndex + 1, getItemCount() - 1));
}
if (oldIndex != getSelectionIndex()) {
Event e = new Event();
e.time = event.time;
e.stateMask = event.stateMask;
notifyListeners(SWT.Selection, e);
}
// At this point the widget may have been disposed.
// If so, do not continue.
if (isDisposed()) {
break;
}
}
// Further work : Need to add support for incremental search in
// pop up list as characters typed in text widget
Event e = new Event();
e.time = event.time;
e.character = event.character;
e.keyCode = event.keyCode;
e.stateMask = event.stateMask;
notifyListeners(SWT.KeyDown, e);
break;
}
case SWT.KeyUp: {
Event e = new Event();
e.time = event.time;
e.character = event.character;
e.keyCode = event.keyCode;
e.stateMask = event.stateMask;
notifyListeners(SWT.KeyUp, e);
break;
}
case SWT.Modify: {
table.deselectAll();
Event e = new Event();
e.time = event.time;
notifyListeners(SWT.Modify, e);
break;
}
case SWT.MouseDown: {
if (event.button != 1) {
return;
}
if (text.getEditable()) {
return;
}
boolean dropped = isDropped();
text.selectAll();
if (!dropped) {
setFocus();
}
dropDown(!dropped);
break;
}
case SWT.MouseUp: {
if (event.button != 1) {
return;
}
if (text.getEditable()) {
return;
}
text.selectAll();
break;
}
case SWT.Traverse: {
switch (event.detail) {
case SWT.TRAVERSE_RETURN:
case SWT.TRAVERSE_ARROW_PREVIOUS:
case SWT.TRAVERSE_ARROW_NEXT:
// The enter causes default selection and
// the arrow keys are used to manipulate the list contents so
// do not use them for traversal.
event.doit = false;
break;
}
Event e = new Event();
e.time = event.time;
e.detail = event.detail;
e.doit = event.doit;
e.character = event.character;
e.keyCode = event.keyCode;
notifyListeners(SWT.Traverse, e);
event.doit = e.doit;
event.detail = e.detail;
break;
}
}
}
/**
* @param defaultValue
*/
public void setDefaultValue(String defaultValue) {
this.defaultValue = defaultValue;
int index = Arrays.asList(getTableItems()).indexOf(defaultValue);
if (index != -1) {
table.getItem(index).setFont(
JFaceResources.getFontRegistry().getBold(
JFaceResources.DEFAULT_FONT));
}
}
}