/*******************************************************************************

 * Copyright (c) 2004 IBM Corp.

 * Portion Copyright (c) 2004, 2008 Nokia Corporation and/or its subsidiary(-ies).

 * 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:

 *     Mark Rogalski (IBM Corp.) - initial API specification

 *     Nokia Corporation - S60 implementation

 *     Nokia Corporation - QT implementation

 *******************************************************************************/

package org.eclipse.ercp.swt.mobile;

import org.eclipse.swt.SWT;

import org.eclipse.swt.widgets.Internal_PackageSupport;

import org.eclipse.swt.widgets.Scrollable;

import org.eclipse.swt.widgets.Composite;

import org.eclipse.swt.widgets.TypedListener;

import org.eclipse.swt.events.SelectionListener;

import org.eclipse.swt.graphics.Image;

import org.eclipse.swt.graphics.Point;

import org.eclipse.swt.graphics.Rectangle;

import org.eclipse.swt.internal.qt.ListUtils;

import org.eclipse.swt.internal.qt.OS;

import org.eclipse.swt.internal.qt.PackageProxy;

import org.eclipse.swt.internal.qt.WidgetState;

/**

 * Instances of this class represent a selectable user interface object that

 * displays a sorted list of text items. The items may be displayed in ascending

 * or descending order.

 * <p>

 * If the FILTER style is specified during construction, an assoicated label is

 * also displayed showing characters entered which are then used to filter the

 * list to show fewer items. The selection state of items filtered out of the

 * list is cleared.

 * <p>

 * IMPORTANT: This class is <em>not</em> intended to be subclassed.

 * 

 * <dl>

 * <dt><b>Styles: </b></dt>

 * <dd>SINGLE, MULTI, UP, DOWN</dd>

 * <p>

 * Note: Only one of SINGLE and MULTI may be specified. Only one of UP and DOWN

 * may be specified.

 * <p>

 * <dt><b>Mode Styles:</b></dt>

 * <dd>FILTER</dd>

 * <p>

 * <dt><b>Events: </b></dt>

 * <dd>Selection, DefaultSelection</dd>

 * </dl>

 */

public class SortedList extends Scrollable {

private int containerHandle;

private int layoutHandle;

private int editorHandle;

private int appHandle;

private boolean ignoreSelectionEvent = false;

private int keyEventDestination = 0;

private int firstFilteredIndex = -1;

private int lastFilteredIndex = -1;

private boolean filtering = false;

/**

 * constructor style specifying filter field should be displayed

 */

public static final int FILTER = 1;

static final class SortedListPackageProxy extends PackageProxy {

    public void createHandle(int index) {

        ((SortedList)w).createHandle(index);

    }

    public void deregister () {

        ((SortedList)w).deregister();

    }

    public void hookEvents() {

        ((SortedList)w).hookEvents();

    }

    public boolean qt_event_keypress( int widgetHandle, int key, int modifier, int character, int nativeScanCode ) {

        return ((SortedList)w).qt_event_keypress(widgetHandle, key, modifier, character, nativeScanCode);

    }

    public boolean qt_event_keyrelease( int widgetHandle, int key, int modifier, int character, int nativeScanCode ) {

        return ((SortedList)w).qt_event_keyrelease(widgetHandle, key, modifier, character, nativeScanCode);

    }

    public boolean qt_event_mouseButtonRelease(int widgetHandle, int button, int x, int y, int state, int buttons) {

        return ((SortedList)w).qt_event_mouseButtonRelease(widgetHandle, button, x, y, state, buttons);

    }

    public void qt_signal_list_itemActivated(int selectionHandle) {

        ((SortedList)w).qt_signal_list_itemActivated(selectionHandle);

    }

    public void qt_signal_list_itemDoubleClicked(int selectionHandle) {

        ((SortedList)w).qt_signal_list_itemDoubleClicked(selectionHandle);

    }

    public void qt_signal_list_itemSelectionChanged() {

        ((SortedList)w).qt_signal_list_itemSelectionChanged();

    }

    public void qt_signal_text_changed(String text) {

        ((SortedList)w).qt_signal_text_changed(text);

    }

    public void register() {

        ((SortedList)w).register();

    }

    public void releaseHandle() {

        ((SortedList)w).releaseHandle();

    }

    public void backgroundImageApplied(Image image) {

        ((SortedList)w).backgroundImageApplied(image);

    }

    public boolean _isFocusControl() {

        return ((SortedList)w)._isFocusControl();

    }

    public void setBackground() {

        ((SortedList)w).setBackground();

    }

    public void setTraversalFlags(int type, int key, int modifier, int character) {

        ((SortedList)w).setTraversalFlags(type, key, modifier, character);

    }

    public Point getPreferredClientAreaSize() {

        return ((SortedList)w).getPreferredClientAreaSize();

    }

}

/**

 * Construct a new instance of this class given its parent and a style value

 * describing its behavior and appearance.

 * <p>

 * The <code>style</code> 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. Style bits are also inherited from superclasses.

 * <code>SWT.UP</code> (the default) means the list is sorted so that

 * numbers go from low to high when the list is examined from top to bottom.

 * <code>SWT.DOWN</code> means the list is sorted so that numbers go from

 * high to low when examined from top to bottom.

 * 

 * @param parent

 *            a composite control which will be the parent of the new

 *            instance (cannot be null)

 * @param style

 *            the style of the control

 * 

 * @exception IllegalArgumentException

 *                <ul>

 *                <li>ERROR_NULL_ARGUMENT - if the parent is null</li>

 *                </ul>

 * @exception SWTException

 *                <ul>

 *                <li>ERROR_THREAD_INVALID_ACCESS - if not called from the

 *                thread that created the parent</li>

 *                </ul>

 * 

 * @see SWT#SINGLE

 * @see SWT#MULTI

 * @see SWT#UP

 * @see SWT#DOWN

 */

public SortedList(Composite parent, int style) {

    this(parent, checkStyle(style), 0);

}

/**

 * Construct a new instance of this class given its parent, a style value

 * describing its behavior and appearance, and a mode style describing

 * additional behavior modes.

 * <p>

 * The <code>style</code> 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. Style bits are also inherited from superclasses.

 * <code>SWT.UP</code> (the default) means the list is sorted so that

 * numbers go from low to high when the list is examined from top to bottom.

 * <code>SWT.DOWN</code> means the list is sorted so that numbers go from

 * high to low when examined from top to bottom.

 * 

 * The <code>modeStyle</code> may specify the class constant

 * <code>FILTER</code>. This style adds a text entry field to the widget

 * which does not receive focus, but will display characters entered while

 * the list has focus. These characters are used to filter the list items so

 * that fewer items are displayed in the list. The selection is cleared for

 * any items not shown as a result of filtering.

 * 

 * @param parent

 *            a composite control which will be the parent of the new

 *            instance (cannot be null)

 * @param style

 *            the style of the control

 * 

 * @param modeStyle

 *            the mode for the control

 * 

 * @exception IllegalArgumentException

 *                <ul>

 *                <li>ERROR_NULL_ARGUMENT - if the parent is null</li>

 *                </ul>

 * @exception SWTException

 *                <ul>

 *                <li>ERROR_THREAD_INVALID_ACCESS - if not called from the

 *                thread that created the parent</li>

 *                </ul>

 * 

 * @see SWT#SINGLE

 * @see SWT#MULTI

 * @see SWT#UP

 * @see SWT#DOWN

 * @see SortedList#FILTER

 */

public SortedList(Composite parent, int style, int modeStyle) {

    super(parent, checkStyle(style), modeStyle, new SortedListPackageProxy(), false);

    checkSubclass();

}

/**

 * Adds the argument to the receiver's list of items.

 * 

 * @param item

 *            text to be added to the list

 * 

 * @exception IllegalArgumentException

 *                <ul>

 *                <li>ERROR_NULL_ARGUMENT - if the item is null</li>

 *                </ul>

 * @exception 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 parent</li>

 *                </ul>

 * @exception SWTError

 *                <ul>

 *                <li>ERROR_ITEM_NOT_ADDED - if the operation fails because

 *                of an operating system failure</li>

 *                </ul>

 * 

 * @see SortedList#setItems(String[])

 * @see SortedList#remove

 * @see SortedList#removeAll()

 */

public void add(String item) {

    checkWidget();

    ListUtils.add(scrollAreaHandle(), item, null);

    sortList();

    ignoreSelectionEvent =true;

    filterList();

    ignoreSelectionEvent= false;

}

/**

 * 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.

 * <p>

 * <code>widgetSelected</code> is called when the selection changes. <br>

 * <code>widgetDefaultSelected</code> is typically called when selection is

 * finalized.

 * 

 * @param listener

 *            instance called when selection events occur

 * 

 * @exception IllegalArgumentException

 *                <ul>

 *                <li>ERROR_NULL_ARGUMENT - if the listener is null</li>

 *                </ul>

 * @exception 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 parent</li>

 *                </ul>

 * @exception SWTError

 *                <ul>

 *                <li>ERROR_ITEM_NOT_ADDED - if the operation fails because

 *                of an operating system failure</li>

 *                </ul>

 * 

 * @see ListBox#removeSelectionListener

 * @see SelectionListener

 */

public void addSelectionListener(SelectionListener listener) {

    checkWidget();

    if (listener == null) {

        SWT.error(SWT.ERROR_NULL_ARGUMENT);

    }

    TypedListener typedListener = new TypedListener(listener);

    addListener(SWT.Selection, typedListener);

    addListener(SWT.DefaultSelection, typedListener);

}

/**

 * Returns the text of the item currently focused in the receiver, or

 * <code>null</code> if no item has focus.

 * <p>

 * 

 * @return the text of the item with focus

 * 

 * @exception 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 parent</li>

 *                </ul>

 */

public String getFocus() {

    checkWidget();

    int handle = scrollAreaHandle();

    int index = ListUtils.getFocusIndex(handle);

    if (index != -1) {

        return ListUtils.getItem(handle, index);

    }

    else {

        return null;

    }

}

/**

 * Returns the height (in pixels) of the area which would be used to display

 * one of the items in the tree.

 * 

 * @return height in pixels

 * 

 * @exception 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 parent</li>

 *                </ul>

 * @exception SWTError

 *                <ul>

 *                <li>ERROR_CANNOT_GET_HEIGHT - if the operation fails

 *                because of an operating system failure</li>

 *                </ul>

 */

public int getItemHeight() {

    checkWidget();

    return ListUtils.getItemHeight(scrollAreaHandle());

}

/**

 * Returns an array of Strings of items that are currently selected in the

 * receiver.

 * 

 * @return array of selected items

 * 

 * @exception 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 parent</li>

 *                </ul>

 * @exception SWTError

 *                <ul>

 *                <li>ERROR_CANNOT_GET_SELECTION - if the operation fails

 *                because of an operating system failure</li>

 *                </ul>

 * 

 * @see SortedList#getSelectionCount

 */

public String[] getSelection() {

    checkWidget();

    return ListUtils.getSelection(scrollAreaHandle());

}

/**

 * Returns the number of items currently selected.

 * 

 * @return count of selected items

 * 

 * @exception 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 parent</li>

 *                </ul>

 * @exception SWTError

 *                <ul>

 *                <li>ERROR_CANNOT_GET_COUNT - if the operation fails

 *                because of an operating system failure</li>

 *                </ul>

 * 

 * @see SortedList#getSelection

 */

public int getSelectionCount() {

    checkWidget();

    return ListUtils.getSelectionCount(scrollAreaHandle());

}

/**

 * 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 item

 *            text of 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 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 parent</li>

 *                </ul>

 * @exception SWTError

 *                <ul>

 *                <li>ERROR_ITEM_NOT_REMOVED - if the operation fails

 *                because of an operating system failure</li>

 *                </ul>

 * 

 * @see SortedList#add(String)

 * @see SortedList#removeAll()

 */

public void remove(String item) {

    checkWidget();

    ListUtils.remove(scrollAreaHandle(), item);

}

/**

 * Removes all of the items from the receiver.

 * 

 * @exception 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 parent</li>

 *                </ul>

 * @exception IllegalArgumentException

 *                <ul>

 *                <li>ERROR_ITEM_NOT_REMOVED - if the operation fails

 *                because of an operating system failure</li>

 *                </ul>

 * 

 * @see SortedList#add(String)

 * @see SortedList#remove(String)

 * @see SortedList#setItems(String[])

 */

public void removeAll() {

    checkWidget();

    ListUtils.removeAll(scrollAreaHandle());

}

/**

 * Removes the listener from the collection of listeners who are notified

 * when the receiver's selection changes.

 * 

 * @param listener

 *            instance called when selection events occur

 * 

 * @exception IllegalArgumentException

 *                <ul>

 *                <li>ERROR_NULL_ARGUMENT - if the listener is null</li>

 *                </ul>

 * @exception 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 parent</li>

 *                </ul>

 * @exception SWTError

 *                <ul>

 *                <li>ERROR_ITEM_NOT_REMOVED - if the operation fails

 *                because of an operating system failure</li>

 *                </ul>

 * 

 * @see SortedList#addSelectionListener

 * @see SelectionListener

 */

public void removeSelectionListener(SelectionListener listener) {

    removeListener(SWT.Selection, listener);

    removeListener(SWT.DefaultSelection, listener);

}

/**

 * Selects the first item that has text matching the given string. If the

 * argument is <code>null</code>, the selection is cleared.

 * 

 * @param item

 *            text of item to select

 * 

 * @exception IllegalArgumentException

 *                <ul>

 *                <li>ERROR_INVALID_ARGUMENT - if the string is not found in

 *                the list</li>

 *                </ul>

 * @exception 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 parent</li>

 *                </ul>

 */

public void select(String item) {

    checkWidget();

    ignoreSelectionEvent = true;

    ListUtils.select(scrollAreaHandle(), item, (SWT.MULTI & getStyle()) != 0);

    ignoreSelectionEvent = false;

    filterList();

}

/**

 * Sets the receiver's items to be the given array of items.

 * 

 * @param items

 *            array of text strings to be shown in list

 * 

 * @exception IllegalArgumentException

 *                <ul>

 *                <li>ERROR_NULL_ARGUMENT - if the string array is null 

 *                </li>

 *                </ul>

 * @exception 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 parent</li>

 *                </ul>

 * @exception SWTError

 *                <ul>

 *                <li>ERROR_ITEM_NOT_ADDED - if the operation fails because

 *                of an operating system failure</li>

 *                </ul>