declare namespace java {
namespace awt {
/**
* The Choice
class presents a pop-up menu of choices.
* The current choice is displayed as the title of the menu.
*
* The following code example produces a pop-up menu: *
* Choice ColorChooser = new Choice(); * ColorChooser.add("Green"); * ColorChooser.add("Red"); * ColorChooser.add("Blue"); *
* After this choice menu has been added to a panel, * it appears as follows in its normal state: *
* *
* In the picture, "Green"
is the current choice.
* Pushing the mouse button down on the object causes a menu to
* appear with the current choice highlighted.
*
* Some native platforms do not support arbitrary resizing of
* Choice
components and the behavior of
* setSize()/getSize()
is bound by
* such limitations.
* Native GUI Choice
components' size are often bound by such
* attributes as font size and length of items contained within
* the Choice
.
*
* @author Sami Shaio * @author Arthur van Hoff * @since JDK1.0 */ // @ts-ignore class Choice extends java.awt.Component implements java.awt.ItemSelectable, javax.accessibility.Accessible { /** * Creates a new choice menu. The menu initially has no items in it. *
* By default, the first item added to the choice menu becomes the
* selected item, until a different selection is made by the user
* by calling one of the select
methods.
* @exception HeadlessException if GraphicsEnvironment.isHeadless()
* returns true
* @see java.awt.GraphicsEnvironment#isHeadless
* @see #select(int)
* @see #select(java.lang.String)
*/
// @ts-ignore
constructor()
/**
* Creates the Choice
's peer. This peer allows us
* to change the look
* of the Choice
without changing its functionality.
* @see java.awt.Toolkit#createChoice(java.awt.Choice)
* @see java.awt.Component#getToolkit()
*/
// @ts-ignore
public addNotify(): void
/**
* Returns the number of items in this Choice
menu.
* @return the number of items in this Choice
menu
* @see #getItem
* @since JDK1.1
*/
// @ts-ignore
public getItemCount(): number /*int*/
/**
* @deprecated As of JDK version 1.1,
* replaced by getItemCount()
.
*/
// @ts-ignore
public countItems(): number /*int*/
/**
* Gets the string at the specified index in this
* Choice
menu.
* @param index the index at which to begin
* @see #getItemCount
*/
// @ts-ignore
public getItem(index: number /*int*/): string
/**
* Adds an item to this Choice
menu.
* @param item the item to be added
* @exception NullPointerException if the item's value is
* null
* @since JDK1.1
*/
// @ts-ignore
public add(item: java.lang.String | string): void
/**
* Obsolete as of Java 2 platform v1.1. Please use the
* add
method instead.
*
* Adds an item to this Choice
menu.
* @param item the item to be added
* @exception NullPointerException if the item's value is equal to
* null
*/
// @ts-ignore
public addItem(item: java.lang.String | string): void
/**
* Inserts the item into this choice at the specified position.
* Existing items at an index greater than or equal to
* index
are shifted up by one to accommodate
* the new item. If index
is greater than or
* equal to the number of items in this choice,
* item
is added to the end of this choice.
*
* If the item is the first one being added to the choice,
* then the item becomes selected. Otherwise, if the
* selected item was one of the items shifted, the first
* item in the choice becomes the selected item. If the
* selected item was no among those shifted, it remains
* the selected item.
* @param item the non-null
item to be inserted
* @param index the position at which the item should be inserted
* @exception IllegalArgumentException if index is less than 0
*/
// @ts-ignore
public insert(item: java.lang.String | string, index: number /*int*/): void
/**
* Removes the first occurrence of item
* from the Choice
menu. If the item
* being removed is the currently selected item,
* then the first item in the choice becomes the
* selected item. Otherwise, the currently selected
* item remains selected (and the selected index is
* updated accordingly).
* @param item the item to remove from this Choice
menu
* @exception IllegalArgumentException if the item doesn't
* exist in the choice menu
* @since JDK1.1
*/
// @ts-ignore
public remove(item: java.lang.String | string): void
/**
* Removes an item from the choice menu
* at the specified position. If the item
* being removed is the currently selected item,
* then the first item in the choice becomes the
* selected item. Otherwise, the currently selected
* item remains selected (and the selected index is
* updated accordingly).
* @param position the position of the item
* @throws IndexOutOfBoundsException if the specified
* position is out of bounds
* @since JDK1.1
*/
// @ts-ignore
public remove(position: number /*int*/): void
/**
* Removes all items from the choice menu.
* @see #remove
* @since JDK1.1
*/
// @ts-ignore
public removeAll(): void
/**
* Gets a representation of the current choice as a string.
* @return a string representation of the currently
* selected item in this choice menu
* @see #getSelectedIndex
*/
// @ts-ignore
public getSelectedItem(): string
/**
* Returns an array (length 1) containing the currently selected
* item. If this choice has no items, returns null
.
* @see ItemSelectable
*/
// @ts-ignore
public getSelectedObjects(): any[]
/**
* Returns the index of the currently selected item.
* If nothing is selected, returns -1.
* @return the index of the currently selected item, or -1 if nothing
* is currently selected
* @see #getSelectedItem
*/
// @ts-ignore
public getSelectedIndex(): number /*int*/
/**
* Sets the selected item in this Choice
menu to be the
* item at the specified position.
*
Note that this method should be primarily used to
* initially select an item in this component.
* Programmatically calling this method will not trigger
* an ItemEvent
. The only way to trigger an
* ItemEvent
is by user interaction.
* @param pos the position of the selected item
* @exception IllegalArgumentException if the specified
* position is greater than the
* number of items or less than zero
* @see #getSelectedItem
* @see #getSelectedIndex
*/
// @ts-ignore
public select(pos: number /*int*/): void
/**
* Sets the selected item in this Choice
menu
* to be the item whose name is equal to the specified string.
* If more than one item matches (is equal to) the specified string,
* the one with the smallest index is selected.
*
Note that this method should be primarily used to
* initially select an item in this component.
* Programmatically calling this method will not trigger
* an ItemEvent
. The only way to trigger an
* ItemEvent
is by user interaction.
* @param str the specified string
* @see #getSelectedItem
* @see #getSelectedIndex
*/
// @ts-ignore
public select(str: java.lang.String | string): void
/**
* Adds the specified item listener to receive item events from
* this Choice
menu. Item events are sent in response
* to user input, but not in response to calls to select
.
* If l is null
, no exception is thrown and no action
* is performed.
*
Refer to AWT Threading Issues for details on AWT's threading model.
* @param l the item listener
* @see #removeItemListener
* @see #getItemListeners
* @see #select
* @see java.awt.event.ItemEvent
* @see java.awt.event.ItemListener
* @since JDK1.1
*/
// @ts-ignore
public addItemListener(l: java.awt.event.ItemListener): void
/**
* Removes the specified item listener so that it no longer receives
* item events from this Choice
menu.
* If l is null
, no exception is thrown and no
* action is performed.
*
Refer to AWT Threading Issues for details on AWT's threading model.
* @param l the item listener
* @see #addItemListener
* @see #getItemListeners
* @see java.awt.event.ItemEvent
* @see java.awt.event.ItemListener
* @since JDK1.1
*/
// @ts-ignore
public removeItemListener(l: java.awt.event.ItemListener): void
/**
* Returns an array of all the item listeners
* registered on this choice.
* @return all of this choice's ItemListener
s
* or an empty array if no item
* listeners are currently registered
* @see #addItemListener
* @see #removeItemListener
* @see java.awt.event.ItemEvent
* @see java.awt.event.ItemListener
* @since 1.4
*/
// @ts-ignore
public getItemListeners(): java.awt.event.ItemListener[]
/**
* Returns an array of all the objects currently registered
* as FooListener
s
* upon this Choice
.
* FooListener
s are registered using the
* addFooListener
method.
*
* You can specify the listenerType
argument
* with a class literal, such as
* FooListener.class
.
* For example, you can query a
* Choice
c
* for its item listeners with the following code:
*
ItemListener[] ils = (ItemListener[])(c.getListeners(ItemListener.class));* If no such listeners exist, this method returns an empty array. * @param listenerType the type of listeners requested; this parameter * should specify an interface that descends from *
java.util.EventListener
* @return an array of all objects registered as
* FooListener
s on this choice,
* or an empty array if no such
* listeners have been added
* @exception ClassCastException if listenerType
* doesn't specify a class or interface that implements
* java.util.EventListener
* @see #getItemListeners
* @since 1.3
*/
// @ts-ignore
public getListenersItemEvent
, it invokes the
* processItemEvent
method. Otherwise, it calls its
* superclass's processEvent
method.
* Note that if the event parameter is null
* the behavior is unspecified and may result in an
* exception.
* @param e the event
* @see java.awt.event.ItemEvent
* @see #processItemEvent
* @since JDK1.1
*/
// @ts-ignore
processEvent(e: java.awt.AWTEvent): void
/**
* Processes item events occurring on this Choice
* menu by dispatching them to any registered
* ItemListener
objects.
*
* This method is not called unless item events are * enabled for this component. Item events are enabled * when one of the following occurs: *
ItemListener
object is registered
* via addItemListener
.
* enableEvents
.
* Note that if the event parameter is null
* the behavior is unspecified and may result in an
* exception.
* @param e the item event
* @see java.awt.event.ItemEvent
* @see java.awt.event.ItemListener
* @see #addItemListener(ItemListener)
* @see java.awt.Component#enableEvents
* @since JDK1.1
*/
// @ts-ignore
processItemEvent(e: java.awt.event.ItemEvent): void
/**
* Returns a string representing the state of this Choice
* menu. This method is intended to be used only for debugging purposes,
* and the content and format of the returned string may vary between
* implementations. The returned string may be empty but may not be
* null
.
* @return the parameter string of this Choice
menu
*/
// @ts-ignore
paramString(): string
/**
* Gets the AccessibleContext
associated with this
* Choice
. For Choice
components,
* the AccessibleContext
takes the form of an
* AccessibleAWTChoice
. A new AccessibleAWTChoice
* instance is created if necessary.
* @return an AccessibleAWTChoice
that serves as the
* AccessibleContext
of this Choice
* @since 1.3
*/
// @ts-ignore
public getAccessibleContext(): javax.accessibility.AccessibleContext
}
}
}